Update MQTT platforms that now support availablity (#4293)
To accompany changes from: https://github.com/home-assistant/home-assistant/pull/11336 Updated platforms: - Switch (previously supported) - Binary sensor (previously supported) - Cover (previously supported) - Light - JSON light - Template light - Sensor - Alarm control panel - Lock - HVAC - Fan - Vacuum
This commit is contained in:
Dan Nixon
Paulus Schoutsen
parent
943b2e3119
commit
5d321e66f7
12 changed files with 1024 additions and 229 deletions
|
|
@ -53,36 +53,133 @@ vacuum:
|
|||
send_command_topic: 'vacuum/send_command'
|
||||
```
|
||||
|
||||
Basic Configuration variables:
|
||||
|
||||
- **name** (*Optional*): The name of the vacuum. Defaults to `MQTT Vacuum`.
|
||||
- **supported_features** (*Optional*): List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`). Defaults to `turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`.
|
||||
- **command_topic** (*Optional*): The MQTT topic to publish commands to control the vacuum.
|
||||
|
||||
Advanced Configuration variables:
|
||||
|
||||
- **qos** (*Optional*): The maximum QoS level of the state topic. Defaults to `0`. Will also be used when publishing messages.
|
||||
- **retain** (*Optional*): If the published message should have the retain flag on or not. Defaults to `false`.
|
||||
- **payload_turn_on** (*Optional*): The payload to send to the `command_topic` to begin the cleaning cycle. Defaults to `turn_on`.
|
||||
- **payload_turn_off** (*Optional*): The payload to send to the `command_topic` to turn the vacuum off. Defaults to `turn_off`.
|
||||
- **payload_return_to_base** (*Optional*): The payload to send to the `command_topic` to tell the vacuum to return to base. Defaults to `return_to_base`.
|
||||
- **payload_stop** (*Optional*): The payload to send to the `command_topic` to stop the vacuum. Defaults to `stop`.
|
||||
- **payload_clean_spot** (*Optional*): The payload to send to the `command_topic` to begin a spot cleaning cycle. Defaults to `clean_spot`.
|
||||
- **payload_locate** (*Optional*): The payload to send to the `command_topic` to locate the vacuum (typically plays a song). Defaults to `locate`.
|
||||
- **payload_start_pause** (*Optional*): The payload to send to the `command_topic` to start or pause the vacuum. Defaults to `start_pause`.
|
||||
- **battery_level_topic** (*Optional*): The MQTT topic subscribed to receive battery level values from the vacuum.
|
||||
- **battery_level_template** (*Optional*): Defines a [template](/topics/templating/) to define the battery level of the vacuum.
|
||||
- **charging_topic** (*Optional*): The MQTT topic subscribed to receive charging state values from the vacuum.
|
||||
- **charging_template** (*Optional*): Defines a [template](/topics/templating/) to define the charging state of the vacuum.
|
||||
- **cleaning_topic** (*Optional*): The MQTT topic subscribed to receive cleaning state values from the vacuum.
|
||||
- **cleaning_template** (*Optional*): Defines a [template](/topics/templating/) to define the cleaning state of the vacuum.
|
||||
- **docked_topic** (*Optional*): The MQTT topic subscribed to receive docked state values from the vacuum.
|
||||
- **docked_template** (*Optional*): Defines a [template](/topics/templating/) to define the docked state of the vacuum.
|
||||
- **fan_speed_topic** (*Optional*): The MQTT topic subscribed to receive fan speed values from the vacuum.
|
||||
- **fan_speed_template** (*Optional*): Defines a [template](/topics/templating/) to define the fan speed of the vacuum.
|
||||
- **set_fan_speed_topic** (*Optional*): The MQTT topic to publish commands to control the vacuum's fan speed.
|
||||
- **fan_speed_list** (*Optional*): List of possible fan speeds for the vacuum.
|
||||
- **send_command_topic** (*Optional*): The MQTT topic to publish custom commands to the vacuum.
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name of the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
default: MQTT Vacuum
|
||||
supported_features:
|
||||
description: "List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)."
|
||||
required: false
|
||||
type: string list
|
||||
default: "`turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`"
|
||||
command_topic:
|
||||
description: The MQTT topic to publish commands to control the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
qos:
|
||||
description: The maximum QoS level of the state topic.
|
||||
required: false
|
||||
type: integer
|
||||
default: 0
|
||||
retain:
|
||||
description: If the published message should have the retain flag on or not.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
payload_turn_on:
|
||||
description: "The payload to send to the `command_topic` to begin the cleaning cycle."
|
||||
required: false
|
||||
type: string
|
||||
default: turn_on
|
||||
payload_turn_off:
|
||||
description: "The payload to send to the `command_topic` to turn the vacuum off."
|
||||
required: false
|
||||
type: string
|
||||
default: turn_off
|
||||
payload_return_to_base:
|
||||
description: The payload to send to the `command_topic` to tell the vacuum to return to base.
|
||||
required: false
|
||||
type: string
|
||||
default: return_to_base
|
||||
payload_stop:
|
||||
description: The payload to send to the `command_topic` to stop the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
default: stop
|
||||
payload_clean_spot:
|
||||
description: The payload to send to the `command_topic` to begin a spot cleaning cycle.
|
||||
required: false
|
||||
type: string
|
||||
default: clean_spot
|
||||
payload_locate:
|
||||
description: The payload to send to the `command_topic` to locate the vacuum (typically plays a song).
|
||||
required: false
|
||||
type: string
|
||||
default: locate
|
||||
payload_start_pause:
|
||||
description: The payload to send to the `command_topic` to start or pause the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
default: start_pause
|
||||
battery_level_topic:
|
||||
description: The MQTT topic subscribed to receive battery level values from the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
battery_level_template:
|
||||
description: "Defines a [template](/topics/templating/) to define the battery level of the vacuum."
|
||||
required: false
|
||||
type: string
|
||||
charging_topic:
|
||||
description: The MQTT topic subscribed to receive charging state values from the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
charging_template:
|
||||
description: "Defines a [template](/topics/templating/) to define the charging state of the vacuum."
|
||||
required: false
|
||||
type: string
|
||||
cleaning_topic:
|
||||
description: The MQTT topic subscribed to receive cleaning state values from the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
cleaning_template:
|
||||
description: "Defines a [template](/topics/templating/) to define the cleaning state of the vacuum."
|
||||
required: false
|
||||
type: string
|
||||
docked_topic:
|
||||
description: The MQTT topic subscribed to receive docked state values from the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
docked_template:
|
||||
description: "Defines a [template](/topics/templating/) to define the docked state of the vacuum."
|
||||
required: false
|
||||
type: string
|
||||
fan_speed_topic:
|
||||
description: The MQTT topic subscribed to receive fan speed values from the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
fan_speed_template:
|
||||
description: "Defines a [template](/topics/templating/) to define the fan speed of the vacuum."
|
||||
required: false
|
||||
type: string
|
||||
set_fan_speed_topic:
|
||||
description: The MQTT topic to publish commands to control the vacuum's fan speed.
|
||||
required: false
|
||||
type: string
|
||||
fan_speed_list:
|
||||
description: List of possible fan speeds for the vacuum.
|
||||
required: false
|
||||
type: string list
|
||||
send_command_topic:
|
||||
description: The MQTT topic to publish custom commands to the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
availability_topic:
|
||||
description: The MQTT topic subscribed to receive availability (online/offline) updates.
|
||||
required: false
|
||||
type: string
|
||||
payload_available:
|
||||
description: The payload that represents the available state.
|
||||
required: false
|
||||
type: string
|
||||
default: online
|
||||
payload_not_available:
|
||||
description: The payload that represents the unavailable state.
|
||||
required: false
|
||||
type: string
|
||||
default: offline
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Default MQTT Protocol %}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue