ZWaveJS: Support for Door Lock in Expert UI #22775

MindFreeze · 2024-11-11T10:47:09Z

Proposed change

The validation doesn't give much feedback to the user but I think this is enough for the purpose of this form.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (thank you!)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example configuration

Additional information

This PR fixes or closes issue: fixes Add controls for Door Lock CC to expert UI zwave-js/certification-backlog#48
This PR is related to issue or discussion:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
There is no commented out code in this PR.
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

coderabbitai · 2024-11-11T10:47:17Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

MindFreeze · 2024-11-11T10:58:23Z

@AlCalzone do you have a lock to test this?

AlCalzone

I don't see why it happens, but if the operation mode is set to Timed, lockTimeoutConfiguration is not actually set in the configuration object sent to Z-Wave JS.

...ons/integration-panels/zwave_js/capability-controls/zwave_js-capability-control-door-lock.ts

…ability-controls/zwave_js-capability-control-door-lock.ts Co-authored-by: AlCalzone <[email protected]>

AlCalzone · 2024-11-11T13:55:49Z

The call now goes through, but it looks like the same change is needed for the toggles as well.

...ons/integration-panels/zwave_js/capability-controls/zwave_js-capability-control-door-lock.ts

AlCalzone · 2024-11-11T14:19:13Z

With my last suggestion, the first half of the certification test passes. The second half simulates an older device and runs into an error because the unsupported command getCapabilities is used.
We should rely on the information the driver has cached after the interview rather than quering capabilities again.

…ability-controls/zwave_js-capability-control-door-lock.ts Co-authored-by: AlCalzone <[email protected]>

AlCalzone · 2024-11-11T14:27:11Z

...ons/integration-panels/zwave_js/capability-controls/zwave_js-capability-control-door-lock.ts

+      const capabilities = await invokeZWaveCCApi<DoorLockCapabilities | null>(
+        this.hass,
+        this.device.id,
+        this.command_class,
+        this.endpoint,
+        "getCapabilities",
+        [],
+        true
+      );


This call can throw with an error code ZWaveErrorCodes.CC_NotSupported if the getCapabilities command isn't supported by the device (i.e. if it's an older lock).

We need to catch that case and assume that autoRelock, holdAndRelease, twistAssist and blockToBlock are not supported.
The cleaner way would be to ask the driver for its cached information, but this isn't exposed yet: zwave-js/node-zwave-js#7388

Also in the error case, these door lock modes should be assumed to be supported:

Do we need to support get/set mode in the expert UI? I left it out because it's not part of getConfiguration/setConfiguration. I can add it with extra requests for the mode

No, just setting is enough for certification. Getting wouldn't hurt, but you do that anyways on load if I'm not mistaken?

Added a select for the mode with validation for the mode.
For get there is currentMode and targetMode. I used currentMode but please correct me if this is wrong.
It defaults to Unsecured 0x00 when the driver doesn't return the mode on get. Maybe it should be Unknown 0xfe but this value is not in the above list so I set it to 0 for now.

AlCalzone

Test passed ✅

AlCalzone · 2024-11-14T08:38:05Z

Oh sorry, I think there was a misunderstanding. We don't have to control the lock mode in the expert UI, we already have proper lock and select entities for that.

I thought you meant getting the current configuration, since the expert UI only lets users set it.

MindFreeze · 2024-11-14T08:41:25Z

Well we have it now. And I saw that we are required to not allow timed modes for non timed operation, so I think it's good to have them together like this and validate

ZWaveJS: Support for Door Lock in Expert UI

160e265

home-assistant bot added the cla-signed label Nov 11, 2024

MindFreeze added 2 commits November 11, 2024 12:52

make it dry

1d5617a

Merge remote-tracking branch 'origin/dev' into zwave_door_lock

e688790

MindFreeze added the integration: zwave_js label Nov 11, 2024

AlCalzone suggested changes Nov 11, 2024

View reviewed changes

...ons/integration-panels/zwave_js/capability-controls/zwave_js-capability-control-door-lock.ts Outdated Show resolved Hide resolved

MindFreeze and others added 2 commits November 11, 2024 15:04

Update src/panels/config/integrations/integration-panels/zwave_js/cap…

e003186

…ability-controls/zwave_js-capability-control-door-lock.ts Co-authored-by: AlCalzone <[email protected]>

add validation

5679213

fix booleans

cca31ac

MindFreeze marked this pull request as ready for review November 11, 2024 13:59

AlCalzone reviewed Nov 11, 2024

View reviewed changes

...ons/integration-panels/zwave_js/capability-controls/zwave_js-capability-control-door-lock.ts Outdated Show resolved Hide resolved

Update src/panels/config/integrations/integration-panels/zwave_js/cap…

29ca68e

…ability-controls/zwave_js-capability-control-door-lock.ts Co-authored-by: AlCalzone <[email protected]>

AlCalzone reviewed Nov 11, 2024

View reviewed changes

MindFreeze marked this pull request as draft November 11, 2024 14:27

handle ZWaveErrorCodes.CC_NotSupported for getCapabilities

797e133

AlCalzone approved these changes Nov 12, 2024

View reviewed changes

get/set mode

1a0a070

MindFreeze marked this pull request as ready for review November 14, 2024 06:37

Merge remote-tracking branch 'origin/dev' into zwave_door_lock

97b79e0

MindFreeze enabled auto-merge (squash) November 14, 2024 06:39

bramkragten self-assigned this Nov 20, 2024

bramkragten approved these changes Nov 20, 2024

View reviewed changes

MindFreeze merged commit 46a5563 into dev Nov 20, 2024
15 checks passed

MindFreeze deleted the zwave_door_lock branch November 20, 2024 11:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ZWaveJS: Support for Door Lock in Expert UI #22775

ZWaveJS: Support for Door Lock in Expert UI #22775

MindFreeze commented Nov 11, 2024 •

edited

Loading

coderabbitai bot commented Nov 11, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

MindFreeze commented Nov 11, 2024

AlCalzone left a comment

AlCalzone commented Nov 11, 2024

AlCalzone commented Nov 11, 2024

AlCalzone Nov 11, 2024 •

edited

Loading

AlCalzone Nov 11, 2024

MindFreeze Nov 11, 2024

AlCalzone Nov 12, 2024

MindFreeze Nov 14, 2024

AlCalzone left a comment

AlCalzone commented Nov 14, 2024

MindFreeze commented Nov 14, 2024

ZWaveJS: Support for Door Lock in Expert UI #22775

ZWaveJS: Support for Door Lock in Expert UI #22775

Conversation

MindFreeze commented Nov 11, 2024 • edited Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

coderabbitai bot commented Nov 11, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

MindFreeze commented Nov 11, 2024

AlCalzone left a comment

Choose a reason for hiding this comment

AlCalzone commented Nov 11, 2024

AlCalzone commented Nov 11, 2024

AlCalzone Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

AlCalzone Nov 11, 2024

Choose a reason for hiding this comment

MindFreeze Nov 11, 2024

Choose a reason for hiding this comment

AlCalzone Nov 12, 2024

Choose a reason for hiding this comment

MindFreeze Nov 14, 2024

Choose a reason for hiding this comment

AlCalzone left a comment

Choose a reason for hiding this comment

AlCalzone commented Nov 14, 2024

MindFreeze commented Nov 14, 2024

MindFreeze commented Nov 11, 2024 •

edited

Loading

coderabbitai bot commented Nov 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

AlCalzone Nov 11, 2024 •

edited

Loading