Skip to content

Add EntityFeature enum to Vacuum #1276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
balloob merged 1 commit into from
Apr 3, 2022
Merged

Add EntityFeature enum to Vacuum #1276

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions docs/core/entity/vacuum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.
## Supported Features

Supported features are defined by using values in the `VacuumEntityFeature` enum
and are combined using the bitwise or (`|`) operator.

| 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. |
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare Apr 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its

| `STATUS` | The vacuum supports returning it status. |
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare Apr 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its

| `START` | The vacuum supports the start command. |

## Methods

Expand Down