Update variables description

This commit is contained in:
Fabian Affolter 2015-09-10 07:26:42 +02:00
parent ba138f2df8
commit a9f17a2cc3

View File

@ -19,13 +19,15 @@ last known value. Otherwise, the initial state will be undefined.
# Example configuration.yml entry
sensor:
platform: mqtt
name: "MQTT Sensor"
state_topic: "home/bedroom/temperature"
name: "MQTT Sensor"
qos: 0
unit_of_measurement: "°C"
```
- **name**: The name of the sensor. Default is 'MQTT Sensor'. *Optional*
- **state_topic**: The MQTT topic subscribed to receive sensor values. *Required*
- **qos**: The maximum QoS level of the state topic. Default is 0. *Optional*
- **unit_of_measurement**: Defines the units of measurement of the sensor, if any. *Optional*
Configuration variables:
- **state_topic** (*Required*): The MQTT topic subscribed to receive sensor values.
- **name** (*Optional*): The name of the sensor. Default is 'MQTT Sensor'.
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0.
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.