-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4cf8663
commit d64b8f7
Showing
1 changed file
with
72 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,79 @@ | ||
| # HAFAS (HaCon Fahrplan-Auskunfts-System) client | ||
| # HAFAS (HaCon Fahrplan-Auskunfts-System) integration for Home Assistant | ||
|
|
||
| [](https://github.com/akloeckner/hacs-hafas/actions/workflows/hassfest.yaml) | ||
| [](https://github.com/akloeckner/hacs-hafas/actions/workflows/hacs.yaml) | ||
| [](https://github.com/akloeckner/hacs-hafas/compare/...master) | ||
|
|
||
| [](https://my.home-assistant.io/redirect/hacs_repository/?owner=akloeckner&repository=hacs-hafas) | ||
| [](https://my.home-assistant.io/redirect/integration/?domain=hafas) | ||
|
|
||
| A custom component for Home Assistant providing a client for the HAFAS API. | ||
| It can be used to retrieve connection data for a number of public transport companies in Europe. | ||
| It can be used to retrieve connection data for a number of public transport companies in Europe, most notably Deutsche Bahn. | ||
|
|
||
| Credit goes to [@kilimnik](https://github.com/kilimnik). | ||
|
|
||
| ## Sensor data | ||
|
|
||
| Once configured, this integration provides a sensor to show the next connections between two stations. | ||
|
|
||
| The `state` of the sensor is the `timestamp` of the next non-cancelled departure including delay. This allows to use the `state` programmatically, e.g., to compute a `timedelta` from it. Also, the sensor will be shown natively in Lovelace as a relative time, such as "in 5 minutes". | ||
|
|
||
| The `attributes` will contain the following additional data: | ||
| * `connections`: a list of all connections retrieved (see below) | ||
| * plus all information from the first non-canceled connection, except its list of `legs` | ||
|
|
||
| **Note**: The `connections` attribute is not recorded in history, because it contains a lot of data. | ||
| And we don't want to bloat your home assistant database. | ||
|
|
||
| Each entry in the `connections` list contains the following data: | ||
| * `origin`: name of origin station | ||
| * `departure`: timestamp of planned departure | ||
| * `delay`: timedelta of departure delay | ||
| * `destination`: name of destination station | ||
| * `arrival`: timestamp of planned arrival | ||
| * `delay_arrival`: timedelta of arrival delay | ||
| * `transfers`: number of legs minus one | ||
| * `duration`: timedelta from departure to arrival | ||
| * `canceled`: Boolean, `true` if any leg is canceled else `false` | ||
| * `ontime`: Boolean, `true` if zero departure delay else `false` | ||
| * `products`: comma-separated list of line names | ||
| * `legs`: list of legs with more detailed information | ||
|
|
||
| Each connection can consist of multiple legs (different trains with transfers in between). | ||
| A leg contains the following data: | ||
| * `origin`: name of origin station | ||
| * `departure`: timestamp of planned departure | ||
| * `platform`: departure platform | ||
| * `delay`: timedelta of departure delay | ||
| * `destination`: name of destination station | ||
| * `arrival`: timestamp of planned arrival | ||
| * `platform_arrival`: arrival platform | ||
| * `delay_arrival`: timedelta of arrival delay | ||
| * `mode`: transport mode such as `train` | ||
| * `name`: name of transport line such as `RE123` | ||
| * `canceled`: Boolean, if this leg is canceled | ||
| * `distance`: walking distance if any (only walking legs) | ||
| * `remarks`: list of strings | ||
| * `stopovers`: list of station names | ||
|
|
||
| ## Usage examples of attribute data in templates | ||
|
|
||
| Generate an output as in the old `db` integration, e.g., `11:11 + 11`: | ||
| ```python | ||
| {%- set departure = state_attr('sensor.koln_hbf_to_frankfurt_main_hbf', 'departure') | as_local %} | ||
| {%- set delay = state_attr('sensor.koln_hbf_to_frankfurt_main_hbf', 'delay') | as_timedelta %} | ||
| {{- departure.strftime('%H:%M') }} | ||
| {%- if delay -%} | ||
| {{- ' + ' ~ (delay.total_seconds() // 60) | int -}} | ||
| {%- endif -%} | ||
| ``` | ||
|
|
||
| Only retrieve the planned departure timestamps of all non-canceled connections: | ||
| ```python | ||
| {{ state_attr('sensor.koln_hbf_to_frankfurt_main_hbf', 'connections') | ||
| | rejectattr('canceled') | ||
| | map(attribute='departure') | ||
| | list }} | ||
| ``` | ||
|
|
||
|
|
||
| Credit goes to @kilimnik. This is just a proof of concept to use this component with HACS. |