Z-Wave controller reset: add prereq steps #39728

c0ffeeca7 · 2025-06-26T13:36:56Z

Proposed change

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.
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:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

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.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Clarified instructions for resetting a Z-Wave controller, specifying that devices must be removed from their old network before re-pairing.
- Expanded prerequisites section with explicit links for backing up the Z-Wave network and removing all paired devices.
- Added note that device removal can be performed by any controller and may be done later in the process.

netlify · 2025-06-26T13:37:03Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`29134f8`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/685d4fe84d09d7000861ac61
😎 Deploy Preview	https://deploy-preview-39728--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 project configuration.

Copilot

Pull Request Overview

This pull request updates the Z-Wave controller reset documentation to clarify the reset procedure and add prerequisite steps. The changes update the instructions for what happens to paired devices during a reset and add explicit steps for backing up the network and removing devices.

Comments suppressed due to low confidence (1)

source/_integrations/zwave_js.markdown:270

[nitpick] Ensure that the language used in this sentence aligns with the new prerequisite bullet below regarding removing paired devices. You may consider linking these two sections more explicitly for clarity.

- If there are any devices still paired with the controller when it is reset, they will have to be removed from the network before they can be re-paired.

source/_integrations/zwave_js.markdown

Co-authored-by: AlCalzone <[email protected]>

coderabbitai · 2025-06-26T13:45:49Z

📝 Walkthrough

Walkthrough

The documentation for resetting a Z-Wave controller was updated to clarify the handling of devices still paired with the controller at reset. The prerequisites section was expanded to explicitly include links for backing up the Z-Wave network and removing all devices paired with the controller, noting that removal can be done by any controller and may be done later.

Changes

File	Change Summary
source/_integrations/zwave_js.markdown	Clarified that devices must be removed from their old network before re-pairing, expanded prerequisites with backup and removal instructions, and noted removal can be done by any controller and potentially later.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 02db12d and 29134f8.

📒 Files selected for processing (1)

source/_integrations/zwave_js.markdown (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_integrations/zwave_js.markdown

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 or @coderabbitai title 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.

coderabbitai

Actionable comments posted: 0

♻️ Duplicate comments (1)

source/_integrations/zwave_js.markdown (1)
268-272: Clarify that exclusion can be performed by any controller

The sentence explains that devices must be removed from their old network, but it still omits the important detail (raised in a previous review) that any Z-Wave controller can perform this exclusion—not just the controller that originally managed the network.
- - If there are any devices still paired with the controller when it is reset, they will have to be removed from their old network before they can be re-paired.
+ - If there are any devices still paired with the controller when it is reset, they must first be removed (excluded) from their old network — this can be done by **any** Z-Wave controller — before they can be re-paired.

🧹 Nitpick comments (1)

source/_integrations/zwave_js.markdown (1)
274-278: Minor wording tweak for consistency

Use the verb form “Back up” to match the section title “Backing up your Z-Wave network”.
- - [Backup your Z-Wave network](#backing-up-your-z-wave-network)
+ - [Back up your Z-Wave network](#backing-up-your-z-wave-network)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 31ef951 and 02db12d.

📒 Files selected for processing (1)

source/_integrations/zwave_js.markdown (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

source/_integrations/zwave_js.markdown

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

c0ffeeca7 · 2025-06-26T14:22:03Z

thank you!

Z-Wave controller reset: add prereq steps

900c809

Copilot AI review requested due to automatic review settings June 26, 2025 13:36

c0ffeeca7 requested a review from a team as a code owner June 26, 2025 13:36

home-assistant bot added the current This PR goes into the current branch label Jun 26, 2025

Copilot AI reviewed Jun 26, 2025

View reviewed changes

AlCalzone suggested changes Jun 26, 2025

View reviewed changes

source/_integrations/zwave_js.markdown Outdated Show resolved Hide resolved

Update source/_integrations/zwave_js.markdown

02db12d

Co-authored-by: AlCalzone <[email protected]>

coderabbitai bot reviewed Jun 26, 2025

View reviewed changes

Implement review feedback

29134f8

MartinHjelmare approved these changes Jun 26, 2025

View reviewed changes

c0ffeeca7 merged commit 38c1cd7 into current Jun 26, 2025
9 checks passed

c0ffeeca7 deleted the z-wave-reset-add-prereqs branch June 26, 2025 14:22

github-actions bot locked and limited conversation to collaborators Jun 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Z-Wave controller reset: add prereq steps #39728

Z-Wave controller reset: add prereq steps #39728

Uh oh!

c0ffeeca7 commented Jun 26, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Jun 26, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

coderabbitai bot commented Jun 26, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

c0ffeeca7 commented Jun 26, 2025

Uh oh!

Uh oh!

Uh oh!

Z-Wave controller reset: add prereq steps #39728

Z-Wave controller reset: add prereq steps #39728

Uh oh!

Conversation

c0ffeeca7 commented Jun 26, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

netlify bot commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

coderabbitai bot commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

c0ffeeca7 commented Jun 26, 2025

Uh oh!

Uh oh!

c0ffeeca7 commented Jun 26, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Jun 26, 2025 •

edited

Loading

coderabbitai bot commented Jun 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)