Add support for Z-Wave credential management#168360
Merged
Merged
Conversation
home-assistant
Bot
added
cla-signed
has-tests
integration: zwave_js
Top 100
Contributor
|
Hey there @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
13 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Introduces first-pass Z-Wave JS “Access Control” (credential/user) management via new lock entity services, helper logic, and accompanying UI strings/icons plus tests.
Changes:
- Add
access_control_helpers.pyimplementing user/credential CRUD, capability queries, and auto-slot selection. - Register new credential-management services and wire them through the Z-Wave lock entity.
- Add service UI metadata (strings/icons/services.yaml) and initial test coverage.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
homeassistant/components/zwave_js/access_control_helpers.py |
New helper module implementing access-control business logic and structured service responses. |
homeassistant/components/zwave_js/lock.py |
Adds lock entity methods for new access-control services with translated error wrapping. |
homeassistant/components/zwave_js/services.py |
Registers new platform entity services and validates service schemas. |
homeassistant/components/zwave_js/services.yaml |
Declares new services and selectors for the service UI. |
homeassistant/components/zwave_js/strings.json |
Adds translated error messages and service field descriptions for credential management. |
homeassistant/components/zwave_js/icons.json |
Adds service icons for the new credential/user services. |
homeassistant/components/zwave_js/const.py |
Adds service/attribute constants and credential/user type string constants. |
tests/components/zwave_js/test_credential_services.py |
Adds tests for new credential management services and auto-find behavior. |
AlCalzone
changed the title
AlCalzone
force-pushed
the
zwave-credentials
branch
from
April 27, 2026 11:29
7a16119 to
69b377e
Compare
This comment was marked as resolved.
This comment was marked as resolved.
8 tasks
Comment on lines
+82
to
+86
| async_register_platform_entity_service( | ||
| hass, | ||
| const.DOMAIN, | ||
| "set_user", | ||
| entity_domain=LOCK_DOMAIN, |
Contributor
Author
There was a problem hiding this comment.
No, Martin said explicitly to not do that.
@abmantis something for the agent instructions maybe?
Member
There was a problem hiding this comment.
I don't think we need to add this to instructions, unless we see it happen more often (I haven't seen it before). It probably pointed it out because the integration does that for the other service and the new ones are inconsistent.
MartinHjelmare
marked this pull request as draft
May 13, 2026 13:00
Comment on lines
+765
to
+766
| "١٢٣٤", # Arabic-Indic digits — str.isdigit() returns True | ||
| "１２３４", # Fullwidth digits — str.isdigit() returns True |
Member
There was a problem hiding this comment.
Ok to add, but not required.
Contributor
Author
|
The test failure looks unrelated |
Member
|
One question left: |
MartinHjelmare
marked this pull request as draft
May 19, 2026 08:48
AlCalzone
marked this pull request as ready for review
May 19, 2026 13:26
| max: 65535 | ||
| step: 1 | ||
| mode: box | ||
| user_name: |
Member
There was a problem hiding this comment.
Could be good to add, but not required.
flz
pushed a commit
to flz/home-assistant
that referenced
this pull request
May 20, 2026
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed change
This PR adds support for Z-Wave credential management. This first iteration is aligned with the Matter credential mangement added in #161936, home-assistant/frontend#28672 and followup PRs.
The main difference is that this PR also adds support for having multiple credentials of the same type per user, and distinguishes between PINs (0-9) and passwords (alphanumeric).
Like Matter, we expose the credential management through the
lockentity. Even though the functionality is technically not limited to locks, in practice there haven't been any non-lock devices with user management features.Depends on home-assistant-libs/zwave-js-server-python#1418
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: