highperfocused/GoSungrow
1
0
Fork 0
mirror of https://github.com/MickMake/GoSungrow.git synced 2025-03-26 17:41:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

v3.0.1 - Additional MQTT types.

Browse Source
This commit is contained in:
MickMake 2022-12-19 20:31:13 +11:00
parent 6a4504f189
commit 91cfecb620
6 changed files with 664 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
mmHa/siren.txt Normal file
View File

@ -0,0 +1,138 @@
availability list (optional)
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
payload_available string (optional, default: online)
The payload that represents the available state.
payload_not_available string (optional, default: offline)
The payload that represents the unavailable state.
topic string REQUIRED
An MQTT topic subscribed to receive availability (online/offline) updates.
value_template template (optional)
Defines a template to extract device’s availability from the topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
availability_mode string (optional, default: latest)
When availability is configured, this controls the conditions needed to set the entity to available. Valid entries are all, any, and latest. If set to all, payload_available must be received on all configured availability topics before the entity is marked as online. If set to any, payload_available must be received on at least one configured availability topic before the entity is marked as online. If set to latest, the last payload_available or payload_not_available received on any configured availability topic controls the availability.
availability_template template (optional)
Defines a template to extract device’s availability from the availability_topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
availability_topic string (optional)
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
available_tones list (optional)
A list of available tones the siren supports. When configured, this enables the support for setting a tone and enables the tone state attribute.
command_template template (optional)
Defines a template to generate a custom payload to send to command_topic. The variable value will be assigned with the configured payload_on or payload_off setting. The siren turn on service parameters tone, volume_level or duration can be used as variables in the template. When operation in optimistic mode the corresponding state attributes will be set. Turn on parameters will be filtered if a device misses the support.
command_off_template template (optional)
Defines a template to generate a custom payload to send to command_topic when the siren turn off service is called. By default command_template will be used as template for service turn off. The variable value will be assigned with the configured payload_off setting.
command_topic string (optional)
The MQTT topic to publish commands to change the siren state. Without command templates, a default JSON payload like {"state":"ON", "tone": "bell", "duration": 10, "volume_level": 0.5 } is published. When the siren turn on service is called, the startup parameters will be added to the JSON payload. The state value of the JSON payload will be set to the the payload_on or payload_off configured payload.
device map (optional)
Information about the device this siren is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.
configuration_url string (optional)
A link to the webpage that can manage the configuration of this device. Can be either an HTTP or HTTPS link.
connections list (optional)
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"]].
hw_version string (optional)
The hardware version of the device.
identifiers string | list (optional)
A list of IDs that uniquely identify the device. For example a serial number.
manufacturer string (optional)
The manufacturer of the device.
model string (optional)
The model of the device.
name string (optional)
The name of the device.
suggested_area string (optional)
Suggest an area if the device isn’t in one yet.
sw_version string (optional)
The firmware version of the device.
via_device string (optional)
Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.
enabled_by_default boolean (optional, default: true)
Flag which defines if the entity should be enabled when first added.
encoding string (optional, default: utf-8)
The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
entity_category string (optional, default: None)
The category of the entity.
icon icon (optional)
Icon for the entity.
json_attributes_template template (optional)
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.
json_attributes_topic string (optional)
The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.
name string (optional, default: MQTT Siren)
The name to use when displaying this siren.
object_id string (optional)
Used instead of name for automatic generation of entity_id
optimistic boolean (optional)
Flag that defines if siren works in optimistic mode.
Default: true if no state_topic defined, else false.
payload_available string (optional, default: online)
The payload that represents the available state.
payload_not_available string (optional, default: offline)
The payload that represents the unavailable state.
payload_off string (optional, default: OFF)
The payload that represents off state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_off for details) and sending as off command to the command_topic.
payload_on string (optional, default: ON)
The payload that represents on state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_on for details) and sending as on command to the command_topic.
qos integer (optional, default: 0)
The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
retain boolean (optional, default: false)
If the published message should have the retain flag on or not.
state_off string (optional)
The payload that represents the off state. Used when value that represents off state in the state_topic is different from value that should be sent to the command_topic to turn the device off.
Default: payload_off if defined, else 'OFF'
state_on string (optional)
The payload that represents the on state. Used when value that represents on state in the state_topic is different from value that should be sent to the command_topic to turn the device on.
Default: payload_on if defined, else 'ON'
state_topic string (optional)
The MQTT topic subscribed to receive state updates. The state update may be either JSON or a simple string. When a JSON payload is detected, the state value of the JSON payload should supply the payload_on or payload_off defined payload to turn the siren on or off. Additionally, the state attributes duration, tone and volume_level can be updated. Use value_template to transform the received state udpate to a compliant JSON payload. Attributes will only be set if the function is supported by the device and a valid value is supplied. When a non JSON payload is detected, it should be either of the payload_on or payload_off defined payloads or None to reset the siren’s state to unknown. The initial state will be unknown. The state will be reset to unknown if a None payload or null JSON value is received as a state update.
state_value_template string (optional)
Defines a template to extract device’s state from the state_topic. To determine the siren’s state result of this template will be compared to state_on and state_off. Alternatively value_template can be used to render to a valid JSON payload.
support_duration boolean (optional, default: true)
Set to true if the MQTT siren supports the duration service turn on parameter and enables the duration state attribute.
support_volume_set boolean (optional, default: true)
Set to true if the MQTT siren supports the volume_set service turn on parameter and enables the volume_level state attribute.
unique_id string (optional)
An ID that uniquely identifies this siren device. If two sirens have the same unique ID, Home Assistant will raise an exception.

126
mmHa/switch.txt Normal file
View File

@ -0,0 +1,126 @@
availability list (optional)
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
payload_available string (optional, default: online)
The payload that represents the available state.
payload_not_available string (optional, default: offline)
The payload that represents the unavailable state.
topic string REQUIRED
An MQTT topic subscribed to receive availability (online/offline) updates.
value_template template (optional)
Defines a template to extract device’s availability from the topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
availability_mode string (optional, default: latest)
When availability is configured, this controls the conditions needed to set the entity to available. Valid entries are all, any, and latest. If set to all, payload_available must be received on all configured availability topics before the entity is marked as online. If set to any, payload_available must be received on at least one configured availability topic before the entity is marked as online. If set to latest, the last payload_available or payload_not_available received on any configured availability topic controls the availability.
availability_template template (optional)
Defines a template to extract device’s availability from the availability_topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
availability_topic string (optional)
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
command_topic string (optional)
The MQTT topic to publish commands to change the switch state.
device map (optional)
Information about the device this switch is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.
configuration_url string (optional)
A link to the webpage that can manage the configuration of this device. Can be either an HTTP or HTTPS link.
connections list (optional)
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"]].
hw_version string (optional)
The hardware version of the device.
identifiers string | list (optional)
A list of IDs that uniquely identify the device. For example a serial number.
manufacturer string (optional)
The manufacturer of the device.
model string (optional)
The model of the device.
name string (optional)
The name of the device.
suggested_area string (optional)
Suggest an area if the device isn’t in one yet.
sw_version string (optional)
The firmware version of the device.
via_device string (optional)
Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.
device_class device_class (optional, default: None)
The type/class of the switch to set the icon in the frontend.
enabled_by_default boolean (optional, default: true)
Flag which defines if the entity should be enabled when first added.
encoding string (optional, default: utf-8)
The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
entity_category string (optional, default: None)
The category of the entity.
icon icon (optional)
Icon for the entity.
json_attributes_template template (optional)
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.
json_attributes_topic string (optional)
The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.
name string (optional, default: MQTT Switch)
The name to use when displaying this switch.
object_id string (optional)
Used instead of name for automatic generation of entity_id
optimistic boolean (optional)
Flag that defines if switch works in optimistic mode.
Default: true if no state_topic defined, else false.
payload_available string (optional, default: online)
The payload that represents the available state.
payload_not_available string (optional, default: offline)
The payload that represents the unavailable state.
payload_off string (optional, default: OFF)
The payload that represents off state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_off for details) and sending as off command to the command_topic.
payload_on string (optional, default: ON)
The payload that represents on state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_on for details) and sending as on command to the command_topic.
qos integer (optional, default: 0)
The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
retain boolean (optional, default: false)
If the published message should have the retain flag on or not.
state_off string (optional)
The payload that represents the off state. Used when value that represents off state in the state_topic is different from value that should be sent to the command_topic to turn the device off.
Default: payload_off if defined, else OFF
state_on string (optional)
The payload that represents the on state. Used when value that represents on state in the state_topic is different from value that should be sent to the command_topic to turn the device on.
Default: payload_on if defined, else ON
state_topic string (optional)
The MQTT topic subscribed to receive state updates.
unique_id string (optional)
An ID that uniquely identifies this switch device. If two switches have the same unique ID, Home Assistant will raise an exception.
value_template string (optional)
Defines a template to extract device’s state from the state_topic. To determine the switches’s state result of this template will be compared to state_on and state_off.

39
mmHa/tag.txt Normal file
View File

@ -0,0 +1,39 @@
topic string REQUIRED
The MQTT topic subscribed to receive tag scanned events.
value_template string (optional)
Defines a template that returns a tag ID.
device map REQUIRED
Information about the device this device trigger is a part of to tie it into the device registry. At least one of identifiers or connections must be present to identify the device.
configuration_url string (optional)
A link to the webpage that can manage the configuration of this device. Can be either an HTTP or HTTPS link.
connections list | map (optional)
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'].
hw_version string (optional)
The hardware version of the device.
identifiers list | string (optional)
A list of IDs that uniquely identify the device. For example a serial number.
manufacturer string (optional)
The manufacturer of the device.
model string (optional)
The model of the device.
name string (optional)
The name of the device.
suggested_area string (optional)
Suggest an area if the device isn’t in one yet.
sw_version string (optional)
The firmware version of the device.
via_device string (optional)
Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.

111
mmHa/text.txt Normal file
View File

@ -0,0 +1,111 @@
availability list (optional)
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
payload_available string (optional, default: online)
The payload that represents the available state.
payload_not_available string (optional, default: offline)
The payload that represents the unavailable state.
topic string REQUIRED
An MQTT topic subscribed to receive availability (online/offline) updates.
value_template template (optional)
Defines a template to extract device’s availability from the topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
availability_topic string (optional)
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
availability_mode string (optional, default: latest)
When availability is configured, this controls the conditions needed to set the entity to available. Valid entries are all, any, and latest. If set to all, payload_available must be received on all configured availability topics before the entity is marked as online. If set to any, payload_available must be received on at least one configured availability topic before the entity is marked as online. If set to latest, the last payload_available or payload_not_available received on any configured availability topic controls the availability.
availability_template template (optional)
Defines a template to extract device’s availability from the availability_topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
command_template template (optional)
Defines a template to generate the payload to send to command_topic.
command_topic string REQUIRED
The MQTT topic to publish the text value that is set.
device map (optional)
Information about the device this of text capability is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.
configuration_url string (optional)
A link to the webpage that can manage the configuration of this device. Can be either an HTTP or HTTPS link.
connections list (optional)
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"].
hw_version string (optional)
The hardware version of the device.
identifiers list | string (optional)
A list of IDs that uniquely identify the device. For example a serial number.
manufacturer string (optional)
The manufacturer of the device.
model string (optional)
The model of the device.
name string (optional)
The name of the device.
suggested_area string (optional)
Suggest an area if the device isn’t in one yet.
sw_version string (optional)
The firmware version of the device.
via_device string (optional)
Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.
enabled_by_default boolean (optional, default: true)
Flag which defines if the entity should be enabled when first added.
encoding string (optional, default: utf-8)
The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
entity_category string (optional, default: None)
The category of the entity.
json_attributes_template template (optional)
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.
json_attributes_topic string (optional)
The MQTT topic subscribed to receive a JSON dictionary payload and then set as entity attributes. Implies force_update of the current select state when a message is received on this topic.
max integer (optional, default: 255)
The maximum size of a text being set or received (maximum is 255).
min integer (optional, default: 0)
The minimum size of a text being set or received.
mode string (optional, default: text)
The mode off the text entity. Must be either text or password.
name string (optional, default: MQTT Text)
The name of the text entity.
object_id string (optional)
Used instead of name for automatic generation of entity_id
pattern string (optional)
A valid regular expression the text being set or received must match with.
qos integer (optional, default: 0)
The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
retain boolean (optional, default: false)
If the published message should have the retain flag on or not.
state_topic string (optional)
The MQTT topic subscribed to receive text state updates. Text state updates should match the pattern (if set) and meet the size constraints min and max. Can be used with value_template to render the incoming payload to a text update.
unique_id string (optional)
An ID that uniquely identifies this Select. If two Selects have the same unique ID Home Assistant will raise an exception.
value_template template (optional)
Defines a template to extract the text state value from the payload received on state_topic.

123
mmHa/update.txt Normal file
View File

@ -0,0 +1,123 @@
availability list (optional)
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
payload_available string (optional, default: online)
The payload that represents the available state.
payload_not_available string (optional, default: offline)
The payload that represents the unavailable state.
topic string REQUIRED
An MQTT topic subscribed to receive availability (online/offline) updates.
value_template template (optional)
Defines a template to extract device’s availability from the topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
availability_topic string (optional)
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
availability_mode string (optional, default: latest)
When availability is configured, this controls the conditions needed to set the entity to available. Valid entries are all, any, and latest. If set to all, payload_available must be received on all configured availability topics before the entity is marked as online. If set to any, payload_available must be received on at least one configured availability topic before the entity is marked as online. If set to latest, the last payload_available or payload_not_available received on any configured availability topic controls the availability.
availability_template template (optional)
Defines a template to extract device’s availability from the availability_topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
command_topic string (optional)
The MQTT topic to publish payload_install to start installing process.
device map (optional)
Information about the device this Update is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.
configuration_url string (optional)
A link to the webpage that can manage the configuration of this device. Can be either an HTTP or HTTPS link.
connections list (optional)
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"].
hw_version string (optional)
The hardware version of the device.
identifiers list | string (optional)
A list of IDs that uniquely identify the device. For example a serial number.
manufacturer string (optional)
The manufacturer of the device.
model string (optional)
The model of the device.
name string (optional)
The name of the device.
suggested_area string (optional)
Suggest an area if the device isn’t in one yet.
sw_version string (optional)
The firmware version of the device.
via_device string (optional)
Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.
device_class device_class (optional, default: None)
The type/class of the update to set the icon in the frontend.
enabled_by_default boolean (optional, default: true)
Flag which defines if the entity should be enabled when first added.
encoding string (optional, default: utf-8)
The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
entity_category string (optional, default: None)
The category of the entity.
entity_picture string (optional)
Picture URL for the entity.
icon icon (optional)
Icon for the entity.
json_attributes_template template (optional)
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.
json_attributes_topic string (optional)
The MQTT topic subscribed to receive a JSON dictionary payload and then set as entity attributes. Implies force_update of the current select state when a message is received on this topic.
latest_version_template template (optional)
Defines a template to extract the latest version value.
latest_version_topic string (optional)
The MQTT topic subscribed to receive an update of the latest version.
name string (optional)
The name of the Select.
object_id string (optional)
Used instead of name for automatic generation of entity_id
payload_install string (optional)
The MQTT payload to start installing process.
qos integer (optional, default: 0)
The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
release_summary string (optional)
Summary of the release notes or changelog. This is suitable a brief update description of max 255 characters.
release_url string (optional)
URL to the full release notes of the latest version available.
retain boolean (optional, default: false)
If the published message should have the retain flag on or not.
state_topic string (optional)
The MQTT topic subscribed to receive state updates. The state update may be either JSON or a simple string with installed_version value. When a JSON payload is detected, the state value of the JSON payload should supply the installed_version and can optional supply: latest_version, title, release_summary, release_url or an entity_picture URL.
title string (optional)
Title of the software, or firmware update. This helps to differentiate between the device or entity name versus the title of the software installed.
unique_id string (optional)
An ID that uniquely identifies this Select. If two Selects have the same unique ID Home Assistant will raise an exception.
value_template template (optional)
Defines a template to extract the installed_version state value or to render to a valid JSON payload on from the payload received on state_topic.

127
mmHa/vacuum.txt Normal file
View File

@ -0,0 +1,127 @@
availability list (optional)
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
payload_available string (optional, default: online)
The payload that represents the available state.
payload_not_available string (optional, default: offline)
The payload that represents the unavailable state.
topic string REQUIRED
An MQTT topic subscribed to receive availability (online/offline) updates.
value_template template (optional)
Defines a template to extract device’s availability from the topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
availability_mode string (optional, default: latest)
When availability is configured, this controls the conditions needed to set the entity to available. Valid entries are all, any, and latest. If set to all, payload_available must be received on all configured availability topics before the entity is marked as online. If set to any, payload_available must be received on at least one configured availability topic before the entity is marked as online. If set to latest, the last payload_available or payload_not_available received on any configured availability topic controls the availability.
availability_template template (optional)
Defines a template to extract device’s availability from the availability_topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
availability_topic string (optional)
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
command_topic string (optional)
The MQTT topic to publish commands to control the vacuum.
device map (optional)
Information about the device this switch is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.
configuration_url string (optional)
A link to the webpage that can manage the configuration of this device. Can be either an HTTP or HTTPS link.
connections list (optional)
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"]].
hw_version string (optional)
The hardware version of the device.
identifiers string | list (optional)
A list of IDs that uniquely identify the device. For example a serial number.
manufacturer string (optional)
The manufacturer of the device.
model string (optional)
The model of the device.
name string (optional)
The name of the device.
suggested_area string (optional)
Suggest an area if the device isn’t in one yet.
sw_version string (optional)
The firmware version of the device.
via_device string (optional)
Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.
encoding string (optional, default: utf-8)
The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
fan_speed_list string | list (optional)
List of possible fan speeds for the vacuum.
json_attributes_template template (optional)
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.
json_attributes_topic string (optional)
The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.
name string (optional, default: MQTT Vacuum)
The name of the vacuum.
object_id string (optional)
Used instead of name for automatic generation of entity_id
payload_available string (optional, default: online)
The payload that represents the available state.
payload_clean_spot string (optional, default: clean_spot)
The payload to send to the command_topic to begin a spot cleaning cycle.
payload_locate string (optional, default: locate)
The payload to send to the command_topic to locate the vacuum (typically plays a song).
payload_not_available string (optional, default: offline)
The payload that represents the unavailable state.
payload_pause string (optional, default: pause)
The payload to send to the command_topic to pause the vacuum.
payload_return_to_base string (optional, default: return_to_base)
The payload to send to the command_topic to tell the vacuum to return to base.
payload_start string (optional, default: start)
The payload to send to the command_topic to begin the cleaning cycle.
payload_stop string (optional, default: stop)
The payload to send to the command_topic to stop cleaning.
qos integer (optional, default: 0)
The maximum QoS level of the state topic.
retain boolean (optional, default: false)
If the published message should have the retain flag on or not.
schema string (optional, default: legacy)
The schema to use. Must be state to select the state schema.
send_command_topic string (optional)
The MQTT topic to publish custom commands to the vacuum.
set_fan_speed_topic string (optional)
The MQTT topic to publish commands to control the vacuum’s fan speed.
state_topic string (optional)
The MQTT topic subscribed to receive state messages from the vacuum. Messages received on the state_topic must be a valid JSON dictionary, with a mandatory state key and optionally battery_level and fan_speed keys as shown in the example.
supported_features string | list (optional)
List of features that the vacuum supports (possible values are start, stop, pause, return_home, battery, status, locate, clean_spot, fan_speed, send_command).
Default: start, stop, return_home, status, battery, clean_spot
unique_id string (optional)
An ID that uniquely identifies this vacuum. If two vacuums have the same unique ID, Home Assistant will raise an exception.