From a9f17a2cc3b02c6369bbc861d5f3cc5a52028226 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Thu, 10 Sep 2015 07:26:42 +0200 Subject: [PATCH] Update variables description --- source/components/sensor.mqtt.markdown | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/source/components/sensor.mqtt.markdown b/source/components/sensor.mqtt.markdown index ac7ca6596de..442d53b4044 100644 --- a/source/components/sensor.mqtt.markdown +++ b/source/components/sensor.mqtt.markdown @@ -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.