mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-13 04:16:29 +00:00
Update Vacuum Entity documentation (#701)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
parent
38a2908528
commit
53f669ba41
@ -15,8 +15,8 @@ Properties should always only return information from memory and not do I/O (lik
|
||||
| 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.
|
||||
| cleaning_mode | string | `none` | The current cleaning mode.
|
||||
| cleaning_mode_list | list | `NotImplementedError()`| List of available fan speeds and cleaning modes.
|
||||
| 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
|
||||
@ -30,6 +30,27 @@ Properties should always only return information from memory and not do I/O (lik
|
||||
| `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`
|
||||
@ -56,9 +77,9 @@ Perform a spot clean-up.
|
||||
|
||||
Locate the vacuum cleaner.
|
||||
|
||||
### `set_cleaning_mode` or `async_set_cleaning_mode`
|
||||
### `set_fan_speed` or `async_set_fan_speed`
|
||||
|
||||
Set the cleaning mode.
|
||||
Set the fan speed.
|
||||
|
||||
### `send_command` or `async_send_command`
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user