openhab-addons/bundles/org.openhab.binding.publictransportswitzerland/README.md
Jerome Luckenbach 1ca9baf157
[Documentation] Markdown improvements n to s (#13948)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2022-12-14 16:52:43 +01:00

46 lines
1.7 KiB
Markdown

# Public Transport Switzerland Binding
Connects to the "Swiss public transport API" to provide real-time public transport information. [Link to the API](https://transport.opendata.ch/)
For example, here is a station board in HABPanel. (Download [here](https://github.com/StefanieJaeger/HABPanel-departure-board))
![Departure board in HABPanel](doc/departure_board_habpanel.png)
## Supported Things
### Stationboard
Upcoming departures for a single station. This is what you would usually see displayed at the train station.
#### Channels
| channel | type | description |
|----------------|--------|----------------------------------------------------------------------------------------------|
| departures#n | String | A dynamic channel for each upcoming departure |
| tsv (advanced) | String | A tsv which contains the fields:<br />`identifier, departureTime, destination, track, delay` |
#### UI based Configuration
`station` is the station name for which to display departures.
The name has to be one that is used by the swiss federal railways.
Please consult their [website](https://sbb.ch/en).
#### Textual configuration
##### Thing
```java
Thing publictransportswitzerland:stationboard:zurich [ station="Zürich HB" ]
```
##### Items
```java
String Next_Departure "Next Departure" { channel="publictransportswitzerland:stationboard:zurich:departures#1" }
String Upcoming_Departures_TSV "Upcoming_Departures_TSV" { channel="publictransportswitzerland:stationboard:zurich:tsv" }
```
## Discovery
This binding does not support auto-discovery.