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

Fix zwave_js discovery logic for node device class #117232

Merged
merged 2 commits into from
May 11, 2024

Conversation

raman325
Copy link
Contributor

Proposed change

We discovered a bug in the device class portion of the async_discover_single_value validation checks. A node with a null device class and a Multilevel Switch CC currentValue value should be discovered as a light, but it was being discovered as a cover. This is because the cover and light discovery schemas watch for the same value, but the cover schema requires the node to have particular device classes. Since the node's device class was None, the device class check was being skipped, which meant that in this scenario, the cover and light discovery schemas were effectively identical. Because cover is first in the list, it became the new discovery schema to match the value when it should have been a light.

There seems to have been a change in the driver that results in deviceClass being None in more scenarios. I'll log an issue in the node-zwave-js repo. CC @AlCalzone

The test I added fails before this fix and passes after.

Thanks @kpine for tracking down the culprit(s) of this issue!

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

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:

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.
  • @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.

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft May 11, 2024 07:25
@raman325 raman325 marked this pull request as ready for review May 11, 2024 14:06
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@MartinHjelmare MartinHjelmare merged commit 9655db3 into home-assistant:dev May 11, 2024
24 checks passed
dgomes pushed a commit to dgomes/home-assistant that referenced this pull request May 11, 2024
…7232)

* Fix zwave_js discovery logic for node device class

* simplify check
@raman325 raman325 deleted the device_class branch May 12, 2024 02:57
@github-actions github-actions bot locked and limited conversation to collaborators May 13, 2024
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.

ZWave devices changed from switch / light to window cover
3 participants