mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
MQTT cover config to integration key (#22828)
This commit is contained in:
parent
512a074493
commit
e7189e6c56
@ -31,11 +31,30 @@ To use your MQTT cover in your installation, add the following to your `configur
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
mqtt:
|
||||||
|
cover:
|
||||||
|
- command_topic: "home-assistant/cover/set"
|
||||||
|
```
|
||||||
|
|
||||||
|
<a id='new_format'></a>
|
||||||
|
|
||||||
|
{% details "Previous configuration format" %}
|
||||||
|
|
||||||
|
The configuration format of manual configured MQTT items has changed.
|
||||||
|
The old format that places configurations under the `cover` platform key
|
||||||
|
should no longer be used and is deprecated.
|
||||||
|
|
||||||
|
The above example shows the new and modern way,
|
||||||
|
this is the previous/old example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- platform: mqtt
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
{% enddetails %}
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
availability:
|
availability:
|
||||||
description: "A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`."
|
description: "A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`."
|
||||||
@ -324,9 +343,9 @@ The example below shows a full configuration for a cover without tilt with state
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
mqtt:
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- name: "MQTT Cover"
|
||||||
name: "MQTT Cover"
|
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
availability:
|
availability:
|
||||||
@ -356,9 +375,9 @@ The example below shows a full configuration for a cover without tilt with posit
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
mqtt:
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- name: "MQTT Cover"
|
||||||
name: "MQTT Cover"
|
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
availability:
|
availability:
|
||||||
@ -387,9 +406,9 @@ The example below shows a full configuration for a cover with position, state &
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
mqtt:
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- name: "MQTT Cover"
|
||||||
name: "MQTT Cover"
|
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
@ -428,9 +447,9 @@ The example below shows a full configuration for a cover using stopped state.
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
mqtt:
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- name: "MQTT Cover"
|
||||||
name: "MQTT Cover"
|
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
@ -462,9 +481,9 @@ Setting `payload_close` empty or to `null` disables the close command and will n
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
mqtt:
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- payload_open: "on"
|
||||||
payload_open: "on"
|
|
||||||
payload_close:
|
payload_close:
|
||||||
payload_stop: "on"
|
payload_stop: "on"
|
||||||
```
|
```
|
||||||
@ -479,7 +498,6 @@ For auto discovery message the payload needs to be set to `null`, example for co
|
|||||||
{
|
{
|
||||||
"cover": [
|
"cover": [
|
||||||
{
|
{
|
||||||
"platform": "mqtt",
|
|
||||||
"payload_open": "on",
|
"payload_open": "on",
|
||||||
"payload_close": null,
|
"payload_close": null,
|
||||||
"payload_stop": "on"
|
"payload_stop": "on"
|
||||||
@ -498,9 +516,9 @@ The example below shows an example of how to correct the state of the blind depe
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
mqtt:
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- name: "MQTT Cover"
|
||||||
name: "MQTT Cover"
|
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
@ -542,9 +560,9 @@ Following variable might be used in `position_template`, `set_position_template`
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
mqtt:
|
||||||
cover:
|
cover:
|
||||||
- platform: mqtt
|
- name: "MQTT Cover"
|
||||||
name: "MQTT Cover"
|
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
|
Loading…
x
Reference in New Issue
Block a user