Document new zwave js services get_lock_usercode and get_lock_usercodes

[holocronweaver]

Proposed change

Adds documentation for new Z-Wave JS services get_lock_usercode and get_lock_usercodes.

For details, see https://github.com/home-assistant/core/pull/119714

Type of change

• [ ] Spelling, grammar or other readability improvements (current branch).
• [ ] Adjusted missing or incorrect information in the current documentation (current branch).
• [ ] Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • [ ] I've opened up a PR to add logos and icons in Brands repository.
• [x] Added documentation for a new feature I'm adding to Home Assistant (next branch).
• [ ] Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/119714
• Fulfills feature request: https://community.home-assistant.io/t/z-wave-js-get-lock-usercode/731489

Checklist

• [x] This PR uses the correct branch, based on one of the following:
  • I made a change to the existing documentation and used the current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• New Features
  • Added zwave_js.get_lock_usercode service to retrieve the usercode for a specified code slot on a lock.
  • Added zwave_js.get_lock_usercodes service to retrieve all usercodes for a lock.

[coderabbitai[bot]]

Walkthrough

Walkthrough

The recent changes to the zwave_js integration introduce new services to retrieve usercodes from locks. These include zwave_js.get_lock_usercode for fetching a usercode from a specific code slot, and zwave_js.get_lock_usercodes to obtain all usercodes present in a lock. These additions enhance the management and interaction capabilities with lock usercodes, making automated access control more robust.

Changes

Files	Change Summary
source/_integrations/zwave_js.markdown	Added services zwave_js.get_lock_usercode and zwave_js.get_lock_usercodes with attributes and response data details.

---

Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between faa564f5b0af5c1566010cb9b5013a63f97ddf41 and 1c5cd6f4fda48133940864add7c208e2a4bb4ab8.

Files selected for processing (1)

• source/_integrations/zwave_js.markdown (1 hunks)

Additional context used

Markdownlint

source/_integrations/zwave_js.markdown

87-87: Expected: 1; Actual: 3; Style: 1/2/3 Ordered list item prefix

(MD029, ol-prefix)

---

88-88: Expected: 2; Actual: 4; Style: 1/2/3 Ordered list item prefix

(MD029, ol-prefix)

---

92-92: Expected: 3; Actual: 5; Style: 1/2/3 Ordered list item prefix

(MD029, ol-prefix)

---

93-93: Expected: 4; Actual: 6; Style: 1/2/3 Ordered list item prefix

(MD029, ol-prefix)

---

97-97: Element: p Inline HTML

(MD033, no-inline-html)

---

263-263: Element: div Inline HTML

(MD033, no-inline-html)

---

793-793: Element: div Inline HTML

(MD033, no-inline-html)

---

799-799: Element: div Inline HTML

(MD033, no-inline-html)

---

938-938: Element: div Inline HTML

(MD033, no-inline-html)

---

771-771: null Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

777-777: null Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

783-783: null Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

789-789: null Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Additional comments not posted (1)

source/_integrations/zwave_js.markdown (1)

430-472: Documentation for new Z-Wave JS lock usercode services is clear and informative.

The documentation for the new services zwave_js.get_lock_usercode and zwave_js.get_lock_usercodes is well-structured and provides all necessary details for usage, including required attributes and response data. This should be very helpful for users looking to implement these new services in their Home Assistant setups.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[netlify[bot]]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	1c5cd6f4fda48133940864add7c208e2a4bb4ab8
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/667d864b33140d0008f0add1
😎 Deploy Preview	https://deploy-preview-33277--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[holocronweaver]

Would someone from Home Assistant team mind giving this a review?