Skip to content

Commit 96cef97

Browse files
authored
Merge pull request home-assistant#2526 from cribbstechnologies/next
Updating documentation for mqtt cover
2 parents 0607999 + b0768fc commit 96cef97

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

source/_components/cover.mqtt.markdown

100644100755
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,40 @@ Configuration variables:
4646
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is `0`. Will also be used when publishing messages.
4747
- **retain** (*Optional*): If the published message should have the retain flag on or not. Default is `false`.
4848
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
49+
- **tilt_command_topic** (*Optional*): The MQTT topic to publish commands to control the cover tilt.
50+
- **tilt_status_topic** (*Optional*): The MQTT topic subscribed to receive tilt status update values.
51+
- **tilt_min** (*Optional*): The minimum tilt value. Default is `0`
52+
- **tilt_max** (*Optional*): The maximum tilt value. Default is `100`
53+
- **tilt_closed_value** (*Optional*): The value that will be sent on a `close_cover_tilt` command. Default is `0`
54+
- **tilt_opened_value** (*Optional*): The value that will be sent on an `open_cover_tilt` command. Default is `100`
55+
- **tilt_status_optimistic** (*Optional*): Flag that determines if tilt works in optimistic mode. Default is `true` if `tilt_status_topic` is not deinfed, else `false`
4956

5057
## {% linkable_title Examples %}
5158

5259
In this section you find some real life examples of how to use this sensor.
5360

61+
### {% linkable_title Full configuration without tilt %}
62+
63+
The example below shows a full configuration for a cover without tilt.
64+
65+
```yaml
66+
# Example configuration.yml entry
67+
cover:
68+
- platform: mqtt
69+
state_topic: "home-assistant/cover"
70+
command_topic: "home-assistant/cover/set"
71+
name: "MQTT Cover"
72+
qos: 0
73+
retain: true
74+
payload_open: "OPEN"
75+
payload_close: "CLOSE"
76+
payload_stop: "STOP"
77+
state_open: "OPEN"
78+
state_closed: "STATE"
79+
optimistic: false
80+
value_template: '{% raw %}{{ value.x }}{% endraw %}'
81+
```
82+
5483
### {% linkable_title Full configuration %}
5584

5685
The example below shows a full configuration for a cover.
@@ -71,6 +100,12 @@ cover:
71100
state_closed: "STATE"
72101
optimistic: false
73102
value_template: '{% raw %}{{ value.x }}{% endraw %}'
103+
tilt_command_topic: 'home-assistant/cover/tilt'
104+
tilt_status_topic: 'home-assistant/cover/tilt-status'
105+
tilt_min: 0
106+
tilt_max: 180
107+
tilt_closed_value: 70
108+
tilt_opened_value: 180
74109
```
75110

76111
For a check you can use the command line tools `mosquitto_pub` shipped with `mosquitto` to send MQTT messages. This allows you to operate your cover manually:

0 commit comments

Comments
 (0)