Skip to content

Commit 090d7dd

Browse files
DavidMStraubfabaff
authored andcommitted
Documentation for new MVG sensor (home-assistant#2311)
* Add MVG logo * Add documentation for MVG sensor
1 parent 52f426b commit 090d7dd

File tree

2 files changed

+66
-0
lines changed

2 files changed

+66
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
layout: page
3+
title: "MVG"
4+
description: "Instructions how to integrate Munich public transport departure times into Home Assistant."
5+
date: 2017-03-21 20:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: mvg.png
11+
ha_category: Transport
12+
ha_release: 0.41
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
17+
The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes.
18+
19+
To enable this sensor, add the following lines to your `configuration.yaml` file:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
sensor:
24+
- platform: mvglive
25+
station: STATION_OR_STOP
26+
```
27+
28+
Configuration variables:
29+
30+
- **station** (*Required*): Name of the stop or station. Visit [the MVG live web site](http://www.mvg-live.de) to find valid names.
31+
- **destination** (*Optional*): Name of the line's final destination to display only connections ending there.
32+
- **line** (*Optional*): Online display connections from this line, e.g. `'U6'`, `'S2'`.
33+
- **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.
34+
- **bus** (*Optional*): If 'False', do not display bus connections
35+
- **tram** (*Optional*): If 'False', do not display tram connections
36+
- **ubahn** (*Optional*): If 'False', do not display U-Bahn (subway) connections
37+
- **sbahn** (*Optional*): If 'False', do not display S-Bahn (suburban train) connections
38+
39+
## {% linkable_title Examples %}
40+
41+
### {% linkable_title Full configuration %}
42+
43+
The example below shows a full configuration using the 'line' argument.
44+
45+
```yaml
46+
# Example configuration.yml entry
47+
sensor:
48+
- platform: mvglive
49+
station: Marienplatz
50+
line: U6
51+
offset: 5
52+
destination: Garching-Forschungszentrum
53+
```
54+
55+
Another example showing all bus connections at the main station.
56+
57+
```yaml
58+
# Example configuration.yml entry
59+
sensor:
60+
- platform: mvglive
61+
station: Hauptbahnhof
62+
offset: 2
63+
sbahn: False
64+
ubahn: False
65+
tram: False
66+
```
23.7 KB
Loading

0 commit comments

Comments
 (0)