From 72136af3653284f4189c7a35fcd7391dffd94778 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Thu, 10 Sep 2015 07:27:11 +0200 Subject: [PATCH] Update variables description --- source/components/switch.mqtt.markdown | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/source/components/switch.mqtt.markdown b/source/components/switch.mqtt.markdown index 74d1a2e67d9..ac0ff005e97 100644 --- a/source/components/switch.mqtt.markdown +++ b/source/components/switch.mqtt.markdown @@ -37,14 +37,16 @@ switch: optimistic: false ``` -- **name**: The name of the switch. Default is 'MQTT Switch'. *Optional* -- **state_topic**: The MQTT topic subscribed to receive state updates. *Optional* -- **command_topic**: The MQTT topic to publish commands to change the switch state. *Required* -- **qos**: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. *Optional* -- **payload_on**: The payload that represents enabled state. Default is "ON". *Optional* -- **payload_off**: The payload that represents disabled state. Default is "OFF". *Optional* -- **optimistic**: Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false. *Optional* +Configuration variables: + +- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'. +- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates. +- **command_topic** (*Required*): The MQTT topic to publish commands to change the switch state. +- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. +- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON". +- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF". +- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.

Make sure that your topics match exact. some-topic/ and some-topic are different topics. -

\ No newline at end of file +