5.7 KiB
title, description, ha_release, ha_domain, ha_quality_scale, ha_category, ha_codeowners, ha_integration_type
| title | description | ha_release | ha_domain | ha_quality_scale | ha_category | ha_codeowners | ha_integration_type | |
|---|---|---|---|---|---|---|---|---|
| Vacuum | Instructions on how to setup and use vacuum's in Home Assistant. | 0.51 | vacuum | internal |
|
entity |
The vacuum integration enables the ability to control home cleaning robots within Home Assistant.
Configuration
To use this integration in your installation, add a vacuum platform to your configuration.yaml file, like the Xiaomi.
# Example configuration.yaml entry
vacuum:
- platform: xiaomi_miio
name: Living room
host: 192.168.1.2
Component services
Available services: turn_on, turn_off, start_pause, start, pause, stop, return_to_base, locate, clean_spot, set_fan_speed and send_command.
Before calling one of these services, make sure your vacuum platform supports it.
Service vacuum.turn_on
Start a new cleaning task. For the Xiaomi Vacuum, Roomba, and Neato use vacuum.start instead.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.turn_off
Stop the current cleaning task and return to the dock. For the Xiaomi Vacuum, Roomba, and Neato use vacuum.stop instead.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.start_pause
Start, pause or resume a cleaning task. For the Xiaomi Vacuum, Roomba, and Neato use vacuum.start and vacuum.pause instead.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.start
Start or resume a cleaning task.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.pause
Pause a cleaning task.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.stop
Stop the current activity of the vacuum.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.return_to_base
Tell the vacuum to return home.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.locate
Locate the vacuum cleaner robot.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.clean_spot
Tell the vacuum cleaner to do a spot clean-up.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Service vacuum.set_fan_speed
Set the fan speed of the vacuum. The fanspeed can be a label, as balanced or turbo, or be a number; it depends on the vacuum platform.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
fan_speed |
no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
Service vacuum.send_command
Send a platform-specific command to the vacuum cleaner.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
command |
no | Command to execute. |
params |
yes | Parameters for the command. |