mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 08:16:53 +00:00
Cleanup stale documentation for manual MQTT items using old format (#25416)
This commit is contained in:
Jan Bouwhuis
GitHub
parent
7256ce0f52
commit
55f31ac507
@ -27,6 +27,8 @@ The integration can control your Alarm Panel by publishing to the `command_topic
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable this platform, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
@ -37,26 +39,6 @@ mqtt:
|
||||
command_topic: "home/alarm/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 `alarm_control_panel` 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
|
||||
alarm_control_panel:
|
||||
- platform: mqtt
|
||||
state_topic: "home/alarm"
|
||||
command_topic: "home/alarm/set"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -20,6 +20,7 @@ Stateless devices such as buttons, remote controls etc are better represented by
|
||||
|
||||
The `mqtt` binary sensor platform optionally supports a list of `availability` topics to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT sensor device goes offline (i.e., publishes `payload_not_available` to an `availability` topic), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability` topic is defined, Home Assistant will consider the MQTT device to be `available` and will display its state.
|
||||
|
||||
<a id='new_format'></a>
|
||||
To use an MQTT binary sensor in your installation,
|
||||
add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -30,25 +31,6 @@ mqtt:
|
||||
- state_topic: "home-assistant/window/contact"
|
||||
```
|
||||
|
||||
<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 `binary_sensor` 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
|
||||
binary_sensor:
|
||||
- platform: mqtt
|
||||
state_topic: "home-assistant/window/contact"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -12,6 +12,8 @@ The `mqtt` button platform lets you send an MQTT message when the button is pres
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mqtt:
|
||||
@ -19,25 +21,6 @@ mqtt:
|
||||
- command_topic: "home/bedroom/switch1/reboot"
|
||||
```
|
||||
|
||||
<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 `button` 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
|
||||
button:
|
||||
- platform: mqtt
|
||||
command_topic: "home/bedroom/switch1/reboot"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -14,6 +14,8 @@ This can be used with an application or a service capable of sending images thro
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -23,25 +25,6 @@ mqtt:
|
||||
- topic: zanzito/shared_locations/my-device
|
||||
```
|
||||
|
||||
<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 `camera` 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
|
||||
camera:
|
||||
- platform: mqtt
|
||||
topic: zanzito/shared_locations/my-device
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
The sample configuration above can be tested by publishing an image to the topic from the console:
|
||||
|
||||
```shell
|
||||
|
||||
@ -12,6 +12,8 @@ The `mqtt` climate platform lets you control your MQTT enabled HVAC devices.
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable this climate platform in your installation, first add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -22,26 +24,6 @@ mqtt:
|
||||
mode_command_topic: "study/ac/mode/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 `climate` 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
|
||||
climate:
|
||||
- platform: mqtt
|
||||
name: Study
|
||||
mode_command_topic: "study/ac/mode/set"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
action_template:
|
||||
description: A template to render the value received on the `action_topic` with.
|
||||
|
||||
@ -27,6 +27,8 @@ Optimistic mode can be forced, even if a `state_topic` / `position_topic` is def
|
||||
|
||||
The `mqtt` cover platform optionally supports a list of `availability` topics 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 a matching `payload_not_available` to any `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.
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To use your MQTT cover in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -36,25 +38,6 @@ mqtt:
|
||||
- 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:
|
||||
- platform: mqtt
|
||||
command_topic: "home-assistant/cover/set"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: "A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`."
|
||||
|
||||
@ -11,12 +11,10 @@ ha_domain: mqtt
|
||||
|
||||
The `mqtt` device tracker platform allows you to define new device_trackers through [manual YAML configuration](#yaml-configuration) in `configuration.yaml` and also to automatically discover device_trackers [using the MQTT Discovery protocol](#using-the-discovery-protocol).
|
||||
|
||||
<div class='note info'>
|
||||
At the moment, manual configured device trackers can only reloaded by restarting Home Assistant.
|
||||
</div>
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -29,60 +27,6 @@ mqtt:
|
||||
state_topic: "location/paulus"
|
||||
```
|
||||
|
||||
{% details "Previous configuration format" %}
|
||||
|
||||
The configuration format of manual configured MQTT items has changed.
|
||||
The old format that places configurations under the `switch` 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 and deprecated configuration schema:
|
||||
|
||||
```yaml
|
||||
device_tracker:
|
||||
- platform: mqtt
|
||||
devices:
|
||||
paulus_oneplus: "location/paulus"
|
||||
annetherese_n4: "location/annetherese"
|
||||
```
|
||||
|
||||
To set the state of the device_tracker then you need to publish a JSON message to the topic (e.g., via mqtt.publish service). As an example, the following JSON message would set the `paulus_oneplus` device_tracker to `home`:
|
||||
|
||||
```json
|
||||
{
|
||||
"topic": "location/paulus",
|
||||
"payload": "home"
|
||||
}
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
devices:
|
||||
description: List of devices with their topic.
|
||||
required: true
|
||||
type: list
|
||||
qos:
|
||||
description: The QoS level of the topic.
|
||||
required: false
|
||||
type: integer
|
||||
payload_home:
|
||||
description: The payload value that represents the 'home' state for the device.
|
||||
required: false
|
||||
type: string
|
||||
default: "home"
|
||||
payload_not_home:
|
||||
description: The payload value that represents the 'not_home' state for the device.
|
||||
required: false
|
||||
type: string
|
||||
default: "not_home"
|
||||
source_type:
|
||||
description: Attribute of a device tracker that affects state when being used to track a [person](/integrations/person/). Valid options are `gps`, `router`, `bluetooth`, or `bluetooth_le`.
|
||||
required: false
|
||||
type: string
|
||||
default: gps
|
||||
{% endconfiguration %}
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -18,6 +18,8 @@ When a `state_topic` is not available, the fan will work in optimistic mode. In
|
||||
|
||||
Optimistic mode can be forced even if a `state_topic` is available. Try to enable it if you are experiencing incorrect fan operation.
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable MQTT fans in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -27,25 +29,6 @@ mqtt:
|
||||
- command_topic: "bedroom_fan/on/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 `fan` 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
|
||||
fan:
|
||||
- platform: "mqtt"
|
||||
command_topic: "bedroom_fan/on/set"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -18,6 +18,8 @@ When a `state_topic` is not available, the humidifier will work in optimistic mo
|
||||
|
||||
Optimistic mode can be forced even if a `state_topic` is available. Try to enable it if you are experiencing incorrect humidifier operation.
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable MQTT humidifiers in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -28,26 +30,6 @@ mqtt:
|
||||
target_humidity_command_topic: "bedroom_humidifier/humidity/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 `light` 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
|
||||
humidifier:
|
||||
- platform: mqtt
|
||||
command_topic: "bedroom_humidifier/on/set"
|
||||
target_humidity_command_topic: "bedroom_humidifier/humidity/set"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -42,6 +42,8 @@ Optimistic mode can be forced, even if the `state_topic` is available. Try to en
|
||||
Home Assistant internally assumes that a light's state corresponds to a defined `color_mode`.
|
||||
The state of MQTT lights with default schema and support for both color and color temperature will set the `color_mode` according to the last received valid color or color temperature. Optionally, a `color_mode_state_topic` can be configured for explicit control of the `color_mode`
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mqtt:
|
||||
@ -49,25 +51,6 @@ mqtt:
|
||||
- command_topic: "office/rgb1/light/switch"
|
||||
```
|
||||
|
||||
<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 `light` 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
|
||||
light:
|
||||
- platform: "mqtt"
|
||||
command_topic: "office/rgb1/light/switch"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
@ -525,10 +508,6 @@ When a state topic is not available, the light will work in optimistic mode. In
|
||||
|
||||
Optimistic mode can be forced, even if state topic is available. Try enabling it if the light is operating incorrectly.
|
||||
|
||||
<div class='note warning'>
|
||||
The way manual MQTT Fans are configured has changed. Placing configurations under the `fan` platform key is deprecated.
|
||||
</div>
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mqtt:
|
||||
|
||||
@ -20,6 +20,8 @@ Optimistic mode can be forced, even if state topic is available. Try to enable i
|
||||
|
||||
It's mandatory for locks to support `lock` and `unlock`. A lock may optionally support `open`, (e.g. to open the bolt in addition to the latch), in this case, `payload_open` is required in the configuration. If the lock is in optimistic mode, it will change states to `unlocked` when handling the `open` command.
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable MQTT locks in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -29,25 +31,6 @@ mqtt:
|
||||
- command_topic: "home/frontdoor/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 `lock` 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
|
||||
lock:
|
||||
- platform: mqtt
|
||||
command_topic: "home/frontdoor/set"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -12,6 +12,8 @@ The `mqtt` Number platform allows you to integrate devices that might expose con
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable MQTT Number in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -20,24 +22,6 @@ mqtt:
|
||||
number:
|
||||
- command_topic: my-device/threshold
|
||||
```
|
||||
<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 `number` 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
|
||||
number:
|
||||
- platform: mqtt
|
||||
command_topic: my-device/threshold
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
|
||||
@ -12,6 +12,8 @@ The `mqtt` scene platform lets you control your MQTT enabled scenes.
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable a MQTT scene in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -21,25 +23,6 @@ mqtt:
|
||||
- command_topic: zigbee2mqtt/living_room_group/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 `scene` 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
|
||||
scene:
|
||||
- platform: mqtt
|
||||
command_topic: zigbee2mqtt/living_room_group/set
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -12,6 +12,8 @@ The `mqtt` Select platform allows you to integrate devices that might expose con
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable MQTT Select in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -25,29 +27,6 @@ mqtt:
|
||||
- "Option 2"
|
||||
```
|
||||
|
||||
<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 `select` 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
|
||||
select:
|
||||
- platform: mqtt
|
||||
command_topic: topic
|
||||
name: "Test Select"
|
||||
options:
|
||||
- "Option 1"
|
||||
- "Option 2"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -12,6 +12,8 @@ This `mqtt` sensor platform uses the MQTT message payload as the sensor value. I
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -21,25 +23,6 @@ mqtt:
|
||||
- state_topic: "home/bedroom/temperature"
|
||||
```
|
||||
|
||||
<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 `sensor` 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
|
||||
sensor:
|
||||
- platform: mqtt
|
||||
state_topic: "home/bedroom/temperature"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -18,6 +18,8 @@ When a `state_topic` is not available, the siren will work in optimistic mode. I
|
||||
|
||||
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect operation.
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable this siren in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -26,24 +28,6 @@ mqtt:
|
||||
siren:
|
||||
- command_topic: "home/bedroom/siren/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 `siren` 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
|
||||
siren:
|
||||
- platform: mqtt
|
||||
command_topic: "home/bedroom/siren/set"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
|
||||
@ -18,6 +18,8 @@ When a `state_topic` is not available, the switch will work in optimistic mode.
|
||||
|
||||
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect switch operation.
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable this switch in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -27,25 +29,6 @@ mqtt:
|
||||
- command_topic: "home/bedroom/switch1/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 `switch` 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
|
||||
switch:
|
||||
- platform: mqtt
|
||||
command_topic: "home/bedroom/switch1/set"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% configuration %}
|
||||
availability:
|
||||
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
|
||||
|
||||
@ -17,6 +17,8 @@ This documentation has 3 sections. Configuration for `legacy` vacuum with exampl
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To add your MQTT vacuum to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -26,25 +28,6 @@ mqtt:
|
||||
- command_topic: "vacuum/command"
|
||||
```
|
||||
|
||||
<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 `vacuum` 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
|
||||
vacuum:
|
||||
- platform: mqtt
|
||||
command_topic: "vacuum/command"
|
||||
```
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
## Legacy Configuration
|
||||
|
||||
Legacy MQTT vacuum configuration section.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user