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-15 13:26:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Alphabetize vacuum documentation (#1826)

Browse Source
This commit is contained in:
Erik Montnemery 2023-07-04 08:52:59 +02:00 committed by GitHub
parent cc6a7647ee
commit 9f87322b4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -17,13 +17,13 @@ Properties should always only return information from memory and not do I/O (lik
| Name | Type | Default | Description | 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. | battery_icon | string | function | Battery icon to show in UI.
| battery_level | int | `none` | Current battery level.
| error | string | **Required** with `STATE_ERROR` | An error message if the vacuum is in `STATE_ERROR`.
| fan_speed | string | `none` | The current fan speed. | fan_speed | string | `none` | The current fan speed.
| fan_speed_list | list | `NotImplementedError()`| List of available fan speeds. | 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`. | name | string | **Required** | Name of the entity.
| state | string | **Required** | One of the states listed in the states section.
## States ## States
@ -31,8 +31,8 @@ Properties should always only return information from memory and not do I/O (lik
| ----- | ----------- | ----- | -----------
| `STATE_CLEANING` | The vacuum is currently cleaning. | `STATE_CLEANING` | The vacuum is currently cleaning.
| `STATE_DOCKED` | The vacuum is currently docked, it is assumed that docked can also mean charging. | `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_IDLE` | The vacuum is not paused, not docked and does not have any errors.
| `STATE_PAUSED` | The vacuum was cleaning but was paused without returning to the dock.
| `STATE_RETURNING` | The vacuum is done cleaning and is currently returning to the dock, but not yet docked. | `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. | `STATE_ERROR` | The vacuum encountered an error while cleaning, the error can be specified as a property on the entity.
@ -43,39 +43,23 @@ and are combined using the bitwise or (`|`) operator.
| Value | Description | | 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. | | `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. | | `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. | | `MAP` | The vacuum supports retrieving its map. |
| `PAUSE` | Pause the vacuum. |
| `RETURN_HOME` | Return to the dock. |
| `SEND_COMMAND` | The vacuum supports sending a command to the vacuum. |
| `START` | The vacuum supports the start command. |
| `STATE` | The vacuum supports returning it state. | | `STATE` | The vacuum supports returning it state. |
| `STATUS` | The vacuum supports returning it status. | | `STATUS` | The vacuum supports returning it status. |
| `START` | The vacuum supports the start command. | | `STOP` | Stop the vacuum and return to the dock. |
| `TURN_OFF` | The vacuum turns off. |
| `TURN_ON` | The vacuum turns on. |
## Methods ## 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` ### `clean_spot` or `async_clean_spot`
Perform a spot clean-up. Perform a spot clean-up.
@ -84,10 +68,26 @@ Perform a spot clean-up.
Locate the vacuum cleaner. Locate the vacuum cleaner.
### `set_fan_speed` or `async_set_fan_speed` ### `return_to_base` or `async_return_to_base`
Set the fan speed. Set the vacuum cleaner to return to the dock.
### `send_command` or `async_send_command` ### `send_command` or `async_send_command`
Send a command to a vacuum cleaner. Send a command to a vacuum cleaner.
### `set_fan_speed` or `async_set_fan_speed`
Set the fan speed.
### `stop` or `async_stop`
Stop the vacuum cleaner, do not return to base.
### `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.