Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do optimistic state update for Z-Wave multilevel switch entities #90490

Merged
merged 11 commits into from
May 24, 2023

Conversation

raman325
Copy link
Contributor

@raman325 raman325 commented Mar 30, 2023

Proposed change

In this PR we do optimistic state updates for all Z-Wave Multilevel Switch CC based entities except for the cover entity - because we don't track is_closing and is_opening for Multilevel Switch covers, I don't think there is any optimistic state to set (if #90492 gets merged then I can add optimistic state update support for covers in this PR).

Before I add tests I wanted to put up the implementation for review to make sure I understood the problem correctly.

Resolves #90399

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 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:

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:

@home-assistant
Copy link

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

Code owner commands

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

@raman325 raman325 marked this pull request as draft March 30, 2023 05:57
@MartinHjelmare
Copy link
Member

Looks good, I think.

@AlCalzone is it correct that Multilevel Switch CC is the only command class where we need the optimistic update?

@AlCalzone
Copy link
Contributor

Turning a multilevel switch on (with no known target value) is the only one that comes to mind. All others should automatically get optimistic value updates from the driver.

@raman325
Copy link
Contributor Author

Turning a multilevel switch on (with no known target value) is the only one that comes to mind. All others should automatically get optimistic value updates from the driver.

So does this issue only occur when we send 255? Right now this PR is set to do optimistic updates for all values sent

@kpine
Copy link
Contributor

kpine commented Mar 30, 2023

If it's simpler, should only be necessary to do for 255, the driver provides optimistic state update for the others. That's what I did for a POC I tried, and it worked well.

@raman325
Copy link
Contributor Author

we can only cover lights and fans because they are toggle entities. For covers, numbers, and selects, we don't know the previous state. We could store it if needed but I think lights and fans were primarily where the problem was anyway

@MartinHjelmare
Copy link
Member

Looks good.

@raman325 raman325 marked this pull request as ready for review April 1, 2023 19:05
@raman325 raman325 merged commit 66f7218 into home-assistant:dev May 24, 2023
@raman325 raman325 deleted the optimistic branch May 24, 2023 13:04
@github-actions github-actions bot locked and limited conversation to collaborators May 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Do optimistic state update for Z-Wave multilevel switch entities
4 participants