diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index 903ac487224..b593f60ffc9 100644 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -13,7 +13,7 @@ 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 `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter or a garage door). ## {% linkable_title Configuration %} @@ -38,20 +38,19 @@ To use your MQTT cover in your installation, add the following to your `configur # Example configuration.yaml entry cover: - platform: mqtt - name: "MQTT Cover" command_topic: "home-assistant/cover/set" ``` {% configuration %} +command_topic: + description: The MQTT topic to publish commands to control the cover. + required: false + type: string 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 @@ -129,11 +128,11 @@ value_template: required: false type: string set_position_topic: - description: 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 and `position_closed != 100` and `position_open != 0` then proper position value is calculated from percentage position. + description: "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 and `position_closed != 100` and `position_open != 0` then proper position value is calculated from percentage position." 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 position (0-100) will be calculated according to `position_open` and `position_closed` values." + 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 position (0-100) will be calculated according to `position_open` and `position_closed` values." required: false type: string tilt_command_topic: @@ -179,7 +178,7 @@ unique_id: required: false type: string device: - description: 'Information about the device this cover is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' + description: "Information about the device this cover is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set." required: false type: map keys: @@ -188,23 +187,23 @@ device: required: false type: list, string connections: - description: '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"]]`.' + description: '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"]`.' required: false type: list manufacturer: - description: 'The manufacturer of the device.' + description: The manufacturer of the device. required: false type: string model: - description: 'The model of the device.' + description: The model of the device. required: false type: string name: - description: 'The name of the device.' + description: The name of the device. required: false type: string sw_version: - description: 'The firmware version of the device.' + description: The firmware version of the device. required: false type: string {% endconfiguration %} @@ -217,6 +216,7 @@ In this section you will find some real-life examples of how to use this platfor The example below shows a full configuration for a cover without tilt with state topic only. +{% raw %} ```yaml # Example configuration.yaml entry cover: @@ -235,13 +235,15 @@ cover: payload_available: "online" payload_not_available: "offline" optimistic: false - value_template: '{% raw %}{{ value.x }}{% endraw %}' + value_template: '{{ value.x }}' ``` +{% endraw %} ### {% linkable_title Full configuration position topic without tilt %} The example below shows a full configuration for a cover without tilt with position topic. +{% raw %} ```yaml # Example configuration.yaml entry cover: @@ -261,8 +263,9 @@ cover: payload_available: "online" payload_not_available: "offline" optimistic: false - value_template: '{% raw %}{{ value.x }}{% endraw %}' + value_template: '{{ value.x }}' ``` +{% endraw %} ### {% linkable_title Full configuration %}