Update configuration describtion style (#3991)

This commit is contained in:
Fabian Affolter 2017-11-15 23:35:22 +01:00 committed by GitHub
parent 7d2980bbe6
commit d40b9ff36f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 61 additions and 25 deletions

View file

@ -24,12 +24,27 @@ sensor:
- platform: random
```
Configuration variables:
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Random Sensor`.
- **minimum** (*Optional*): Lower limit for the values. Defaults to `0`.
- **maximum** (*Optional*): Upper limit for the values. Defaults to `20`.
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: Random Sensor
minimum:
description: Lower limit for the values.
required: false
type: string
default: 0
maximum:
description: Upper limit for the values.
required: false
type: int
default: 20
unit_of_measurement:
description: Defines the units of measurement of the sensor, if any.
required: false
type: string
{% endconfiguration %}
See the [entity component options][entity-docs] to control how often the main component polls the random sensor. The default is 30 seconds.