Fix ZHA wrong cover states #99646

GuillaumeB-GitHub · 2023-09-04T22:51:47Z

Proposed change

Bug Fix : #98933
Currently, the function async_set_position in the class ZhaCover is not able to manage the case when the cover reaches the desired position, causing the state to stay as Opening or Closing. Any final position that is not 0 should set the state to Open.
This fix saves the requested position so ZHA can know when the requested position has been reached and change the state to Open. Note that we need to clear that requested position when the set positon feature is not used to avoid conflicts when using the Open/Close/Stop features.

Type of change

Dependency upgrade
[X ] 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 ZHA : Cover states stays as Opening or Closing when using Set position #98933

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-09-04T22:51:50Z

Hi @GuillaumeB-GitHub

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

home-assistant · 2023-09-04T22:51:54Z

Hey there @dmulcahey, @Adminiuga, @puddly, mind taking a look at this pull request as it has been labeled with an integration (zha) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of zha 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 zha Removes the current integration label and assignees on the pull request, add the integration domain after the command.

javicalle

Not tested myself, but I believe that this will not cover all cases.

javicalle · 2023-09-08T07:56:15Z

homeassistant/components/zha/cover.py

-        new_pos = kwargs[ATTR_POSITION]
-        res = await self._cover_cluster_handler.go_to_lift_percentage(100 - new_pos)
+        self._requested_position = 100 - kwargs[ATTR_POSITION]
+        res = await self._cover_cluster_handler.go_to_lift_percentage(
+            self._requested_position
+        )
        if res[1] is not Status.SUCCESS:
            raise HomeAssistantError(f"Failed to set cover position: {res[1]}")
        self.async_update_state(
-            STATE_CLOSING if new_pos < self._current_position else STATE_OPENING
+            STATE_CLOSING
+            if self._requested_position < self._current_position
+            else STATE_OPENING


It seems to me that something is wrong here.

The old new_pos gets 0-100 values.

The new _requested_position gets 100-0 values (100 - new_pos)

Then in the async_update_state the condition has changed this way:

old way: new_pos < self._current_position (ie: 80 < 50)

new way: _requested_position < self._current_position (ie: if new_pos=80, _requested_position=20; 20 < 50)

I don't see how this can work after change.

Thanks for pointing this out. I got confused between _current_position that takes 0 to 100 and go_to_lift_percentage which is the opposite.
I updated this so _requested_position is set in the same way as _current_position and can be compared.

javicalle · 2023-09-08T08:03:06Z

homeassistant/components/zha/cover.py

+        elif (
+            self._requested_position
+            and self._current_position == self._requested_position
+        ):
+            self._state = STATE_OPEN


I believe that some covers are reporting discrete values. In these devices, when you require (ie) a set_position=70 the cover moves to position but it reports (ie) a current_position=69.
If you raise a little more, maybe you get a current_position=75, but you can get all the 0-100 values.

For these devices this approach would not fix the issue.

I agree that this approach won't be good for the devices you mentioned, though, isn't it the point of the quirks to fix the issues related to specific products ? ZHA should only consider the generic case where the blind is sending back the requested position. I don't really see the point of having all the blinds in the wrong state just to avoid some being in the wrong state.

So far the devices I have seen can't move that exact (typically not a stepper motor) They stop in a range of +/- 1 or 2 for the position, depending on whether they are moving up or down. So you could easily improve it by comparing/allowing the requested position in a small range.
BUT: I don't get the logic here at all! Why should a requested_position=2 (almost fully closed) considered as STATE_OPEN ?

I think 0 is closed and anything else is considered open.

This is adding extra functionality to the existing cover logic, where previously it just retained the same state as before if the position was anything but completely open or completely closed, which I think is fine.

@m67hoff Ideally, we would like to have a state Partly_Open which would be anything between Close and Open, but that states doesn't exist. That's why, even opened at 2%, a blind is still Open and not Close.

cremor · 2023-10-25T06:43:45Z

Will this PR also fix the problem that the cover state only reports "opening" or "closing" when triggered by HA commands, but not when triggered by the device itself (e.g. by pressing the hardwired buttons on the device)?

GuillaumeB-GitHub · 2023-12-07T06:58:35Z

Will this PR also fix the problem that the cover state only reports "opening" or "closing" when triggered by HA commands, but not when triggered by the device itself (e.g. by pressing the hardwired buttons on the device)?

I'm not sure. It all depends on what your device is sending back to HA for its position.

cremor · 2023-12-07T07:12:43Z

I don't know the technical details, but the cover position is correctly updated in HA. So the device sends the positions. But HA doesn't recognize that position values that are going down means that the cover is closing.

Hedda · 2023-12-20T13:22:54Z

For reference also check out this draft PR for an alternative solution where tomasbedrich is asking for feedback -> #105467

github-actions · 2024-02-18T14:04:47Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

Hedda · 2024-02-29T09:02:30Z

@GuillaumeB-GitHub any updates on this?

GuillaumeB-GitHub · 2024-03-01T06:53:15Z

Hi,

I rebased but I think that MR is going to be useless when the MR #108238 is pushed to production. Looking at the code, I think the changes in the code will fixed that bug. Looking at the below function, we can see that the state is set to CLOSE only if the position is 100, otherwise it's OPEN, which is what we want.

It's tagged to the version 2024.3.0b3, so I'm guessing this is going to be released soon. If that version fixes the problem, I'll close that MR.

clssn · 2024-03-19T08:10:56Z

Duplicate of #102072 which has been merged on October 24th, 2023. This one should be closed.

Hedda · 2024-03-19T08:59:03Z

Duplicate of #102072 which has been merged on October 24th, 2023.

Is it really? #102072 added ZHA cover tilt support, while #99646 fixes wrong cover states in ZHA

cremor · 2024-03-19T09:00:14Z

Yeah, not a duplicate of that. Cover states are something completely different than cover tilt.

GuillaumeB-GitHub · 2024-03-25T01:48:12Z

I can confirm that the latest update fixed the issue reported in that MR (ie: blind states staying at opening or closing if not set to fully opened or fully closed) I'm closing this MR.

GuillaumeB-GitHub requested review from dmulcahey, Adminiuga and puddly as code owners September 4, 2023 22:51

home-assistant bot added bugfix cla-needed integration: zha small-pr PRs with less than 30 lines. labels Sep 4, 2023

home-assistant bot assigned dmulcahey, Adminiuga and puddly Sep 4, 2023

home-assistant bot added the Quality Scale: No score label Sep 4, 2023

GuillaumeB-GitHub mentioned this pull request Sep 4, 2023

ZHA : Cover states stays as Opening or Closing when using Set position #98933

Closed

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Sep 4, 2023

MartinHjelmare changed the title ~~Fix ZHA wrong cover states (#98933)~~ Fix ZHA wrong cover states Sep 6, 2023

javicalle reviewed Sep 8, 2023

View reviewed changes

javicalle mentioned this pull request Sep 8, 2023

[Device Support Request] TuyaMoesCover0601 always stuck in opening/closing zigpy/zha-device-handlers#2562

Closed

javicalle mentioned this pull request Sep 24, 2023

[BUG] Curtain motor _TZE200_r0jdjrvi has no entities zigpy/zha-device-handlers#1953

Open

puddly mentioned this pull request Oct 16, 2023

Add ZHA cover tilt #102072

Merged

20 tasks

TheJulianJES mentioned this pull request Oct 17, 2023

Add Xiaomi E1 driver curtain support zigpy/zha-device-handlers#2629

Merged

3 tasks

tomasbedrich mentioned this pull request Dec 10, 2023

Fix ZHA cover state #105467

Closed

20 tasks

Hedda mentioned this pull request Dec 20, 2023

[Device Support Request] Insta GmbH Nexentro Blinds Actuator Mini zigpy/zha-device-handlers#1397

Closed

TheJulianJES mentioned this pull request Jan 21, 2024

ZHA not updating HomeKit status for FYRTUR cover #108046

Closed

github-actions bot added stale and removed stale labels Feb 18, 2024

Fix ZHA wrong cover states (home-assistant#98933)

993c4ed

GuillaumeB-GitHub force-pushed the fix_cover_state_when_use_set_position branch from 3bafaac to 993c4ed Compare March 1, 2024 06:45

GuillaumeB-GitHub requested a review from TheJulianJES as a code owner March 1, 2024 06:45

GuillaumeB-GitHub closed this Mar 25, 2024

github-actions bot locked and limited conversation to collaborators Mar 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix ZHA wrong cover states #99646

Fix ZHA wrong cover states #99646

GuillaumeB-GitHub commented Sep 4, 2023

home-assistant bot commented Sep 4, 2023

home-assistant bot commented Sep 4, 2023

javicalle left a comment

javicalle Sep 8, 2023

GuillaumeB-GitHub Sep 18, 2023

javicalle Sep 8, 2023

GuillaumeB-GitHub Sep 18, 2023

m67hoff Oct 11, 2023

puddly Oct 16, 2023

GuillaumeB-GitHub Dec 8, 2023

cremor commented Oct 25, 2023

GuillaumeB-GitHub commented Dec 7, 2023

cremor commented Dec 7, 2023

Hedda commented Dec 20, 2023

github-actions bot commented Feb 18, 2024

Hedda commented Feb 29, 2024

GuillaumeB-GitHub commented Mar 1, 2024

clssn commented Mar 19, 2024

Hedda commented Mar 19, 2024

cremor commented Mar 19, 2024

GuillaumeB-GitHub commented Mar 25, 2024

Fix ZHA wrong cover states #99646

Fix ZHA wrong cover states #99646

Conversation

GuillaumeB-GitHub commented Sep 4, 2023

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Sep 4, 2023

home-assistant bot commented Sep 4, 2023

javicalle left a comment

Choose a reason for hiding this comment

javicalle Sep 8, 2023

Choose a reason for hiding this comment

GuillaumeB-GitHub Sep 18, 2023

Choose a reason for hiding this comment

javicalle Sep 8, 2023

Choose a reason for hiding this comment

GuillaumeB-GitHub Sep 18, 2023

Choose a reason for hiding this comment

m67hoff Oct 11, 2023

Choose a reason for hiding this comment

puddly Oct 16, 2023

Choose a reason for hiding this comment

GuillaumeB-GitHub Dec 8, 2023

Choose a reason for hiding this comment

cremor commented Oct 25, 2023

GuillaumeB-GitHub commented Dec 7, 2023

cremor commented Dec 7, 2023

Hedda commented Dec 20, 2023

github-actions bot commented Feb 18, 2024

Hedda commented Feb 29, 2024

GuillaumeB-GitHub commented Mar 1, 2024

clssn commented Mar 19, 2024

Hedda commented Mar 19, 2024

cremor commented Mar 19, 2024

GuillaumeB-GitHub commented Mar 25, 2024