NFL game data in Home Assistant

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

You can find examples of interesting automations in the wiki (please add your own examples!). There is also a great custom card that leverages this sensor, built by @D34DC3N73R.

The integration is a shameless fork of the excellent NWS alerts custom component by @finity69x2.Thank you for the starting place!

Sensor Data

State

The sensor is pretty simple: the main state is PRE, IN, POST, BYE or NOT_FOUND, 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. This happens on the first day of the game week, which seems to be Tuesday evenings around midnight Eastern time (once all the games through the Monday Night Football game are wrapped up).
IN: The game is in progress.
POST: The game has completed.
BYE: Your given team has a bye week this week. Note that attributes available are limited in this case (only abreviation, name, logo, and last updated time will be available).
NOT_FOUND: There is no game found for your team, nor is there a bye. This should only happen at the end of the season, and once your team is eliminated from postseason play.

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`
`kickoff_in`	Human-readable string for how far away the game is (eg. "in 30 minutes" or "tomorrow")	`PRE` `IN` `POST`
`quarter`	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. "Arrowhead Stadium")	`PRE` `IN` `POST`
`location`	The city and state where the game is being played (eg. "Pittsburgh, PA")	`PRE` `IN` `POST`
`tv_network`	The TV network where you can watch the game (eg. "NBC" or "NFL"). Note that if there is a national feed, it will be listed here, otherwise the local affiliate will be listed.	`PRE` `IN` `POST`
`odds`	The betting odds for the game (eg. "PIT -5.0")	`PRE`
`overunder`	The over/under betting line for the total points scored in the game (eg. "42.5").	`PRE`
`possession`	The ID of the team in possession of the ball. This will correlate to `team_id` or `opponent_id` below. Note that this value will be null in between posessions (after a score, etc).	`IN`
`last_play`	Sentence describing the most recent play, usually including the participants from both offense and defense, and the resulting yards. Note this can be null on posession changes or in between quarters.	`IN`
`down_distance_text`	String for the down and yards to go (eg. "2nd and 7").	`IN`
`team_abbr`	The abbreviation for your team (ie. `SEA` for the Seahawks).	`PRE` `IN` `POST` `BYE`
`team_id`	A numeric ID for your team, used to match `possession` above.	`PRE` `IN` `POST`
`team_name`	Your team's name (eg. "Seahawks"). Note this does not include the city name.	`PRE` `IN` `POST` `BYE`
`team_record`	Your team's current record (eg. "2-3").	`PRE` `IN` `POST`
`team_homeaway`	Your team's home/away status. Either `home` or `away`.	`PRE` `IN` `POST`
`team_logo`	A URL for a 500px wide PNG logo for the team.	`PRE` `IN` `POST` `BYE`
`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`
`team_score`	Your team's score. An integer.	`IN` `POST`
`team_win_probability`	The real-time chance your team has to win, according to ESPN. A percentage, but presented as a float. Note that this value can become null in between posession changes.	`IN`
`team_timeouts`	The number of remaining timeouts your team has.	`PRE` `IN` `POST`
`opponent_abbr`	The abbreviation for your opponent (ie. `SEA` for the Seahawks).	`PRE` `IN` `POST` `BYE`
`opponent_id`	A numeric ID for your opponent, used to match `possession` above.	`PRE` `IN` `POST`
`opponent_name`	Your opponent's name (eg. "Seahawks"). Note this does not include the city name.	`PRE` `IN` `POST` `BYE`
`opponent_record`	Your opponent's current record (eg. "2-3").	`PRE` `IN` `POST`
`opponent_homeaway`	Your opponent's home/away status. Either `home` or `away`.	`PRE` `IN` `POST`
`opponent_logo`	A URL for a 500px wide PNG logo for the opponent.	`PRE` `IN` `POST` `BYE`
`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`
`opponent_score`	Your opponent's score. An integer.	`IN` `POST`
`opponent_win_probability`	The real-time chance your opponent has to win, according to ESPN. A percentage, but presented as a float. Note that this value can become null in between posession changes.	`IN`
`opponent_timeouts`	The number of remaining timeouts your opponent has.	`PRE` `IN` `POST`
`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` `BYE`

Installation

Manually

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

<config directory>/custom_components/nfl/...

HACS

Open the HACS section of Home Assistant.
Click the "..." button in the top right corner and select "Custom Repositories."
In the window that opens paste this Github URL.
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. "SEA" for Seattle or "NE" for New England). You can find yours at https://espn.com/nfl in the top scores UI.

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

Look for the integration labeled "NFL" 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.nfl, 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: nfl
  team_id: 'SEA'

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

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

- platform: nfl
  team_id: 'SEA'
  name: Seahawks

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

zacs/ha-nfl