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-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Explicitly list available train attributes (#6139)

Browse Source 
* Explicitly list the available train attributes

* A bit more detail on train attributes
This commit is contained in:
smallship 2018-09-01 22:06:12 +01:00 committed by Fabian Affolter
parent b65b5c7341
commit 4dbdb4fb18
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
source/_components/sensor.uk_transport.markdown
View File

@ -46,7 +46,21 @@ Configuration variables:
- **origin** (*Required*): Specify the three character long origin station code. - **origin** (*Required*): Specify the three character long origin station code.
- **destination** (*Required*): Specify the three character long destination station code. - **destination** (*Required*): Specify the three character long destination station code.
A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID `sensor.next_train_to_wat` with the attribute `next_trains` which is a list of the next 25 departing trains. The status of the next departing train is accessed using the [template sensor](/components/sensor.template/) below, as are the train origin, estimated and scheduled departure times, and the departure platform. A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID `sensor.next_train_to_wat` with the attribute `next_trains` which is a list of the next 25 departing trains.
These attributes are available for each departing train:
- `origin_name`
- `destination_name`
- `status`
- `scheduled`: (API attribute is `aimed_departure_time`)
- `estimated`: (API attribute is `expected_departure_time`)
- `platform`
- `operator_name`
Refer to the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##request_uk_train_station_station_code_live_json) for definitions.
Attributes can be accessed using the [template sensor](/components/sensor.template/) as per this example:
```yaml ```yaml
# Example configuration.yaml entry for a template sensor to access the attributes of the next departing train. # Example configuration.yaml entry for a template sensor to access the attributes of the next departing train.