jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 09:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add EntityFeature enum to Vacuum (#1276)

Browse Source
This commit is contained in:
Franck Nijhof 2022-04-03 06:00:36 +02:00 committed by GitHub
parent c2bd387b45
commit 6c2b4f3da4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/core/entity/vacuum.md
View File

@ -40,26 +40,27 @@ VacuumEntity and StateVacuumEntity do not support attribute shorthand for [prope
| `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
Supported features constants are combined using the bitwise or (`|`) operator.
Supported features are defined by using values in the `VacuumEntityFeature` enum
and 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.
| Value | Description |
| -------------- | ---------------------------------------------------- |
| `TURN_ON` | The vacuum turns on. |
| `TURN_OFF` | The vacuum turns off. |
| `PAUSE` | Pause the vacuum. |
| `STOP` | Stop the vacuum and return to the dock. |
| `RETURN_HOME` | Return to the dock. |
| `FAN_SPEED` | The vacuum supports setting fan speed. |
| `BATTERY` | The vacuum supports retrieving battery status. |
| `SEND_COMMAND` | The vacuum supports sending a command to the vacuum. |
| `LOCATE` | The vacuum supports locating. |
| `CLEAN_SPOT` | The vacuum supports spot cleaning. |
| `MAP` | The vacuum supports retrieving its map. |
| `STATE` | The vacuum supports returning it state. |
| `STATUS` | The vacuum supports returning it status. |
| `START` | The vacuum supports the start command. |
## Methods