Implement new state property for vacuum which is using an enum #126353

gjohansson-ST · 2024-09-20T17:37:58Z

Proposed change

Implement separate state property for vacuum which returns VacuumEntityState enum
Architectural decision: home-assistant/architecture#1141
Dev docs: home-assistant/developers.home-assistant#2360

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

home-assistant · 2024-09-20T17:38:05Z

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (vacuum) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of vacuum can trigger bot actions by commenting:

@home-assistant close Closes the pull request.
@home-assistant rename Awesome new title Renames the pull request.
@home-assistant reopen Reopen the pull request.
@home-assistant unassign vacuum Removes the current integration label and assignees on the pull request, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

MartinHjelmare · 2024-11-25T15:27:15Z

homeassistant/components/romy/vacuum.py

@@ -75,7 +79,11 @@ def _handle_coordinator_update(self) -> None:
        """Handle updated data from the coordinator."""
        self._attr_fan_speed = FAN_SPEEDS[self.romy.fan_speed]
        self._attr_battery_level = self.romy.battery_level
-        self._attr_state = self.romy.status
+        try:
+            assert self.romy.status is not None


Assertions can be turned off. Use a regular condition to check for None.

MartinHjelmare · 2024-11-25T15:28:19Z

homeassistant/components/roomba/entity.py

-    "run": STATE_CLEANING,
-    "stop": STATE_IDLE,
-    "stuck": STATE_ERROR,
+    "": VacuumActivity.IDLE,


Side note: The base entity class should not use any platform details. This should be moved to the vacuum platform.

MartinHjelmare · 2024-11-25T15:31:15Z

homeassistant/components/roomba/entity.py

@@ -128,17 +125,20 @@ def last_mission(self):
        return dt_util.utc_from_timestamp(ts)

    @property
-    def _robot_state(self):
+    def _robot_state(self) -> VacuumActivity:


Please move this to the child class below. It's only used there. We shouldn't use VacuumActivity if the entity isn't a vacuum entity. This can be done as prerequisite work for this PR.

MartinHjelmare · 2024-11-25T15:40:12Z

homeassistant/components/sharkiq/vacuum.py

@@ -151,7 +147,7 @@ def error_message(self) -> str | None:
        return self.sharkiq.error_text

    @property
-    def operating_mode(self) -> str | None:
+    def operating_mode(self) -> VacuumActivity | None:


Please merge this into the activity property. It's very confusing to have this property named operating_mode that returns an activity. This can be done as prerequisite work for this PR.

MartinHjelmare · 2024-11-25T15:50:53Z

homeassistant/components/vacuum/__init__.py

+
+        Integrations should implement activity instead of using state directly.
+        """
+        report(


Please use report_usage instead.

MartinHjelmare · 2024-11-25T15:56:04Z

homeassistant/components/vacuum/const.py

+_DEPRECATED_STATE_ERROR = DeprecatedConstantEnum(VacuumActivity.ERROR, "2025.12")
+
+
+STATES = [cls.value for cls in VacuumActivity]


What is using the STATES constant?

MartinHjelmare · 2024-11-25T16:46:22Z

tests/components/litterrobot/test_vacuum.py

    ],
 )
-async def test_vacuum_states(
+async def test_activitys(


Suggested change

async def test_activitys(

async def test_activities(

home-assistant bot added cla-signed code-quality core deprecation Indicates a breaking change to happen in the future integration: vacuum Quality Scale: internal labels Sep 20, 2024

frenck added this to the 2024.11.0b0 milestone Sep 26, 2024

gjohansson-ST force-pushed the vacuum-state-is-enum branch from 53b4f99 to ea93289 Compare October 13, 2024 12:21

gjohansson-ST mentioned this pull request Oct 13, 2024

Fix state for litterrobot #128297

Merged

19 tasks

gjohansson-ST force-pushed the vacuum-state-is-enum branch from b303d63 to 42b5633 Compare October 13, 2024 14:33

gjohansson-ST mentioned this pull request Oct 13, 2024

Add new vacuum state property and enum home-assistant/developers.home-assistant#2360

Open

5 tasks

gjohansson-ST force-pushed the vacuum-state-is-enum branch from 42b5633 to 179c0c0 Compare October 13, 2024 15:45

gjohansson-ST marked this pull request as ready for review October 13, 2024 15:45

gjohansson-ST requested review from rytilahti, syssi, starkillerOG, a team, frenck, Santobert, emontnemery, jbouwh, bdraco, mib1185, edenhaus and ochlocracy as code owners October 13, 2024 15:45

gjohansson-ST marked this pull request as draft October 17, 2024 19:36

gjohansson-ST force-pushed the vacuum-state-is-enum branch from 179c0c0 to a30b643 Compare October 21, 2024 15:55

gjohansson-ST marked this pull request as ready for review October 21, 2024 16:18

MartinHjelmare removed this from the 2024.11.0b0 milestone Oct 30, 2024

gjohansson-ST added 13 commits November 11, 2024 20:13

Implement new state property for vacuum which is using an enum

9fd9d1f

Mod

76574b5

Mod init

2c3c9f0

Mods

8ca4097

Fix integrations

ea2055c

Tests

d638a3b

Fix state

1026758

Add vacuum tests

82aa779

Fix last test

ae64169

Litterrobot tests

2bc1b6b

Fixes

aef1364

Tests

3cfef0c

Fixes

4caaaf8

gjohansson-ST force-pushed the vacuum-state-is-enum branch from fd387a2 to 4caaaf8 Compare November 11, 2024 20:14

gjohansson-ST added 10 commits November 11, 2024 20:26

Fix VacuumEntity

9a9673a

Mods

e4835a3

Mods

02f496f

Mods

6b50da1

Update demo

f832cac

Mod roomba

e53d165

LG

3ec0704

Fix vacuum

bb4f13f

Fix Matter

c1581bc

Fix deprecation version

10a6f22

gjohansson-ST marked this pull request as ready for review November 12, 2024 16:20

gjohansson-ST requested a review from a team as a code owner November 12, 2024 16:20

home-assistant bot requested a review from MartinHjelmare November 12, 2024 16:20

Mods

7e487f9

MartinHjelmare requested changes Nov 25, 2024

View reviewed changes

home-assistant bot marked this pull request as draft November 25, 2024 16:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement new state property for vacuum which is using an enum #126353

Implement new state property for vacuum which is using an enum #126353

gjohansson-ST commented Sep 20, 2024 •

edited

Loading

home-assistant bot commented Sep 20, 2024

MartinHjelmare Nov 25, 2024

MartinHjelmare Nov 25, 2024

MartinHjelmare Nov 25, 2024

MartinHjelmare Nov 25, 2024

MartinHjelmare Nov 25, 2024

MartinHjelmare Nov 25, 2024 •

edited

Loading

MartinHjelmare Nov 25, 2024

		_DEPRECATED_STATE_ERROR = DeprecatedConstantEnum(VacuumActivity.ERROR, "2025.12")


		STATES = [cls.value for cls in VacuumActivity]

Implement new state property for vacuum which is using an enum #126353

Are you sure you want to change the base?

Implement new state property for vacuum which is using an enum #126353

Conversation

gjohansson-ST commented Sep 20, 2024 • edited Loading

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Sep 20, 2024

MartinHjelmare Nov 25, 2024

Choose a reason for hiding this comment

MartinHjelmare Nov 25, 2024

Choose a reason for hiding this comment

MartinHjelmare Nov 25, 2024

Choose a reason for hiding this comment

MartinHjelmare Nov 25, 2024

Choose a reason for hiding this comment

MartinHjelmare Nov 25, 2024

Choose a reason for hiding this comment

MartinHjelmare Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

MartinHjelmare Nov 25, 2024

Choose a reason for hiding this comment

gjohansson-ST commented Sep 20, 2024 •

edited

Loading

MartinHjelmare Nov 25, 2024 •

edited

Loading