Document 'name' config parameter in rejseplanen (#10243)

* Document 'name' config parameter in rejseplanen

Document the undocumented but fully working name config. This is an optional config but essential to know to define more than one instance of the rejseplanen sensor and getting a predictable result. Otherwise the sensor name defaults to sensor.next_departure_# and the numbers can swap around after an HA restart

* An example where policy and common sense clash

Done as suggested though I do not agree

* ✏️ Tweak

* Adjust default

* Fix sample
This commit is contained in:
Kenneth Lavrsen 2019-08-27 18:46:39 +02:00 committed by Fabian Affolter
parent 45d0f0882a
commit cf2b028e69

View File

@ -53,6 +53,11 @@ stop_id:
description: The ID of the public transport stop.
required: true
type: string
name:
description: "The name of the sensor. Entity ID for the sensor will be created based on this name. E.g., Glostrup St becomes `sensor.glostrup_st`. It's optional but recommended if you define more than one sensor."
required: false
type: string
default: "Next departure"
route:
description: List of route names.
required: false
@ -105,6 +110,7 @@ A more extensive example on how to use this sensor:
# Example configuration.yaml entry
sensor:
- platform: rejseplanen
name: 'Elmegade 350S'
stop_id: '000045740'
route: 'Bus 350S'
direction: