Update mvglive documentation (home-assistant#2386)

mountainsandcode · balloob · commit c540046c7f78 · 2017-04-21T09:01:56.000-07:00
* Update mvglive documentation

* Update sensor.mvglive.markdown

* Updated to correspond to code PR
diff --git a/source/_components/sensor.mvglive.markdown b/source/_components/sensor.mvglive.markdown
@@ -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.
