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.

Sign up for GitHub

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

Jump to bottom

Add zwave config parameter entities #92223

Merged
merged 9 commits into from May 30, 2023
Merged

Add zwave config parameter entities #92223

merged 9 commits into from May 30, 2023

Conversation

raman325
Copy link
Contributor

@raman325 raman325 commented Apr 29, 2023 •
edited

Breaking change

For devices with the Entry control generic device class, the Door lock mode config parameter no longer gets created as a sensor entity and will instead get created as a select entity.

Proposed change

In this PR we add config parameter entities for all devices which are disabled by default. The only config parameters that are not represented are ones where writeable is True and readable is False because there is no good entity type to represent those and the zwave_js.set_config_parameter service is probably the best way to manage those still.

I was also able to improve existing coverage by doing some refactoring of the classes and subclasses to avoid duplicate logic, plus the config parameter sensors end up covering more code paths for e.g. sensors

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:

@raman325 raman325 requested a review from a team as a code owner April 29, 2023 06:18
@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.

This was referenced Apr 29, 2023
Open
Closed
@raman325 raman325 marked this pull request as draft April 30, 2023 08:02
@raman325
Merge branch 'dev' of https://github.com/home-assistant/core into con…
8a12be7 
…fig_parameter

* 'dev' of https://github.com/home-assistant/core: (390 commits)
  Use snapshots in devolo_home_control tests (home-assistant#93202)
  Configurable KNX Telegram history size (home-assistant#93248)
  Bugfix and add test coverage for zwave_js.light (home-assistant#93257)
  Refactor zwave_js.fan and add tests (home-assistant#93256)
  Bugfix and small refactor for zwave_js.device_action (home-assistant#93261)
  Refactor zwave_js.sensor and add test coverage (home-assistant#93259)
  Improve test coverage for zwave_js.trigger (home-assistant#93260)
  Fix august configuration url with Yale Home brand (home-assistant#93361)
  Make mqtt device_tracker state_topic optional when json_attribute_topic is used (home-assistant#93322)
  Move HydrawiseEntity into entity.py (home-assistant#93359)
  Update Home Assistant base image to 2023.05.0 (home-assistant#93350)
  Adjust counter to not restore configuration parameters (home-assistant#93344)
  Deprecate counter.configure service (home-assistant#93343)
  Update zwave-me-ws version to 0.4.3 (home-assistant#93348)
  Add myself as a code owner of the Hydrawise integration (home-assistant#93358)
  Move Hydrawise constants into const.py (home-assistant#93357)
  Improve test coverage for zwave_js (home-assistant#93262)
  Add advanced imap option to set custom event max message size (home-assistant#93163)
  Bump zwave-js-server-python to 0.48.1 (home-assistant#93342)
  Bump `aionotion` to 2023.05.5 (home-assistant#93334)
  ...
@raman325
Remove unused entity const
6a65efb
@raman325 raman325 marked this pull request as ready for review May 22, 2023 16:47
MartinHjelmare
MartinHjelmare reviewed May 29, 2023
View reviewed changes
homeassistant/components/zwave_js/const.py Outdated Show resolved Hide resolved
homeassistant/components/zwave_js/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/zwave_js/switch.py Outdated Show resolved Hide resolved
MartinHjelmare
MartinHjelmare requested changes May 30, 2023
View reviewed changes
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.

Just a comment about the special values.

@home-assistant home-assistant bot marked this pull request as draft May 30, 2023 10:00
@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.

@raman325 raman325 marked this pull request as ready for review May 30, 2023 14:48
MartinHjelmare
MartinHjelmare approved these changes May 30, 2023
View reviewed changes
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.

Just needs a test adjustment.

@raman325 raman325 merged commit 65187c6 into home-assistant:dev May 30, 2023
23 of 24 checks passed
@raman325 raman325 deleted the config_parameter branch May 30, 2023 15:49
@github-actions github-actions bot locked and limited conversation to collaborators May 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@MartinHjelmare MartinHjelmare MartinHjelmare approved these changes

Assignees
No one assigned
Labels
breaking-change cla-signed has-tests integration: zwave_js new-feature Quality Scale: No score
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@raman325 @MartinHjelmare