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-14 21:06:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Align documented lawn_mower attributes with implementation (#1923)

Browse Source
This commit is contained in:
Erik Montnemery 2023-09-15 11:06:27 +02:00 committed by GitHub
parent 1b5be3826e
commit 2e9064010c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/core/entity/lawn-mower.md
View File

@ -12,19 +12,18 @@ Properties should always only return information from memory and not do I/O (lik
::: :::
| Name | Type | Default | Description | Name | Type | Default | Description
| ---- | ---- | ------- | ----------- | -------- | ------------------------------------------ | ------- | -----------------
| activity | LawnMowerActivity | **Required** | One of the activities in the LawnMowerActivity enum. | activity | <code>LawnMowerActivity &#124; None</code> | `None` | Current activity.
| supported_features | int | (abstract method) | Bitmap of supported features. See below.
## Activities ## Activities
| Activity | Description | Activity | Description
| ----- | ----------- | -------- | -----------
| `MOWING` | The lawn mower is currently mowing. | `MOWING` | The lawn mower is currently mowing.
| `DOCKED` | The lawn mower is done mowing and is currently docked. | `DOCKED` | The lawn mower is done mowing and is currently docked.
| `PAUSED` | The lawn mower was active and is now paused. | `PAUSED` | The lawn mower was active and is now paused.
| `ERROR` | The lawn mower encountered an error while active and needs assistance. | `ERROR` | The lawn mower encountered an error while active and needs assistance.
## Supported Features ## Supported Features
@ -33,9 +32,9 @@ and are combined using the bitwise or (`|`) operator.
| Value | Description | | Value | Description |
| -------------- | ---------------------------------------------------- | | -------------- | ---------------------------------------------------- |
| `START_MOWING` | The lawn mower supports the mowing command. | | `START_MOWING` | The lawn mower supports the start mowing command. |
| `PAUSE` | The lawn mower supports pausing the current task. | | `PAUSE` | The lawn mower supports pausing the current task. |
| `DOCK` | The lawn mower supports the return to dock command. | `DOCK` | The lawn mower supports the return to dock command. |
## Methods ## Methods