jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-10 10:56:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MQTT vacuum config to integration key (#22838)

Browse Source
This commit is contained in:
Jan Bouwhuis 2022-05-23 14:29:55 +02:00 committed by GitHub
parent 9abd798311
commit fee352d834
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 79 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
source/_integrations/vacuum.mqtt.markdown
View File

@ -21,10 +21,30 @@ To add your MQTT vacuum to your installation, add the following to your `configu
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
mqtt:
vacuum:
- 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: vacuum:
- platform: mqtt - platform: mqtt
command_topic: "vacuum/command"
``` ```
{% enddetails %}
## Legacy Configuration ## Legacy Configuration
Legacy MQTT vacuum configuration section. Legacy MQTT vacuum configuration section.
@ -243,41 +263,41 @@ unique_id:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
vacuum: mqtt:
- platform: mqtt vacuum:
name: "MQTT Vacuum" - name: "MQTT Vacuum"
supported_features: supported_features:
- turn_on - turn_on
- turn_off - turn_off
- pause - pause
- stop - stop
- return_home - return_home
- battery - battery
- status - status
- locate - locate
- clean_spot - clean_spot
- fan_speed - fan_speed
- send_command - send_command
command_topic: "vacuum/command" command_topic: "vacuum/command"
battery_level_topic: "vacuum/state" battery_level_topic: "vacuum/state"
battery_level_template: "{{ value_json.battery_level }}" battery_level_template: "{{ value_json.battery_level }}"
charging_topic: "vacuum/state" charging_topic: "vacuum/state"
charging_template: "{{ value_json.charging }}" charging_template: "{{ value_json.charging }}"
cleaning_topic: "vacuum/state" cleaning_topic: "vacuum/state"
cleaning_template: "{{ value_json.cleaning }}" cleaning_template: "{{ value_json.cleaning }}"
docked_topic: "vacuum/state" docked_topic: "vacuum/state"
docked_template: "{{ value_json.docked }}" docked_template: "{{ value_json.docked }}"
error_topic: "vacuum/state" error_topic: "vacuum/state"
error_template: "{{ value_json.error }}" error_template: "{{ value_json.error }}"
fan_speed_topic: "vacuum/state" fan_speed_topic: "vacuum/state"
fan_speed_template: "{{ value_json.fan_speed }}" fan_speed_template: "{{ value_json.fan_speed }}"
set_fan_speed_topic: "vacuum/set_fan_speed" set_fan_speed_topic: "vacuum/set_fan_speed"
fan_speed_list: fan_speed_list:
- min - min
- medium - medium
- high - high
- max - max
send_command_topic: "vacuum/send_command" send_command_topic: "vacuum/send_command"
``` ```
{% endraw %} {% endraw %}
@ -512,30 +532,30 @@ unique_id:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
vacuum: mqtt:
- platform: mqtt vacuum:
name: "MQTT Vacuum" - name: "MQTT Vacuum"
schema: state schema: state
supported_features: supported_features:
- start - start
- pause - pause
- stop - stop
- return_home - return_home
- battery - battery
- status - status
- locate - locate
- clean_spot - clean_spot
- fan_speed - fan_speed
- send_command - send_command
command_topic: "vacuum/command" command_topic: "vacuum/command"
state_topic: "vacuum/state" state_topic: "vacuum/state"
set_fan_speed_topic: "vacuum/set_fan_speed" set_fan_speed_topic: "vacuum/set_fan_speed"
fan_speed_list: fan_speed_list:
- min - min
- medium - medium
- high - high
- max - max
send_command_topic: "vacuum/send_command" send_command_topic: "vacuum/send_command"
``` ```
### State MQTT Protocol ### State MQTT Protocol