MQTT Cover
The mqtt
cover platform allows you to control an MQTT cover (such as blinds, a rollershutter or a garage door).
Configuration
The device state (open
or closed
) will be updated only after a new message is published on state_topic
matching state_open
or state_closed
. If these messages are published with the retain
flag set, the cover will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be unknown
.
state_topic
can only manage state_open
and state_closed
. No percentage positions etc.
For this purpose is position_topic
which can set state of the cover and position.
Default setting are 0 means the device is closed
and all other intermediate positions means the device is open
.
position_topic
is managed by position_open
and position_closed
You can set it up in opossite way as well.
If position topic is defined than state topic is ignored.
If a state topic and position topic are not defined, the cover will work in optimistic mode. In this mode, the cover will immediately change state (open
or closed
) after every command sent by Home Assistant. If a state topic/position topic is defined, the cover will wait for a message on state_topic
or position_topic
.
Optimistic mode can be forced, even if a state_topic
/ position_topic
is defined. Try to enable it if experiencing incorrect cover operation (Google Assistant gauge may need optimistic mode as it often send request to your Home Assistant immediately after send set_cover_position in which case MQTT could be too slow).
The mqtt
cover platform optionally supports an availability_topic
to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e. publishes payload_not_available
to availability_topic
), Home Assistant will display the cover as “unavailable”. If these messages are published with the retain
flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the retain
flag is not set, Home Assistant will display the cover as “unavailable” when Home Assistant starts up.
To use your MQTT cover in your installation, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
cover:
- platform: mqtt
command_topic: "home-assistant/cover/set"
Configuration Variables
- command_topic
(string)(Optional)
The MQTT topic to publish commands to control the cover.
- name
-
(string)(Optional)
The name of the cover.
Default value:
MQTT Cover
- payload_open
-
(string)(Optional)
The command payload that opens the cover.
Default value:
OPEN
- payload_close
-
(string)(Optional)
The command payload that closes the cover.
Default value:
CLOSE
- payload_stop
-
(string)(Optional)
The command payload that stops the cover.
Default value:
STOP
- state_topic
(string)(Optional)
The MQTT topic subscribed to receive cover state messages. Use only if not using
position_topic
. State topic can only read open/close state. Cannot read position state. Ifposition_topic
is setstate_topic
is ignored.- state_open
-
(string)(Optional)
The payload that represents the open state.
Default value:
open
- state_closed
-
(string)(Optional)
The payload that represents the closed state.
Default value:
closed
- position_topic
(string)(Optional)
The MQTT topic subscribed to receive cover position messages. If
position_topic
is setstate_topic
is ignored.- position_open
-
(integer)(Optional)
Number which represents open position.
Default value:
100
- position_closed
-
(integer)(Optional)
Number which represents closed position.
Default value:
0
- availability_topic
(string)(Optional)
The MQTT topic subscribed to to receive birth and LWT messages from the MQTT cover device. If
availability_topic
is not defined, the cover availability state will always beavailable
. Ifavailability_topic
is defined, the cover availability state will beunavailable
by default.- payload_available
-
(string)(Optional)
The payload that represents the online state.
Default value:
online
- payload_not_available
-
(string)(Optional)
The payload that represents the offline state.
Default value:
offline
- optimistic
-
(string)(Optional)
Flag that defines if switch works in optimistic mode.
Default value:
true
if no state topic defined, elsefalse
. - qos
-
(integer)(Optional)
The maximum QoS level to be used when receiving and publishing messages.
Default value:
0
- retain
-
(boolean)(Optional)
Defines if published messages should have the retain flag set.
Default value:
false
- value_template
(string)(Optional)
Defines a template to extract a value from the payload.
- set_position_topic
(string)(Optional)
The MQTT topic to publish position commands to. You need to set position_topic as well if you want to use position topic. Use template if position topic wants different values than within range
position_closed
-position_open
. If template is not defined andposition_closed != 100
andposition_open != 0
then proper position value is calculated from percentage position.- set_position_template
(string)(Optional)
Defines a template to define the position to be sent to the
set_position_topic
topic. Incoming position value is available for use in the template ``. If no template is defined, the position (0-100) will be calculated according toposition_open
and `position_closed` values.- tilt_command_topic
(string)(Optional)
The MQTT topic to publish commands to control the cover tilt.
- tilt_status_topic
(string)(Optional)
The MQTT topic subscribed to receive tilt status update values.
- tilt_status_template
(string)(Optional)
Defines a template that can be used to extract the payload for the
tilt_status_topic
topic.- tilt_min
-
(integer)(Optional)
The minimum tilt value.
Default value:
0
- tilt_max
-
(integer)(Optional)
The maximum tilt value
Default value:
100
- tilt_closed_value
-
(integer)(Optional)
The value that will be sent on a
close_cover_tilt
command.Default value:
0
- tilt_opened_value
-
(integer)(Optional)
The value that will be sent on an
open_cover_tilt
command.Default value:
100
- tilt_optimistic
-
(boolean)(Optional)
Flag that determines if tilt works in optimistic mode.
Default value:
true
iftilt_status_topic
is not defined, elsefalse
- tilt_invert_state
-
(boolean)(Optional)
Flag that determines if open/close are flipped; higher values toward closed and lower values toward open.
Default value:
false
- device_class
(string)(Optional)
Sets the class of the device, changing the device state and icon that is displayed on the frontend.
- json_attributes_topic
(string)(Optional)
The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.
- json_attributes_template
(template)(Optional)
Defines a template to extract the JSON dictionary from messages received on the
json_attributes_topic
. Usage example can be found in MQTT sensor documentation.- unique_id
(string)(Optional)
An ID that uniquely identifies this cover. If two covers have the same unique ID, Home Assistant will raise an exception.
- device
(map)(Optional)
Information about the device this cover is a part of to tie it into the device registry. Only works through MQTT discovery and when
unique_id
is set.- identifiers
(list | string)(Optional)
A list of IDs that uniquely identify the device. For example a serial number.
- connections
(list)(Optional)
A list of connections of the device to the outside world as a list of tuples
[connection_type, connection_identifier]
. For example the MAC address of a network interface:"connections": ["mac", "02:5b:26:a8:dc:12"]
.- manufacturer
(string)(Optional)
The manufacturer of the device.
- model
(string)(Optional)
The model of the device.
- name
(string)(Optional)
The name of the device.
- sw_version
(string)(Optional)
The firmware version of the device.
Examples
In this section you will find some real-life examples of how to use this platform.
Full configuration state topic without tilt
The example below shows a full configuration for a cover without tilt with state topic only.
# Example configuration.yaml entry
cover:
- platform: mqtt
name: "MQTT Cover"
command_topic: "home-assistant/cover/set"
state_topic: "home-assistant/cover/state"
availability_topic: "home-assistant/cover/availability"
qos: 0
retain: true
payload_open: "OPEN"
payload_close: "CLOSE"
payload_stop: "STOP"
state_open: "open"
state_closed: "closed"
payload_available: "online"
payload_not_available: "offline"
optimistic: false
value_template: '{{ value.x }}'
Full configuration position topic without tilt
The example below shows a full configuration for a cover without tilt with position topic.
# Example configuration.yaml entry
cover:
- platform: mqtt
name: "MQTT Cover"
command_topic: "home-assistant/cover/set"
position_topic: "home-assistant/cover/position"
availability_topic: "home-assistant/cover/availability"
set_position_topic: "home-assistant/cover/set_position"
qos: 0
retain: true
payload_open: "OPEN"
payload_close: "CLOSE"
payload_stop: "STOP"
position_open: 100
position_closed: 0
payload_available: "online"
payload_not_available: "offline"
optimistic: false
value_template: '{{ value.x }}'
Full configuration
The example below shows a full configuration for a cover.
# Example configuration.yaml entry
cover:
- platform: mqtt
name: "MQTT Cover"
command_topic: "home-assistant/cover/set"
state_topic: "home-assistant/cover/state"
availability_topic: "home-assistant/cover/availability"
qos: 0
retain: true
payload_open: "OPEN"
payload_close: "CLOSE"
payload_stop: "STOP"
state_open: "open"
state_closed: "closed"
payload_available: "online"
payload_not_available: "offline"
optimistic: false
value_template: '{{ value.x }}'
tilt_command_topic: 'home-assistant/cover/tilt'
tilt_status_topic: 'home-assistant/cover/tilt-state'
tilt_status_template: '{{ value_json["PWM"]["PWM1"] }}'
tilt_min: 0
tilt_max: 180
tilt_closed_value: 70
tilt_opened_value: 180
To test, you can use the command line tool mosquitto_pub
shipped with mosquitto
or the mosquitto-clients
package to send MQTT messages. This allows you to operate your cover manually:
$ mosquitto_pub -h 127.0.0.1 -t home-assistant/cover/set -m "CLOSE"