jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Lawn mower: add states (#34688)

Browse Source
This commit is contained in:
c0ffeeca7 2024-09-11 15:19:27 +02:00 committed by GitHub
parent 8f3a461421
commit 39ccceabfc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
source/_integrations/lawn_mower.markdown
View File

@ -11,10 +11,20 @@ ha_codeowners:
ha_integration_type: entity ha_integration_type: entity
--- ---
The lawn mower integration allows the control of robotic lawn mowers to be reflected within Home Assistant. The **Lawn mower** {% term integration %} allows the control of robotic lawn mowers to be reflected within Home Assistant.
{% include integrations/building_block_integration.md %} {% include integrations/building_block_integration.md %}
## The state of a lawn mower entity
A lawn mower entity can have the following states:
- **Mowing**: The lawn mower is currently mowing.
- **Docked**: The lawn mower is done mowing and is currently docked.
- **Paused**: The lawn mower was active and is now paused.
- **Returning**: The lawn mower is returning to the dock.
- **Error**: The lawn mower encountered an error while active and needs assistance.
## Actions ## Actions
Available actions: `start_mowing`, `pause` and `dock`. Available actions: `start_mowing`, `pause` and `dock`.
@ -25,22 +35,22 @@ Before calling one of these actions, make sure your lawn_mower platform supports
Start or resume a mowing task. Start or resume a mowing task.
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- | | -------------- | -------- | -------------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. | | `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |
### Action `lawn_mower.pause` ### Action `lawn_mower.pause`
Pause a mowing task. Pause a mowing task.
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- | | -------------- | -------- | -------------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. | | `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |
### Action `lawn_mower.dock` ### Action `lawn_mower.dock`
Tell the lawn_mower to return to dock. Tell the lawn_mower to return to dock.
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- | | -------------- | -------- | -------------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. | | `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |