Skip to content

Commit a2ba9f4

Browse files
fredrikbabergfabaff
authored andcommitted
Vasttrafik sensor configuration variable style (#6414)
* Style for configuration variables description Change to new style for configuration variables description (#6385). * Updated configuration example * Corrected from to be required variable. * Removed quote of decsription text. * Corrected incorrect linebreak. * Minor change * Change to list
1 parent 871aafa commit a2ba9f4

File tree

1 file changed

+40
-14
lines changed

1 file changed

+40
-14
lines changed

source/_components/sensor.vasttrafik.markdown

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,48 @@ Add the data to your `configuration.yaml` file as shown in the example:
2323
# Example configuration.yaml entry
2424
sensor:
2525
- platform: vasttrafik
26-
key: XXXXXXXXXXXXXXXXXXX
27-
secret: YYYYYYYYYYYYYYYYY
26+
key: YOUR_API_KEY
27+
secret: YOUR_API_SECRET
2828
departures:
2929
- from: Musikvägen
3030
```
3131
32-
Configuration variables:
33-
34-
- **key** (*Required*): The API key to access your Västtrafik account.
35-
- **secret** (*Required*): The API secret to access your Västtrafik account.
36-
- **departures** array (*Required*): List of travel routes.
37-
- **name** (*Optional*): Name of the route.
38-
- **from** (*Required*): The start station.
39-
- **heading** (*Optional*): Direction of the traveling.
40-
- **lines** (*Optional*): Only consider these lines.
41-
- **delay** (*Optional*): Delay in minutes. Defaults to 0.
32+
{% configuration %}
33+
key:
34+
description: The API key to access your Västtrafik account.
35+
required: true
36+
type: string
37+
secret:
38+
description: The API secret to access your Västtrafik account.
39+
required: true
40+
type: string
41+
departures:
42+
description: List of travel routes.
43+
required: true
44+
type: list
45+
keys:
46+
name:
47+
description: Name of the route.
48+
required: false
49+
type: string
50+
from:
51+
description: The start station.
52+
required: true
53+
type: string
54+
heading:
55+
description: Direction of the traveling.
56+
required: false
57+
type: string
58+
lines:
59+
description: Only consider these lines.
60+
required: false
61+
type: [list, string]
62+
delay:
63+
description: Delay in minutes.
64+
required: false
65+
type: string
66+
default: 0
67+
{% endconfiguration %}
4268
4369
The data are coming from [Västtrafik](https://vasttrafik.se/).
4470
@@ -48,8 +74,8 @@ A full configuration example could look like this:
4874
# Example configuration.yaml entry
4975
sensor:
5076
- platform: vasttrafik
51-
key: XXXXXXXXXXXXXXXXXXX
52-
secret: YYYYYYYYYYYYYYYYY
77+
key: YOUR_API_KEY
78+
secret: YOUR_API_SECRET
5379
departures:
5480
- name: Mot järntorget
5581
from: Musikvägen

0 commit comments

Comments
 (0)