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-13 20:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add new vacuum state property and enum (#2360)

Browse Source 
* Add new vacuum state property and enum

* Fix review comments

* New date
This commit is contained in:
G Johansson 2024-12-08 18:08:58 +01:00 committed by GitHub
parent 7daebad76c
commit aff6de761d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 43 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
blog/2024-12-08-new-vacuum-state-property.md Normal file
View File

@ -0,0 +1,33 @@
---
author: G Johansson
authorURL: https://github.com/gjohansson-ST
authorImageURL: https://avatars.githubusercontent.com/u/62932417?v=4
authorTwitter: GJohansson
title: "New vacuum state property"
---
As of Home Assistant Core 2025.1, the constants used to return state in `StateVacuumEntity` are deprecated and replaced by the `VacuumActivity` enum.
Also with this change, integrations should set the `activity` property instead of directly setting the `state` property.
There is a one-year deprecation period, and the constants will stop working from 2026.1 to ensure all custom integration authors have time to adjust.
### Example
```python
from homeassistant.components.vacuum import VacuumActivity
class MyVacuumCleaner(StateVacuumEntity):
"""My vacuum cleaner."""
@property
def activity(self) -> VacuumActivity | None:
"""Return the state of the vacuum."""
if self.device.is_cleaning():
return VacuumActivity.CLEANING
return VacuumActivity.DOCKED
```
More details can be found in the [vacuum documentation](/docs/core/entity/vacuum#states).

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

@ -22,18 +22,20 @@ Properties should always only return information from memory and not do I/O (lik
| fan_speed | string | `none` | The current fan speed.
| fan_speed_list | list | `NotImplementedError()`| List of available fan speeds.
| name | string | **Required** | Name of the entity.
| state | string | **Required** | One of the states listed in the states section.
| activity | VacuumActivity | **Required** | Return one of the states listed in the states section.
## States
| State | Description
Setting the state should return an enum from VacuumActivity in the `activity` property.
| Value | Description
| ----- | -----------
| `STATE_CLEANING` | The vacuum is currently cleaning.
| `STATE_DOCKED` | The vacuum is currently docked, it is assumed that docked can also mean charging.
| `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_ERROR` | The vacuum encountered an error while cleaning.
| `CLEANING` | The vacuum is currently cleaning.
| `DOCKED` | The vacuum is currently docked, it is assumed that docked can also mean charging.
| `IDLE` | The vacuum is not paused, not docked and does not have any errors.
| `PAUSED` | The vacuum was cleaning but was paused without returning to the dock.
| `RETURNING` | The vacuum is done cleaning and is currently returning to the dock, but not yet docked.
| `ERROR` | The vacuum encountered an error while cleaning.
## Supported features