- Notifications
You must be signed in to change notification settings - Fork0
SimplySynced/ha-mlb
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This integration fetches data for a team's current/future games, and creates a sensor with attributes for the details of the game.
The integration is an updated version of theHA-NHL the which is based off the excellent pluginHA-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 .
The sensor is pretty simple: the main states arePRE,IN,POST orPOSTPONED, 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).
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 | PREINPOSTPOSTPONED |
first_pitch | Human-readable string for how far away the game is (eg. "in 30 minutes" or "tomorrow") | PREINPOSTPOSTPONED |
inning | The current quarter of gameplay | IN |
venue | The name of the stadium where the game is being played (eg. "Wells Fargo Center") | PREINPOSTPOSTPONED |
location | The city and state where the game is being played (eg. "Philadelphia, PA") | PREINPOSTPOSTPONED |
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. | PREINPOSTPOSTPONED |
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). | PREINPOSTPOSTPONED |
team_id | A numeric ID for your team, used to matchpossession above. | PREINPOSTPOSTPONED |
team_name | Your team's name (eg. "Flyers"). Note this does not include the city name. | PREINPOSTPOSTPONED |
team_record | Your team's current record (eg. "2-3"). | PREINPOSTPOSTPONED |
team_homeaway | Your team's home/away status. Eitherhome oraway. | PREINPOSTPOSTPONED |
team_logo | A URL for a 500px wide PNG logo for the team. | PREINPOSTPOSTPONED |
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. | PREINPOSTPOSTPONED |
team_score | Your team's score. An integer. | INPOST |
opponent_abbr | The abbreviation for your opponent (ie.PHI for the Flyers). | PREINPOSTPOSTPONED |
opponent_id | A numeric ID for your opponent, used to matchpossession above. | PREINPOSTPOSTPONED |
opponent_name | Your opponent's name (eg. "Seahawks"). Note this does not include the city name. | PREINPOSTPOSTPONED |
opponent_record | Your opponent's current record (eg. "2-3"). | PREINPOSTPOSTPONED |
opponent_homeaway | Your opponent's home/away status. Eitherhome oraway. | PREINPOSTPOSTPONED |
opponent_logo | A URL for a 500px wide PNG logo for the opponent. | PREINPOSTPOSTPONED |
opponent_colors | An array with two hex colors. The first is your opponent's primary color, and the second is their secondary color. | PREINPOSTPOSTPONED |
opponent_score | Your opponent's score. An integer. | INPOSTPOSTPONED |
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. | PREINPOSTPOSTPONED |
Clone or download this repository and copy the "mlb" directory to your "custom_components" directory in your config directory
<config directory>/custom_components/mlb/...
- 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"
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 athttps://www.espn.com/mlb/ in the top scores UI.
Look for the integration labeled "MLB" 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 besensor.mlb, otherwise it will besensor.friendly_name_you_picked.
To create a sensor instance add the following configuration to your sensor definitions using the team_id found above:
- platform: mlb team_id: 'PHI'After you restart Home Assistant then you should have a new sensor calledsensor.mlb in your system.
You can overide the sensor default name (sensor.mlb) to one of your choosing by setting thename option:
- platform: mlb team_id: 'PHI' name: PhilliesUsing the configuration example above the sensor will then be called "sensor.Phillies".