Vacuum entity
Derive entity platforms from homeassistant.components.vacuum.StateVacuumEntity
Properties
Properties should always only return information from memory and not do I/O (like network requests). Implement update() or async_update() to fetch data.
VacuumEntity is deprecated and will be removed in future releases. Please use or migrate to the StateVacuumEntity
| Name | Type | Default | Description |
|---|---|---|---|
| battery_icon | string | function | Battery icon to show in UI. |
| battery_level | int | none | Current battery level. |
| fan_speed | string | none | The current fan speed. |
| fan_speed_list | list | NotImplementedError() | List of available fan speeds. |
| name | string | Required | Name of the entity. |
| activity | VacuumActivity | Required | Return one of the states listed in the states section. |
States
Setting the state should return an enum from VacuumActivity in the activity property.
| Value | Description |
|---|---|
CLEANING | The vacuum is currently cleaning. |
DOCKED | The vacuum is currently docked, it is assumed that docked can also mean charging. |
IDLE | The vacuum is not paused, not docked and does not have any errors. |
PAUSED | The vacuum was cleaning but was paused without returning to the dock. |
RETURNING | The vacuum is done cleaning and is currently returning to the dock, but not yet docked. |
ERROR | The vacuum encountered an error while cleaning. |
Supported features
Supported features are defined by using values in the VacuumEntityFeature enum
and are combined using the bitwise or (|) operator.
Note that all vacuum entity platforms derived from homeassistant.components.vacuum.StateVacuumEntity
must set the VacuumEntityFeature.STATE flag.
| Value | Description |
|---|---|
BATTERY | The vacuum supports retrieving battery status. |
CLEAN_SPOT | The vacuum supports spot cleaning. |
FAN_SPEED | The vacuum supports setting fan speed. |
LOCATE | The vacuum supports locating. |
MAP | The vacuum supports retrieving its map. |
PAUSE | The vacuum supports the pause command. |
RETURN_HOME | The vacuum supports the return to the dock command. |
SEND_COMMAND | The vacuum supports sending a command to the vacuum. |
START | The vacuum supports the start command. |
STATE | The vacuum supports returning its state. |
STOP | The vacuum supports the stop command. |
Methods
clean_spot or async_clean_spot
Perform a spot clean-up.
locate or async_locate
Locate the vacuum cleaner.
pause or async_pause
Pause the cleaning task.
return_to_base or async_return_to_base
Set the vacuum cleaner to return to the dock.
send_command or async_send_command
Send a command to a vacuum cleaner.
set_fan_speed or async_set_fan_speed
Set the fan speed.
start or async_start
Start or resume the cleaning task.
stop or async_stop
Stop the vacuum cleaner, do not return to base.