https://github.com/bcpearce/homeassistant-gtfs-realtime
Home Assistant Custom Integration for GTFS Realtime Data
https://github.com/bcpearce/homeassistant-gtfs-realtime
custom-component gtfs gtfs-realtime hacs home-assistant
Last synced: 4 months ago
JSON representation
Home Assistant Custom Integration for GTFS Realtime Data
- Host: GitHub
- URL: https://github.com/bcpearce/homeassistant-gtfs-realtime
- Owner: bcpearce
- License: mit
- Created: 2024-02-25T06:13:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-01T22:11:11.000Z (over 1 year ago)
- Last Synced: 2024-04-02T13:16:20.997Z (over 1 year ago)
- Topics: custom-component, gtfs, gtfs-realtime, hacs, home-assistant
- Language: Python
- Homepage:
- Size: 93.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GTFS Realtime for Home Assistant
## Installation
This integration can be installed manually or through [HACS](https://hacs.xyz/) as a custom repository.
#### HACS
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=bcpearce&repository=homeassistant-gtfs-realtime&category=Integration)
1. Go to HACS in your Home Assistant Integration
2. Select "Integrations"
3. Click the "..." in the upper left corner.
4. Go to Custom Repositories
5. Add this repository's URL https://github.com/bcpearce/homeassistant-gtfs-realtime in "Repository", and set the category to "Integration"
#### Manual
Copy files in [custom_components/gtfs_realtime](custom_components/gtfs_realtime/) to [/path/to/homeassistant/config/custom_components/gtfs_realtime](#).
## Configuration
Once the integration is installed, the configure the integration through Settings >> Devices and Services, and use "Add Integration". Select GTFS Realtime and follow the instructions in the user interface.
You can select a supported provider or configure it manually.
### Realtime Feed URLs
These are the URLs that will be queried for realtime updates. Using a preconfigured provider may include feeds you do not need, these can be deleted here to improve performance.
### Static Feed URLs
Less frequently updated data will be provided as one or more .zip files. Include the URL your provider supplies these files at. It will be updated daily.
### API Key
If your provider requires an API Key, it can be included as a header field for HTTP requests. It should be given in the format expected by your provider.
### Route Icons
Optionally route icons can be included. The integration will default to using MDI icons otherwise. For NYC Subway integrations, and other supported integrations, the resources folder may contain valid route icons to use.
For custom use, a URL must be provided that includes up to three Python format braces for `{route_id}`, `{route_color}` and `{route_text_color}`. At minimum, `{route_id}` must be provided. These braces should be placed in the input string and conform to the requirements in Python'a [str.format()](https://docs.python.org/3/library/stdtypes.html#str.format) method.
#### Resources
The [resources/NYCT_Bullets](resources/NYCT_Bullets/) folder contains ready-to-use SVG files for customizing arrival icons for the New York City Subway, provided by Wikimedia Commons.
### Other Transit Systems
This software may work for other GTFS realtime providers, but has not been tested. There is no guarantee that providers--even if included in this repository--will work--or that changes in provider APIs will not cause breakages.
## Frontend
Example frontend card configs can be found in [example/frontend.yaml](example/frontend.yaml).
## Sensors
### Arrival Sensor
The number of sensors can be specified during setup. By default this is 4.
Sensors will indicate the 1st, 2nd, 3rd, ... etc. arrivals for a given `stop_id` ordered by shortest time. If no scheduled trips exist for a given arrival ordinal, it will take on the state "Unknown". That is to say, the first sensor will always have the shortest time to arrival, the second sensor will have the second shortest time to arrival, and so on.
Raw sensor data is provided in seconds. Minutes are the recommended unit.
### Alert Sensor
Alert sensors can be setup for a `route_id`. The [example/frontend.yaml](example/frontend.yaml) file shows how to set up conditional cards that display only if an alert is active. The alert sensor will switch to the "Problem" state if an alert is active for a given station or route. This can be used in automations, such as turning on an indicator LED when an alert becomes active.
## Devices
Each stop will collect the arrival sensors together as a device. For each static data collection, a device is also included for managing the schedule updates.
## Services
Services are provided for updating and clearing the static data schedule. During setup, an interval for refreshing this data can be provided.
## GTFS Station Stop
This package utilizes [GTFS Station Stop](https://pypi.org/project/gtfs-station-stop/) to provide updates to Home Assistant sensors.
## Disclaimer
This software is not developed with or affiliated with Home Assistant or with any GTFS API provider. It is not guaranteed to work, use at your own risk.