Vacuum cleaner robots
The vacuum component enables the ability to control home cleaning robots within Home Assistant.
To use this component in your installation, add a vacuum platform to your configuration.yaml file, like the Xiaomi.
# Example configuration.yaml entry
vacuum:
- platform: xiaomi
name: 'name of the robot'
host: 192.168.1.2
token: your-token-here
Component services
Available services: turn_on, turn_off, start_pause, stop, return_to_home, locate, clean_spot, set_fanspeed and send_command.
Before calling one of these services, make sure your botvac platform supports it.
Service vacuum/turn_on
Start a new cleaning task.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific botvac. Else targets all. |
Service vacuum/turn_off
Stop the current cleaning task and return to the dock.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific botvac. Else targets all. |
Service vacuum/start_pause
Start, pause or resume a cleaning task.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific botvac. Else targets all. |
Service vacuum/stop
Stop the current activity of the botvac.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific botvac. Else targets all. |
Service vacuum/return_to_home
Tell the botvac to return home.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific botvac. Else targets all. |
Service vacuum/locate
Locate the vacuum cleaner robot.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific botvac. Else targets 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 botvac. Else targets all. |
Service vacuum/set_fanspeed
Set the fan speed of the botvac. 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 botvac. Else targets all. |
fanspeed |
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 botvac. Else targets all. |
command |
no | Command to execute. |
params |
yes | Parameters for the command. |