jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Irish rail transport sensor component configuration (#6947)

Browse Source
This commit is contained in:
Klaas Schoute 2018-10-19 19:57:49 +02:00 committed by Fabian Affolter
parent 1400fe2fae
commit b1bab7ce5f
1 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
source/_components/sensor.irish_rail_transport.markdown
View File

@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.57
---
The `irish_rail_transport` sensor will give you the time until the next two departures (within 90 minutes) from an Irish Rail station using the RTPI information.
A station name is the full station name as specified on the Irish Rail search site, for example, `Tara Street` or `Dublin Connolly`.
@ -28,13 +27,29 @@ sensor:
name: "To Greystones"
```
Configuration variables:
- **station** (*Required*): The name of the station.
- **direction** (*Optional*): The direction of the train. Typically either `Northbound` or `Southbound`.
- **destination** (*Optional*): The name of the destination station to filter by.
- **stops_at** (*Optional*): An optional filter based on the name of a station that the train stops at.
- **name** (*Optional*): A friendly name for this sensor.
{% configuration %}
station:
description: The name of the station.
required: true
type: string
direction:
description: The direction of the train. Typically either `Northbound` or `Southbound`.
required: false
type: string
destination:
description: The name of the destination station to filter by.
required: false
type: string
stops_at:
description: An optional filter based on the name of a station that the train stops at.
required: false
type: string
name:
description: A friendly name for this sensor.
required: false
default: Next Train
type: string
{% endconfiguration %}
Using the `stops_at` option will cause an extra request per train found. Therefore, if you are looking at a busy station, it is recommended that you also use at least one other filter. For example: