Check supported features in calls to vacuum services #95833

emontnemery · 2023-07-04T08:36:20Z

Proposed change

Check supported features in calls to vacuum services

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: Add blog post about recent vacuum changes developers.home-assistant#1833

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 Black (black --fast 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.
Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

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

home-assistant · 2023-07-04T08:36:27Z

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.

homeassistant/components/vacuum/__init__.py

jbouwh

LGTM,
Thnx @emontnemery 👍

MartinHjelmare

Thanks!

MartinHjelmare · 2023-07-05T10:55:46Z

We should do a developer blog too for custom integrations.

Go ahead and merge when all affected core integrations are handled.

emontnemery · 2023-07-05T14:43:25Z

Go ahead and merge when all affected core integrations are handled.

I have reviewed and double reviewed the core integrations, and I believe they all set the feature flags correctly 👍

xeniter

try to clear up confusion deprecated VacuumEntity and StateVacuumEntity
specially for defines what are the vacuums supporting

xeniter · 2023-07-05T19:13:20Z

homeassistant/components/vacuum/__init__.py

@@ -77,19 +77,19 @@
 class VacuumEntityFeature(IntFlag):
    """Supported features of the vacuum entity."""

-    TURN_ON = 1
-    TURN_OFF = 2
+    TURN_ON = 1  # Deprecated, not supported by StateVacuumEntity


why not remove it to avoid confusion?

there are only 3 lefts which are not StateVacuumEntity) if i count right:

StateVacuumEntity
demo
litterrobot
mqtt
neato
roborock
romy
roomba
sharkiq
template
tuya
xiaommmmi_miio

VacuumEntity (wich is deprecated)
demo
mqtt
ecovacs

cause demo does not count and mqtt is generic, only ecovacs will be hard to test after porting?
at least i would mark the demo and the class VacuumEntity

personal i would prefer removing VacuumEntity completly don't know side effects/effort here but it would help a lot for new vacuum implementation that they don't get confused

xeniter · 2023-07-05T19:47:38Z

homeassistant/components/vacuum/__init__.py

    SEND_COMMAND = 256
    LOCATE = 512
    CLEAN_SPOT = 1024
    MAP = 2048
-    STATE = 4096
+    STATE = 4096  # Must be set by vacuum platforms derived from StateVacuumEntity
    START = 8192




can we remove this? cause the deprecated uses of VacuumEntity (demo, mqtt, ecovacs) uses the wrong define -> VacuumEntityFeature.TURN_ON anyhow

SUPPORT_TURN_ON:
is not used at all

SUPPORT_TURN_OFF:
is used only in test/components/alexa we should remove it since its for new StateVacuumEntity deprecated anyhow

SUPPORT_PAUSE:
used in test/components/alexa/test_smart_home.py -> we should change it to enum VacuumEntityFeature.PAUSE
used in test/components/google/test_trait.py -> we should change it to enum VacuumEntityFeature.PAUSE

SUPPORT_STOP:
used in test/components/alexa/test_smart_home.py -> we should change it to enum VacuumEntityFeature.SUPPORT_STOP
used in test/components/google/test_trait.py -> we should change it to enum VacuumEntityFeature.SUPPORT_STOP

SUPPORT_RETURN_HOME
used in test/components/alexa/test_smart_home.py -> we should change it to enum VacuumEntityFeature.RETURN_HOME
used in test/components/homekit/test_get_accessories.py -> we should change it to enum VacuumEntityFeature.RETURN_HOME

SUPPORT_FAN_SPEED
used in test/components/alexa/test_smart_home.py -> we should change it to enum VacuumEntityFeature.FAN_SPEED

SUPPORT_BATTERY
used in components/google_assistant/traits.py -> we should change it to enum VacuumEntityFeature.SUPPORT_BATTERY
used in test/components/google/test_trait.py -> we should change it to enum VacuumEntityFeature.SUPPORT_BATTERY

SUPPORT_STATUS -> not used at all
SUPPORT_SEND_COMMAND -> not used at all

SUPPORT_LOCATE
used in components/google_assistant/traits.py -> we should change it to enum VacuumEntityFeature.SUPPORT_LOCATE
used in test/components/google/test_trait.py -> we should change it to enum VacuumEntityFeature.SUPPORT_LOCATE

SUPPORT_CLEAN_SPOT -> not used at all
SUPPORT_MAP -> not used at all
SUPPORT_STATE -> not used at all

SUPPORT_START
used in test/components/alexa/test_smart_home.py -> we should change it to enum VacuumEntityFeature.START
used in test/components/homekit/test_get_accessories.py -> we should change it to enum VacuumEntityFeature.SUPPORT_START

can prepare a merge if you like?

Sure, please prepare a PR cleaning up the use of the deprecated constants

created: #96202

Check supported features in vacuum services

f3f0e36

emontnemery requested a review from a team as a code owner July 4, 2023 08:36

home-assistant bot added cla-signed core integration: vacuum by-code-owner Quality Scale: internal labels Jul 4, 2023

MartinHjelmare reviewed Jul 4, 2023

View reviewed changes

homeassistant/components/vacuum/__init__.py Show resolved Hide resolved

Update tests

e1a2773

emontnemery requested a review from jbouwh as a code owner July 4, 2023 10:06

jbouwh approved these changes Jul 4, 2023

View reviewed changes

Add comment

9c8da8b

jbouwh approved these changes Jul 4, 2023

View reviewed changes

emontnemery requested a review from MartinHjelmare July 4, 2023 14:31

frenck added the smash Indicator this PR is close to finish for merging or closing label Jul 5, 2023

MartinHjelmare approved these changes Jul 5, 2023

View reviewed changes

MartinHjelmare added the docs-missing label Jul 5, 2023

xeniter reviewed Jul 5, 2023

View reviewed changes

frenck removed the smash Indicator this PR is close to finish for merging or closing label Jul 8, 2023

xeniter mentioned this pull request Jul 9, 2023

Refactor vacuum entity constants with VacuumEntityFeature #96202

Closed

20 tasks

emontnemery removed the docs-missing label Jul 10, 2023

emontnemery merged commit 96c71b2 into dev Jul 10, 2023
51 checks passed

emontnemery deleted the vacuum_services_check_features branch July 10, 2023 11:05

jbouwh mentioned this pull request Jul 11, 2023

Cleanup unneeded MQTT vacuum feature check #96312

Merged

20 tasks

github-actions bot locked and limited conversation to collaborators Jul 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check supported features in calls to vacuum services #95833

Check supported features in calls to vacuum services #95833

emontnemery commented Jul 4, 2023 •

edited

home-assistant bot commented Jul 4, 2023

jbouwh left a comment

MartinHjelmare left a comment

MartinHjelmare commented Jul 5, 2023

emontnemery commented Jul 5, 2023 •

edited

xeniter left a comment

xeniter Jul 5, 2023

xeniter Jul 5, 2023

emontnemery Jul 5, 2023

xeniter Jul 9, 2023

Check supported features in calls to vacuum services #95833

Check supported features in calls to vacuum services #95833

Conversation

emontnemery commented Jul 4, 2023 • edited

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Jul 4, 2023

jbouwh left a comment

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

MartinHjelmare commented Jul 5, 2023

emontnemery commented Jul 5, 2023 • edited

xeniter left a comment

Choose a reason for hiding this comment

xeniter Jul 5, 2023

Choose a reason for hiding this comment

xeniter Jul 5, 2023

Choose a reason for hiding this comment

emontnemery Jul 5, 2023

Choose a reason for hiding this comment

xeniter Jul 9, 2023

Choose a reason for hiding this comment

emontnemery commented Jul 4, 2023 •

edited

emontnemery commented Jul 5, 2023 •

edited