91 lines
3.1 KiB
Markdown
91 lines
3.1 KiB
Markdown
---
|
|
title: Vacuum Entity
|
|
sidebar_label: Vacuum
|
|
---
|
|
|
|
## Properties
|
|
|
|
:::tip
|
|
Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data.
|
|
:::
|
|
|
|
:::caution
|
|
VacuumEntity and StateVacuumEntity do not support attribute shorthand for [property implementation](../entity.md#entity-class-or-instance-attributes)
|
|
:::
|
|
|
|
| Name | Type | Default | Description
|
|
| ---- | ---- | ------- | -----------
|
|
| name | string | **Required** | Name of the device.
|
|
| state | string | **Required** | One of the states listed in the states section.
|
|
| battery_level | int | `none` | Current battery level.
|
|
| battery_icon | string | function | Battery icon to show in UI.
|
|
| fan_speed | string | `none` | The current fan speed.
|
|
| fan_speed_list | list | `NotImplementedError()`| List of available fan speeds.
|
|
| error | string | **Required** with `STATE_ERROR` | An error message if the vacuum is in `STATE_ERROR`.
|
|
|
|
## States
|
|
|
|
| State | Description
|
|
| ----- | -----------
|
|
| `STATE_CLEANING` | The vacuum is currently cleaning.
|
|
| `STATE_DOCKED` | The vacuum is currently docked, it is assumed that docked can also mean charging.
|
|
| `STATE_PAUSED` | The vacuum was cleaning but was paused without returning to the dock.
|
|
| `STATE_IDLE` | The vacuum is not paused, not docked and does not have any errors.
|
|
| `STATE_RETURNING` | The vacuum is done cleaning and is currently returning to the dock, but not yet docked.
|
|
| `STATE_ERROR` | The vacuum encountered an error while cleaning, the error can be specified as a property on the entity.
|
|
|
|
### Supported Features
|
|
|
|
Supported features constants are combined using the bitwise or (`|`) operator.
|
|
|
|
| Constant | Description |
|
|
|----------|--------------------------------------|
|
|
| `SUPPORT_TURN_ON` |The vacuum turns on.
|
|
| `SUPPORT_TURN_OFF` |The vacuum turns off.
|
|
| `SUPPORT_PAUSE` | Pause the vacuum.
|
|
| `SUPPORT_STOP` | Stop the vacuum and return to the dock.
|
|
| `SUPPORT_RETURN_HOME` | Return to the dock.
|
|
| `SUPPORT_FAN_SPEED` | The vacuum supports setting fan speed.
|
|
| `SUPPORT_BATTERY` | The vacuum supports retrieving battery status.
|
|
| `SUPPORT_SEND_COMMAND` | The vacuum supports sending a command to the vacuum.
|
|
| `SUPPORT_LOCATE` | The vacuum supports locating.
|
|
| `SUPPORT_CLEAN_SPOT` | The vacuum supports spot cleaning.
|
|
| `SUPPORT_MAP` | The vacuum supports retrieving its map.
|
|
| `SUPPORT_STATE` | The vacuum supports returning it state.
|
|
| `SUPPORT_STATUS` | The vacuum supports returning it status.
|
|
| `SUPPORT_START` | The vacuum supports the start command.
|
|
|
|
## Methods
|
|
|
|
### `turn_on` or `async_turn_on`
|
|
|
|
Turn the vacuum on and start cleaning.
|
|
|
|
### `turn_off` or `async_turn_off`
|
|
|
|
Turn the vacuum off stopping the cleaning and returning home.
|
|
|
|
### `return_to_base` or `async_return_to_base`
|
|
|
|
Set the vacuum cleaner to return to the dock.
|
|
|
|
### `stop` or `async_stop`
|
|
|
|
Stop the vacuum cleaner, do not return to base.
|
|
|
|
### `clean_spot` or `async_clean_spot`
|
|
|
|
Perform a spot clean-up.
|
|
|
|
### `locate` or `async_locate`
|
|
|
|
Locate the vacuum cleaner.
|
|
|
|
### `set_fan_speed` or `async_set_fan_speed`
|
|
|
|
Set the fan speed.
|
|
|
|
### `send_command` or `async_send_command`
|
|
|
|
Send a command to a vacuum cleaner.
|