From 4735114d5310ad4b473bb3f981b38b2e5052be26 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 9 Feb 2016 12:11:48 +0100 Subject: [PATCH] Update configuration example (fix #192) --- source/_components/rollershutter.mqtt.markdown | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/source/_components/rollershutter.mqtt.markdown b/source/_components/rollershutter.mqtt.markdown index 7ed69de4085..b9cbb7d925e 100644 --- a/source/_components/rollershutter.mqtt.markdown +++ b/source/_components/rollershutter.mqtt.markdown @@ -12,20 +12,22 @@ ha_category: Rollershutter --- -This platform enables the possibility to control an MQTT rollershutter. The device state will be updated only after receiving the a new state from `state_topic`. If these messages are published with RETAIN flag, the MQTT device will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state will be `unknown`. +The `mqtt` rollershutter platform enables the possibility to control an MQTT rollershutter. The device state will be updated only after receiving the a new state from `state_topic`. If these messages are published with RETAIN flag, the MQTT device will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state will be `unknown`. There is a state attribute that stores the relative position of the device, where 0% means the device is `closed` and all other intermediate positions means the device is `open`. +To enable this platform, add the following lines to your `configuration.yaml`: + ```yaml # Example configuration.yaml entry -motor: +rollershutter: platform: mqtt name: "Bedroom Rollershutter" state_topic: "home/bedroom/rollershutter" command_topic: "home/bedroom/rollershutter/set" qos: 0 - payload_open: "OPEN" - payload_close: "CLOSE" + payload_up: "OPEN" + payload_down: "CLOSE" payload_stop: "STOP" value_template: '{% raw %}{{ value.x }}{% endraw %}' ``` @@ -37,7 +39,7 @@ Configuration variables: - **name** (*Optional*): The name of the rollershutter. Default is 'MQTT Rollershutter'. - **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates. If not defined, the rollershutter will be stateless, that is, no information about current position or open/closed. If defined, the received payload must be a integer between 0 and 100, that represents the percentage for fully closed and fully open, respectively. - **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0. This QoS will also be used to publishing messages. -- **payload_open** (*Optional*): The payload to open the rollershutter. Default is "OPEN". -- **payload_close** (*Optional*): The payload to close the rollershutter. Default is "CLOSE". +- **payload_up** (*Optional*): The payload to open the rollershutter. Default is "OPEN". +- **payload_down** (*Optional*): The payload to close the rollershutter. Default is "CLOSE". - **payload_stop** (*Optional*): The payload to stop the rollershutter. Default is "STOP". - **value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract a value from the payload.