Vacuum
The vacuum integration enables the ability to control home cleaning robots within Home Assistant.
Building block integration
The vacuum integration cannot be directly used. You cannot create your own vacuum entities using this integration. This integration is a building block for other integrations to use, enabling them to create vacuum entities for you.
Services
Available services: 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.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. |