From 350cab5aa8a6e066088d3537cb5bc7baa34559f0 Mon Sep 17 00:00:00 2001
From: Allan Persson <46043392+allanpersson@users.noreply.github.com>
Date: Thu, 7 May 2020 08:25:51 +0200
Subject: [PATCH] Update documentation (#13317)
---
source/_integrations/rejseplanen.markdown | 93 +++++++++++++----------
1 file changed, 53 insertions(+), 40 deletions(-)
diff --git a/source/_integrations/rejseplanen.markdown b/source/_integrations/rejseplanen.markdown
index 7c41be042f9..8942066bb08 100644
--- a/source/_integrations/rejseplanen.markdown
+++ b/source/_integrations/rejseplanen.markdown
@@ -10,31 +10,6 @@ ha_domain: rejseplanen
The `rejseplanen` sensor will provide you with travel details for Danish public transport, using timetable data from [Rejseplanen](https://www.rejseplanen.dk/).
-## Setup
-
-The `stop_id` can be obtained through the following steps:
-
-If you know the exact name of the stop you can search the stop_id with the following URL [http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME](http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME) and put in the name of the stop instead of "STOP_NAME" in the end of the URL.
-
-If you don't know the name of the stop follow this guide:
-- Go to [https://www.openstreetmap.org](https://www.openstreetmap.org)
-- Make a search and fill in the location you want to find for.
-- The URL will look like this [https://www.openstreetmap.org/#map=18/56.15756/10.20674](https://www.openstreetmap.org/#map=18/56.15756/10.20674)
-- Now insert the coordinates for the location in the URL, in this example it will be: [http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&](http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&)
-- You will now see the 30 stops closest to your location.
-
-You will see an output like this:
-
-```text
-"StopLocation":[{
- "name":"Engdalsvej/Århusvej (Favrskov Kom)",
- "x":"10078598",
- "y":"56243456",
- "id":"713000702"
-```
-
-Find the name of your stop in the list and the "id" is the one you are looking for to us as value for `stop_id:`.
-
## Configuration
Add a sensor to your `configuration.yaml` file as shown in the example:
@@ -70,13 +45,46 @@ departure_type:
type: [string, list]
{% endconfiguration %}
+## stop_id
+
+The `stop_id` can be obtained through the following steps:
+
+- Go to [https://www.openstreetmap.org](https://www.openstreetmap.org)
+- Make a search and fill in the location you want to find for.
+- The URL will look like this [https://www.openstreetmap.org/#map=18/56.15756/10.20674](https://www.openstreetmap.org/#map=18/56.15756/10.20674)
+- Now insert the coordinates for the location in the URL, in this example it will be: [http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&](http://xmlopen.rejseplanen.dk/bin/rest.exe/stopsNearby?coordX=56.15756&coordY=10.20674&)
+- You will now see the 30 stops closest to your location.
+
+You will see an output like this:
+
+```text
+"StopLocation":[{
+ "name":"Engdalsvej/Århusvej (Favrskov Kom)",
+ "x":"10078598",
+ "y":"56243456",
+ "id":"713000702"
+```
+
+Find the name of your stop in the list and the "id" is the one you are looking for to us as value for `stop_id:`.
+
## Direction
If you use the `direction` filter it's important to put correct final destination(s) or else the sensor will not work at all.
The `direction` has to be the final destination(s) for the `Departure type` - ***NOT the stop where you want to get off***.
-- Check [https://rejseplanen.dk/](https://rejseplanen.dk/)
-- Make a search and use **all variations** for the final destination(s) for the needed `Departure type` in your configuration under `direction`. Make sure you use the exact name for final destination(s).
+- Replace YOUR_STOP_ID with the id for your stop and go to [http://xmlopen.rejseplanen.dk/bin/rest.exe/departureBoard?id=YOUR_STOP_ID](http://xmlopen.rejseplanen.dk/bin/rest.exe/departureBoard?id=YOUR_STOP_ID)
+- The values under `finalStop` is the ones you need to put under `direction`. Make sure you use the exact name and insert all possible finalstops.
+
+You will see an output like this:
+
+```text
+
+
+
+
+
+
+```
A working example on how to use this sensor with direction:
@@ -84,25 +92,30 @@ A working example on how to use this sensor with direction:
# Example configuration.yaml entry with the correct use of direction.
sensor:
- platform: rejseplanen
- stop_id: '008600615'
+ stop_id: '713000702'
direction:
- - 'CPH Lufthavn'
- - 'Helsingør St.'
+ - 'Bjergegårdsvej/Rylevej (Favrskov Kom)'
+ - 'Skanderborg Busterminal (Skanderborg Kom)'
```
-A NOT WORKING example use this sensor with direction:
+## Route
-```yaml
-# Example configuration.yaml entry with the correct use of direction.
-sensor:
- - platform: rejseplanen
- stop_id: '008600615'
- direction:
- - 'København H'
+If you use the `route` filter it's important to put correct route name(s) or else the sensor will not work at all.
+
+- Replace YOUR_STOP_ID with the id for your stop and go to [http://xmlopen.rejseplanen.dk/bin/rest.exe/departureBoard?id=YOUR_STOP_ID](http://xmlopen.rejseplanen.dk/bin/rest.exe/departureBoard?id=YOUR_STOP_ID)
+- The values under `Departure name` is the ones you need to put under `route`. Make sure you use the exact name.
+
+You will see an output like this:
+
+```text
+
+
+
+
+
+
```
-It fails because the final destination for the train from the departure station is NOT 'københavn H', but 'CPH Lufthavn' and 'Helsingør St.'.
-
## Examples
A more extensive example on how to use this sensor: