NHL game data in Home Assistant

This integration fetches data for an NHL team's current/future games, and creates a sensor with attributes for the details of the game.

The integration is an updated version of the excellent plugin HA-NFL custom component by @zacs. Thank you for the template! This code has been updated to be used with the same ESPN data source but for the NHL.

Sensor Data

State

The sensor is pretty simple: the main states are PRE, IN, POST or POSTPONED, but there are attributes for pretty much all aspects of the game, when available. State definitions are as you'd expect:

• PRE: The game is in pre-game state.
• IN: The game is in progress.
• POST: The game has completed.
• POSTPONED: Your given team has had the game scheduled postponed. Note that attributes available are limited in this case (only abreviation, name, logo, and last updated time will be available).

Attributes

The attributes available will change based on the sensor's state, a small number are always available (team abbreviation, team name, and logo), but otherwise the attributes only populate when in the current state. The table below lists which attributes are available in which states.

Name	Value	Relevant States
date	Date and time of the game	PRE IN POST POSTPONED
puck_drop	Human-readable string for how far away the game is (eg. "in 30 minutes" or "tomorrow")	PRE IN POST POSTPONED
period	The current quarter of gameplay	IN
clock	The clock value within the quarter (should never be higher than 15:00)	IN
venue	The name of the stadium where the game is being played (eg. "Wells Fargo Center")	PRE IN POST POSTPONED
location	The city and state where the game is being played (eg. "Philadelphia, PA")	PRE IN POST POSTPONED
tv_network	The TV network where you can watch the game (eg. "NBC" or "FOX"). Note that if there is a national feed, it will be listed here, otherwise the local affiliate will be listed.	PRE IN POST POSTPONED
odds	The betting odds for the game (eg. "PHI -5.0")	PRE
overunder	The over/under betting line for the total points scored in the game (eg. "3.2").	PRE
team_abbr	The abbreviation for your team (ie. PHI for the Flyers).	PRE IN POST POSTPONED
team_id	A numeric ID for your team, used to match possession above.	PRE IN POST POSTPONED
team_name	Your team's name (eg. "Flyers"). Note this does not include the city name.	PRE IN POST POSTPONED
team_record	Your team's current record (eg. "2-3").	PRE IN POST POSTPONED
team_homeaway	Your team's home/away status. Either home or away.	PRE IN POST POSTPONED
team_logo	A URL for a 500px wide PNG logo for the team.	PRE IN POST POSTPONED
team_colors	An array with two hex colors. The first is your team's primary color, and the second is their secondary color. Unless you're the Browns, in which case they are the same.	PRE IN POST POSTPONED
team_score	Your team's score. An integer.	IN POST
opponent_abbr	The abbreviation for your opponent (ie. PHI for the Flyers).	PRE IN POST POSTPONED
opponent_id	A numeric ID for your opponent, used to match possession above.	PRE IN POST POSTPONED
opponent_name	Your opponent's name (eg. "Seahawks"). Note this does not include the city name.	PRE IN POST POSTPONED
opponent_record	Your opponent's current record (eg. "2-3").	PRE IN POST POSTPONED
opponent_homeaway	Your opponent's home/away status. Either home or away.	PRE IN POST POSTPONED
opponent_logo	A URL for a 500px wide PNG logo for the opponent.	PRE IN POST POSTPONED
opponent_colors	An array with two hex colors. The first is your opponent's primary color, and the second is their secondary color.	PRE IN POST POSTPONED
opponent_score	Your opponent's score. An integer.	IN POST POSTPONED
last_update	A timestamp for the last time data was fetched for the game. If you watch this in real-time, you should notice it updating every 10 minutes, except for during the game (and for the ~20 minutes pre-game) when it updates every 5 seconds.	PRE IN POST POSTPONED

Installation

Manually

Clone or download this repository and copy the "nhl" directory to your "custom_components" directory in your config directory

<config directory>/custom_components/nhl/...

HACS

1. Open the HACS section of Home Assistant.
2. Click the "..." button in the top right corner and select "Custom Repositories."
3. In the window that opens paste this Github URL.
4. In the window that opens when you select it click om "Install This Repository in HACS"

Configuration

You'll need to know your team ID, which is a 2- or 3-letter acronym (eg. "PHI" for Philadelphia or "NJ" for New Jersey). You can find yours at https://www.espn.com/nhl/ in the top scores UI.

Via the "Configuration->Integrations" section of the Home Assistant UI

Look for the integration labeled "NHL" and enter your team's acronym in the UI prompt. You can also enter a friendly name. If you keep the default, your sensor will be sensor.nhl, otherwise it will be sensor.friendly_name_you_picked.

Manually in your configuration.yaml file

To create a sensor instance add the following configuration to your sensor definitions using the team_id found above:

- platform: nhl
  team_id: 'PHI'

After you restart Home Assistant then you should have a new sensor called sensor.nhl in your system.

You can overide the sensor default name (sensor.nhl) to one of your choosing by setting the name option:

- platform: nhl
  team_id: 'PHI'
  name: Flyers

Using the configuration example above the sensor will then be called "sensor.flyers".