mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-02 09:17:35 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
223 lines
8.0 KiB
Markdown
Executable File
223 lines
8.0 KiB
Markdown
Executable File
---
|
|
layout: page
|
|
title: "MQTT Cover"
|
|
description: "Instructions on how to integrate MQTT covers into Home Assistant."
|
|
date: 2016-09-28 17:30
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: mqtt.png
|
|
ha_category: Cover
|
|
ha_iot_class: "depends"
|
|
ha_release: 0.18
|
|
---
|
|
|
|
The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter, or a garage door).
|
|
|
|
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`.
|
|
|
|
There is an 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`.
|
|
|
|
If a state topic is 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 is defined, the cover will wait for a message on `state_topic` matching `state_open` or `state_closed` before changing state in Home Assistant.
|
|
|
|
Optimistic mode can be forced, even if a `state_topic` is defined. Try to enable it if experiencing incorrect cover operation.
|
|
|
|
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:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
cover:
|
|
- platform: mqtt
|
|
name: "MQTT Cover"
|
|
command_topic: "home-assistant/cover/set"
|
|
```
|
|
|
|
{% configuration %}
|
|
name:
|
|
description: The name of the cover.
|
|
required: false
|
|
type: string
|
|
default: MQTT Cover
|
|
command_topic:
|
|
description: The MQTT topic to publish commands to control the cover.
|
|
required: false
|
|
type: string
|
|
payload_open:
|
|
description: The command payload that opens the cover.
|
|
required: false
|
|
type: string
|
|
default: OPEN
|
|
payload_close:
|
|
description: The command payload that closes the cover.
|
|
required: false
|
|
type: string
|
|
default: CLOSE
|
|
payload_stop:
|
|
description: The command payload that stops the cover.
|
|
required: false
|
|
type: string
|
|
default: STOP
|
|
state_topic:
|
|
description: The MQTT topic subscribed to receive cover state messages.
|
|
required: false
|
|
type: string
|
|
state_open:
|
|
description: The payload that represents the open state.
|
|
required: false
|
|
type: string
|
|
default: open
|
|
state_closed:
|
|
description: The payload that represents the closed state.
|
|
required: false
|
|
type: string
|
|
default: closed
|
|
availability_topic:
|
|
description: "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 be `available`. If `availability_topic` is defined, the cover availability state will be `unavailable` by default."
|
|
required: false
|
|
type: string
|
|
payload_available:
|
|
description: The payload that represents the online state.
|
|
required: false
|
|
type: string
|
|
default: online
|
|
payload_not_available:
|
|
description: The payload that represents the offline state.
|
|
required: false
|
|
type: string
|
|
default: offline
|
|
optimistic:
|
|
description: Flag that defines if switch works in optimistic mode.
|
|
required: false
|
|
type: string
|
|
default: "`true` if no state topic defined, else `false`."
|
|
qos:
|
|
description: The maximum QoS level to be used when receiving and publishing messages.
|
|
required: false
|
|
type: integer
|
|
default: 0
|
|
retain:
|
|
description: Defines if published messages should have the retain flag set.
|
|
required: false
|
|
type: boolean
|
|
default: false
|
|
value_template:
|
|
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload."
|
|
required: false
|
|
type: string
|
|
set_position_topic:
|
|
description: The MQTT topic to publish position commands to.
|
|
required: false
|
|
type: string
|
|
set_position_template:
|
|
description: " Defines a [template](/topics/templating/) to define the position to be sent to the `set_position_topic` topic. Incoming position value is available for use in the template `{{position}}`. If no template is defined, the numeric position (0-100) will be written directly to the topic."
|
|
required: false
|
|
type: string
|
|
tilt_command_topic:
|
|
description: The MQTT topic to publish commands to control the cover tilt.
|
|
required: false
|
|
type: string
|
|
tilt_status_topic:
|
|
description: The MQTT topic subscribed to receive tilt status update values.
|
|
required: false
|
|
type: string
|
|
tilt_min:
|
|
description: The minimum tilt value.
|
|
required: false
|
|
type: integer
|
|
default: 0
|
|
tilt_max:
|
|
description: The maximum tilt value
|
|
required: false
|
|
type: integer
|
|
default: 100
|
|
tilt_closed_value:
|
|
description: The value that will be sent on a `close_cover_tilt` command.
|
|
required: false
|
|
type: integer
|
|
default: 0
|
|
tilt_opened_value:
|
|
description: The value that will be sent on an `open_cover_tilt` command.
|
|
required: false
|
|
type: integer
|
|
default: 0
|
|
tilt_status_optimistic:
|
|
description: Flag that determines if tilt works in optimistic mode.
|
|
required: false
|
|
type: boolean
|
|
default: "`true` if `tilt_status_topic` is not defined, else `false`"
|
|
tilt_invert_state:
|
|
description: Flag that determines if open/close are flipped; higher values toward closed and lower values toward open.
|
|
required: false
|
|
type: boolean
|
|
default: false
|
|
{% endconfiguration %}
|
|
|
|
## {% linkable_title Examples %}
|
|
|
|
In this section you will find some real life examples of how to use this platform.
|
|
|
|
### {% linkable_title Full configuration without tilt %}
|
|
|
|
The example below shows a full configuration for a cover without tilt.
|
|
|
|
```yaml
|
|
# Example configuration.yml 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: '{% raw %}{{ value.x }}{% endraw %}'
|
|
```
|
|
|
|
### {% linkable_title Full configuration %}
|
|
|
|
The example below shows a full configuration for a cover.
|
|
|
|
```yaml
|
|
# Example configuration.yml 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: '{% raw %}{{ value.x }}{% endraw %}'
|
|
tilt_command_topic: 'home-assistant/cover/tilt'
|
|
tilt_status_topic: 'home-assistant/cover/tilt-state'
|
|
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:
|
|
|
|
```bash
|
|
$ mosquitto_pub -h 127.0.0.1 -t home-assistant/cover/set -m "CLOSE"
|
|
```
|