Z-Wave: add steps on migrating network to a new controller #39473
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new documentation section was added to explain how to migrate a Z-Wave network to a new controller in Home Assistant. The instructions detail the process for replacing an existing Z-Wave controller while preserving the network, outlining the necessary steps and important considerations. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant OldController
participant NewController
User->>HomeAssistant: Initiate "Migrate controller" from Z-Wave integration
HomeAssistant->>OldController: Backup and factory reset
OldController-->>HomeAssistant: Confirms reset and removal
User->>OldController: Unplug old controller
User->>NewController: Plug in new controller
HomeAssistant->>NewController: Pair with existing Z-Wave network
NewController-->>HomeAssistant: Confirms pairing and migration complete
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/zwave_js.markdown (1)
167-169: Streamline the description
Consider combining the two sentences into one for clarity, e.g.:
"Follow these steps to migrate your existing Z-Wave network to a new controller while preserving your network data."
📜 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
📒 Files selected for processing (1)
source/_integrations/zwave_js.markdown(1 hunks)
⏰ 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
🔇 Additional comments (1)
source/_integrations/zwave_js.markdown (1)
171-180: Verify UI labels and macros
Please confirm that "Backup and restore", "Migrate controller", and "Migrate to a new controller" exactly match the current Home Assistant UI. Update the button names or macros if they have changed upstream.
| @@ -162,6 +162,23 @@ While your Z-Wave mesh is permanently stored on your dongle, the additional meta | |||
| 4. Put the device you want to remove in exclusion mode. Refer to its manual how this is done. | |||
| 5. The UI should confirm that the device was removed and the device and entities will be removed from Home Assistant. | |||
|
|
|||
| ## Migrating a Z-Wave network to a new controller | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consistent heading level
The migration section should be a third-level heading (###) under Getting started to match the existing subsections (e.g., Adding a new device, Removing a device).
🤖 Prompt for AI Agents
In source/_integrations/zwave_js.markdown at line 165, the heading "Migrating a
Z-Wave network to a new controller" is currently not a third-level heading.
Change the heading markup to use three hash symbols (###) instead of the current
level to make it a third-level heading, ensuring it is consistent with other
subsections under "Getting started".
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit