From 44adda5da9a24f75e7e165d99e09dc65f9325dd4 Mon Sep 17 00:00:00 2001 From: Jan Bouwhuis Date: Fri, 15 Dec 2023 12:27:43 +0100 Subject: [PATCH] Cleanup old anchors to point to new config style (#30358) --- source/_integrations/alarm_control_panel.mqtt.markdown | 2 -- source/_integrations/binary_sensor.mqtt.markdown | 1 - source/_integrations/button.mqtt.markdown | 2 -- source/_integrations/camera.mqtt.markdown | 2 -- source/_integrations/climate.mqtt.markdown | 2 -- source/_integrations/cover.mqtt.markdown | 2 -- source/_integrations/device_tracker.mqtt.markdown | 2 -- source/_integrations/event.mqtt.markdown | 2 -- source/_integrations/fan.mqtt.markdown | 2 -- source/_integrations/humidifier.mqtt.markdown | 2 -- source/_integrations/image.mqtt.markdown | 2 -- source/_integrations/light.mqtt.markdown | 2 -- source/_integrations/lock.mqtt.markdown | 2 -- source/_integrations/number.mqtt.markdown | 2 -- source/_integrations/scene.mqtt.markdown | 2 -- source/_integrations/select.mqtt.markdown | 2 -- source/_integrations/sensor.mqtt.markdown | 2 -- source/_integrations/siren.mqtt.markdown | 2 -- source/_integrations/switch.mqtt.markdown | 2 -- source/_integrations/water_heater.mqtt.markdown | 2 -- 20 files changed, 39 deletions(-) diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown index 2cf9458ed65..cffe3bfacaf 100644 --- a/source/_integrations/alarm_control_panel.mqtt.markdown +++ b/source/_integrations/alarm_control_panel.mqtt.markdown @@ -27,8 +27,6 @@ The integration can control your Alarm Panel by publishing to the `command_topic ## Configuration - - To enable this platform, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown index aa643240d20..6d2cde1fdda 100644 --- a/source/_integrations/binary_sensor.mqtt.markdown +++ b/source/_integrations/binary_sensor.mqtt.markdown @@ -20,7 +20,6 @@ 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. - To use an MQTT binary sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_integrations/button.mqtt.markdown b/source/_integrations/button.mqtt.markdown index 1821dafe2aa..b27e5a3d42e 100644 --- a/source/_integrations/button.mqtt.markdown +++ b/source/_integrations/button.mqtt.markdown @@ -12,8 +12,6 @@ The `mqtt` button platform lets you send an MQTT message when the button is pres ## Configuration - - ```yaml # Example configuration.yaml entry mqtt: diff --git a/source/_integrations/camera.mqtt.markdown b/source/_integrations/camera.mqtt.markdown index 9c398bd9dab..d958bd78791 100644 --- a/source/_integrations/camera.mqtt.markdown +++ b/source/_integrations/camera.mqtt.markdown @@ -14,8 +14,6 @@ This can be used with an application or a service capable of sending images thro ## Configuration - - To enable this camera in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 94d91a0d3f2..9bd168069ed 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -12,8 +12,6 @@ The `mqtt` climate platform lets you control your MQTT enabled HVAC devices. ## Configuration - - To enable this climate platform in your installation, first add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown index 7e9fe1ee95a..5a919d36ea2 100644 --- a/source/_integrations/cover.mqtt.markdown +++ b/source/_integrations/cover.mqtt.markdown @@ -27,8 +27,6 @@ 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. - - To use your MQTT cover in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/device_tracker.mqtt.markdown b/source/_integrations/device_tracker.mqtt.markdown index fbbd1a9fa48..ebb659809aa 100644 --- a/source/_integrations/device_tracker.mqtt.markdown +++ b/source/_integrations/device_tracker.mqtt.markdown @@ -13,8 +13,6 @@ The `mqtt` device tracker platform allows you to define new device_trackers thro ## Configuration - - To use this device tracker in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/event.mqtt.markdown b/source/_integrations/event.mqtt.markdown index 34c2b7b83fb..fdff707b11f 100644 --- a/source/_integrations/event.mqtt.markdown +++ b/source/_integrations/event.mqtt.markdown @@ -12,8 +12,6 @@ The `mqtt` event platform allows you to process event info from an MQTT message. ## Configuration - - ```yaml # Example configuration.yaml entry mqtt: diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index b36efe8dbb1..fed05d176b9 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -18,8 +18,6 @@ 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. - - To enable MQTT fans in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown index 2668ee0153f..e7b71d0b40e 100644 --- a/source/_integrations/humidifier.mqtt.markdown +++ b/source/_integrations/humidifier.mqtt.markdown @@ -18,8 +18,6 @@ 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. - - To enable MQTT humidifiers in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/image.mqtt.markdown b/source/_integrations/image.mqtt.markdown index 60ad2354458..4f9af9fafc8 100644 --- a/source/_integrations/image.mqtt.markdown +++ b/source/_integrations/image.mqtt.markdown @@ -18,8 +18,6 @@ An alternative setup is to use the `url_topic` option to receive an image URL fo ## Configuration - - To enable this image in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 774b013eb4d..1b68606524d 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -42,8 +42,6 @@ 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` - - ```yaml # Example configuration.yaml entry mqtt: diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index 2e513f451c5..03a9482798d 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -21,8 +21,6 @@ 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. An MQTT lock can also report the intermediate states `unlocking`, `locking` or `jammed` if the motor reports a jammed state. - - To enable MQTT locks in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown index 3e655404671..d49876b4daa 100644 --- a/source/_integrations/number.mqtt.markdown +++ b/source/_integrations/number.mqtt.markdown @@ -12,8 +12,6 @@ The `mqtt` Number platform allows you to integrate devices that might expose con ## Configuration - - To enable MQTT Number in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/scene.mqtt.markdown b/source/_integrations/scene.mqtt.markdown index ffc3c3bc503..bfbe7511bac 100644 --- a/source/_integrations/scene.mqtt.markdown +++ b/source/_integrations/scene.mqtt.markdown @@ -12,8 +12,6 @@ The `mqtt` scene platform lets you control your MQTT enabled scenes. ## Configuration - - To enable a MQTT scene in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/select.mqtt.markdown b/source/_integrations/select.mqtt.markdown index a65b42a1bf9..348fc90b29f 100644 --- a/source/_integrations/select.mqtt.markdown +++ b/source/_integrations/select.mqtt.markdown @@ -12,8 +12,6 @@ The `mqtt` Select platform allows you to integrate devices that might expose con ## Configuration - - To enable MQTT Select in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index 9c8d3222844..e6d6d9511f2 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -12,8 +12,6 @@ This `mqtt` sensor platform uses the MQTT message payload as the sensor value. I ## Configuration - - To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/siren.mqtt.markdown b/source/_integrations/siren.mqtt.markdown index 9524be4e68a..dc77a556057 100644 --- a/source/_integrations/siren.mqtt.markdown +++ b/source/_integrations/siren.mqtt.markdown @@ -18,8 +18,6 @@ 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. - - To enable this siren in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown index 77b7c13d181..66a11eace31 100644 --- a/source/_integrations/switch.mqtt.markdown +++ b/source/_integrations/switch.mqtt.markdown @@ -18,8 +18,6 @@ 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. - - To enable this switch in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/water_heater.mqtt.markdown b/source/_integrations/water_heater.mqtt.markdown index f22ec09bba5..75e5cb1779d 100644 --- a/source/_integrations/water_heater.mqtt.markdown +++ b/source/_integrations/water_heater.mqtt.markdown @@ -12,8 +12,6 @@ The `mqtt` water heater platform lets you control your MQTT enabled water heater ## Configuration - - To enable this water heater platform in your installation, first add the following to your `configuration.yaml` file: ```yaml