diff --git a/source/_components/alarm_control_panel.manual_mqtt.markdown b/source/_components/alarm_control_panel.manual_mqtt.markdown index 751a5e77c59..ca6b592aa67 100644 --- a/source/_components/alarm_control_panel.manual_mqtt.markdown +++ b/source/_components/alarm_control_panel.manual_mqtt.markdown @@ -12,7 +12,7 @@ ha_category: Alarm ha_release: "0.50" --- -This platform extends the [manual alarm](/components/alarm_control_panel.manual/) by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant. +The `mqtt` platform extends the [manual alarm](/components/alarm_control_panel.manual/) by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant. It's essentially the opposite of the [MQTT Alarm Panel](/components/alarm_control_panel.mqtt/) which allows Home Assistant to observe an existing, fully-featured alarm where all of the alarm logic is embedded in that physical device. @@ -91,15 +91,15 @@ armed_home/armed_away/armed_night/disarmed/triggered: type: list keys: delay_time: - description: State specific setting for **delay_time** (all states except **triggered**) + description: State specific setting for **delay_time** (all states except **triggered**). required: false type: integer pending_time: - description: State specific setting for **pending_time** (all states except **disarmed**) + description: State specific setting for **pending_time** (all states except **disarmed**). required: false type: integer trigger_time: - description: State specific setting for **trigger_time** (all states except **triggered**) + description: State specific setting for **trigger_time** (all states except **triggered**). required: false type: integer {% endconfiguration %} @@ -110,11 +110,11 @@ Additionally, the following MQTT configuration variables are also available. {% configuration %} state_topic: - description: The MQTT topic HA will publish state updates to. + description: The MQTT topic Home Assistant will publish state updates to. required: true type: string command_topic: - description: The MQTT topic HA will subscribe to, to receive commands from a remote device to change the alarm state. + description: The MQTT topic Home Assistant will subscribe to, to receive commands from a remote device to change the alarm state. required: true type: string qos: @@ -148,9 +148,9 @@ payload_arm_night: In the configuration example below: -- The disarmed state never triggers the alarm; -- The armed_home state will leave no time to leave the building or disarm the alarm; -- While other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back; +- The disarmed state never triggers the alarm +- The armed_home state will leave no time to leave the building or disarm the alarm +- While other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back - Setting pending_time to 0 for triggered state allows the alarm to trigger after previous state's delay time only. If not set, the alarm will be pending for previous state's delay_time plus the default pending_time before triggering. ```yaml diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index 177e89f8924..1f79e16cc7c 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -30,17 +30,15 @@ camera: {% configuration %} topic: - description: MQTT topic to subscribe to. + description: The MQTT topic to subscribe to. required: true type: string name: - description: Name of the camera. + description: The name of the camera. required: false type: string unique_id: - description: > - An ID that uniquely identifies this camera. If two cameras - have the same unique ID Home Assistant will raise an exception. + description: An ID that uniquely identifies this camera. If two cameras have the same unique ID Home Assistant will raise an exception. required: false type: string {% endconfiguration %} diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown index 2a726f19e46..13f79898ce0 100644 --- a/source/_components/fan.mqtt.markdown +++ b/source/_components/fan.mqtt.markdown @@ -33,15 +33,15 @@ fan: ``` {% configuration %} +command_topic: + description: The MQTT topic to publish commands to change the fan state. + required: true + type: string name: description: The name of the fan. required: false type: string default: MQTT Fan -command_topic: - description: The MQTT topic to publish commands to change the fan state. - required: true - type: string state_topic: description: The MQTT topic subscribed to receive state updates. required: false @@ -125,7 +125,7 @@ speed_value_template: required: false type: string speeds: - description: "List of speeds this fan is capable of running at. Valid entries are `off`, `low`, `medium`, and `high`." + description: "List of speeds this fan is capable of running at. Valid entries are `off`, `low`, `medium` and `high`." required: false type: string list availability_topic: @@ -147,12 +147,12 @@ unique_id: required: false type: string device: - description: 'Information about the device this fan 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 fan 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: identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' + description: A list of IDs that uniquely identify the device. For example a serial number. required: false type: list, string connections: @@ -160,19 +160,19 @@ device: required: false type: list, tuple 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 %} diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index 7009e9224e9..47238132ab4 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -15,6 +15,8 @@ ha_iot_class: depends The `mqtt` lock platform lets you control your MQTT enabled locks. +## {% linkable_title Configuration %} + In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the lock will be `false` / unlocked. When a `state_topic` is not available, the lock will work in optimistic mode. In this mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from the device (message from `state_topic`). @@ -31,11 +33,6 @@ lock: ``` {% configuration %} -name: - description: The name of the lock. - required: false - type: string - default: MQTT Lock command_topic: description: The MQTT topic to publish commands to change the lock state. required: true @@ -44,6 +41,11 @@ state_topic: description: The MQTT topic subscribed to receive state updates. required: false type: string +name: + description: The name of the lock. + required: false + type: string + default: MQTT Lock payload_lock: description: The payload that represents enabled/locked state. required: false diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index f29e5299776..339908943fb 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -92,12 +92,12 @@ device_class: type: device_class default: None device: - description: 'Information about the device this sensor 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 sensor 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: identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' + description: A list of IDs that uniquely identify the device. For example a serial number. required: false type: list, string connections: @@ -105,19 +105,19 @@ device: 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 %} diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index b5f978a0adf..283ec133758 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -33,6 +33,10 @@ switch: ``` {% configuration %} +command_topic: + description: The MQTT topic to publish commands to change the switch state. + required: false + type: string name: description: The name to use when displaying this switch. required: false @@ -56,10 +60,6 @@ state_off: required: false type: string default: "OFF" -command_topic: - description: The MQTT topic to publish commands to change the switch state. - required: false - type: string availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false @@ -104,12 +104,12 @@ value_template: required: false type: string device: - description: 'Information about the device this switch 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 switch 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: identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' + description: A list of IDs that uniquely identify the device. For example a serial number. required: false type: list, string connections: @@ -117,19 +117,19 @@ device: 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 %}