Skip to content

Update mvglive documentation #2386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 21, 2017
Merged

Update mvglive documentation #2386

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2453b5c
Update mvglive documentation
mountainsandcode Apr 5, 2017
1866337
Update sensor.mvglive.markdown
mountainsandcode Apr 6, 2017
f8a815d
Updated to correspond to code PR
mountainsandcode Apr 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 21 additions & 27 deletions source/_components/sensor.mvglive.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,45 +22,39 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry
sensor:
- platform: mvglive
station: STATION_OR_STOP
nextdeparture:
- station: STATION_OR_STOP_NAME
```

Configuration variables:

- **station** (*Required*): Name of the stop or station. Visit [the MVG live web site](http://www.mvg-live.de) to find valid names.
- **destination** (*Optional*): Name of the line's final destination to display only connections ending there.
- **line** (*Optional*): Online display connections from this line, e.g. `'U6'`, `'S2'`.
- **offset** (*Optional*): Do not display connections departing sooner than this number of minutes (defaults to 0). Useful if you are a couple of minutes away from the stop.
- **bus** (*Optional*): If 'False', do not display bus connections
- **tram** (*Optional*): If 'False', do not display tram connections
- **ubahn** (*Optional*): If 'False', do not display U-Bahn (subway) connections
- **sbahn** (*Optional*): If 'False', do not display S-Bahn (suburban train) connections

- **destinations** (*Optional*): One or multiple final stop names, e.g. 'Feldmoching' or ['Feldmoching','Harthof']. This can be used to only consider a particular direction of travel
- **directions** (*Optional*): Filter by direction of the departure. For Tram, Bus, SEV, and S-Bahn, direction = direction. For U-Bahn trains, directions are more general. For U1, U2, U3 and U6, direction='1' indicates south-bound trains, direction='2' indicates northbound trains. For U4 and U5, direction='1' indicates east-bound trains, direction='2' indicates west-bound trains. For example, setting directions: '1' can be used to get all south-bound trains at Scheidplatz.
- **lines** (*Optional*): One or more line numbers, e.g. 'U2' or ['U2','U8','N41']
- **products** (*Optional*): One or more modes of transport, defaults to all 4 modes ['U-Bahn', 'Tram', 'Bus', 'S-Bahn'].
- **timeoffset** (*Optional*): Do not display departures leaving sooner than this number of minutes (defaults to 0). Useful if you are a couple of minutes away from the stop.
- **name** (*Optional*): You can customise the name of the sensor, which defaults to the station name.
## {% linkable_title Examples %}

### {% linkable_title Full configuration %}

The example below shows a full configuration using the 'line' argument.

```yaml
# Example configuration.yml entry
sensor:
- platform: mvglive
station: Marienplatz
line: U6
offset: 5
destination: Garching-Forschungszentrum
```

Another example showing all bus connections at the main station.
The example below shows a full configuration with three sensors that showcase the various configuration options.

```yaml
# Example configuration.yml entry
sensor:
- platform: mvglive
station: Hauptbahnhof
offset: 2
sbahn: False
ubahn: False
tram: False
nextdeparture:
- station: Hauptbahnhof
name: Hbf
destinations: ['München Flughafen Terminal','Markt Schwaben']
products: 'S-Bahn'
timeoffset: 2
- station: Sendlinger Tor
lines: ['U2','U8']
- station: Scheidplatz
products: ['U-Bahn']
directions: '1'
```
The first sensor will return S-Bahn departures to Munich Airport or Markt Schwaben that are at least 2 minutes away. The second sensor returns U2 and U8 departures from Sendlinger Tor while the third sensor returns all south-bound U-Bahn trains from Scheidplatz.