home-assistant.io/source/_components/cover.mqtt.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release
page	MQTT Cover	Instructions how to integrate MQTT covers into Home Assistant.	2016-06-28 17:30	true	false	true	true	mqtt.png	Cover	0.18

The mqtt cover platform enables the possibility to control an MQTT cover. 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.

When a state topic is not available, the cover will work in optimistic mode. In this mode, the cover will immediately change state after every command. Otherwise, the cover will wait for state confirmation from device (message from state_topic).

Optimistic mode can be forced, even if state_topic is available. Try to enable it, if experiencing incorrect cover operation.

To use your MQTT cover in your installation, add the following to your configuration.yaml file:

# Example configuration.yml entry
cover:
  - platform: mqtt
    state_topic: "home-assistant/cover"
    command_topic: "home-assistant/cover/set"
    name: "MQTT Sensor"
    qos: 0
    retain: true
    payload_open: "PAYLOAD_OPEN"
    payload_close: "PAYLOD__CLOSE"
    payload_stop: "PAYLOAD_STOP"
    state_open: "STATE_OPEN"
    state_closed: "STATE_CLOSED"
    optimistic: false
    retain: false
    value_template: '{% raw %}{{ value.x }}{% endraw %}'

Configuration variables:

• state_topic (Required): The MQTT topic subscribed to receive sensor values.
• command_topic (Required): The MQTT topic to publish commands to control the rollershutter.
• name (Optional): The name of the sensor. Default is "MQTT Sensor".
• qos (Optional): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
• retain (Optional): If the published message should have the retain flag on or not.
• payload_open (Optional): The payload that opens the cover. Default is "UP"
• payload_close (Optional): The payload that closes the cover. Default is "DOWN"
• payload_stop (Optional): The payload that stops the rollershutter. default is "STOP"
• state_open (Optional): The payload that represents open state. Default is"STATE_OPEN"
• state_closed (Optional): The payload that represents closed state. Default is "STATE_CLOSED"
• optimistic (Optional): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.
• value_template (Optional): Defines a template to extract a value from the payload.

For a quick check you can use the commandline tools shipped with mosquitto to send MQTT messages. Set the state of your sensor manually:

$  mosquitto_pub -h 127.0.0.1 -t home-assistant/cover/set -m "OFF"