Add documentation for Z-Wave credential management#45119
Add documentation for Z-Wave credential management#45119AlCalzone wants to merge 2 commits intohome-assistant:nextfrom
Conversation
home-assistant
Bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds documentation to the Z-Wave JS integration page for the new user/credential management actions that underpin the in-progress credential management feature (core PR home-assistant/core#168360).
Changes:
- Documented new “user and credential management” actions (set/delete users, query capabilities/users, set/delete credentials).
- Added capability/user type/credential type reference tables and YAML usage examples.
- Positioned the new docs alongside the existing legacy lock usercode actions.
| The `zwave_js.set_user` action creates or updates a user on the lock. If you omit `user_id`, the integration assigns the first available slot. The action returns the assigned `user_id`. | ||
|
|
||
| | Data attribute | Required | Description | | ||
| | ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `user_id` | no | User slot index (1-based). Defaults to the first available slot. | | ||
| | `user_name` | no | Display name for the user. Maximum length is reported by `get_credential_capabilities`. When omitted, the existing name is preserved on update or left empty on create. | | ||
| | `user_type` | no | Type of user to create. See [user types](#user-types) below. Defaults to the existing value on update, or `general` on create. | | ||
| | `credential_rule` | no | How many credentials must be presented to unlock. One of `single`, `dual`, or `triple`. Defaults to the existing value on update, or the lock's default (typically `single`) on create. | | ||
| | `active` | no | Whether the user is active. Inactive users exist on the lock but cannot unlock with their credentials until reactivated. Defaults to `true`. | |
There was a problem hiding this comment.
The data-attribute tables for these new actions don’t document how to target the lock (for example, entity_id), even though every other action on this page includes target selection in the table and your YAML examples rely on target.entity_id. To avoid confusion, document the targeting fields (or add a short sentence stating these actions must be called with a lock target, consistent with other action docs here).
c0ffeeca7
left a comment
c0ffeeca7
left a comment
There was a problem hiding this comment.
For set_user, set_credential, get_credential_capabilities, would it be worth adding a response example, like https://github.com/home-assistant/home-assistant.io/pull/45119/changes#diff-834a19fc622b88161ff1f89bf5abed6f1000f0f064170c77ecebda5e688fb042L759.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Proposed change
This PR adds documentation for new actions in the Z-Wave integration that serve as the foundation for the work-in-progress credential management feature.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.