Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding NVM information #24474

Closed
wants to merge 1 commit into from
Closed

Adding NVM information #24474

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 21 additions & 1 deletion source/_integrations/zwave_js.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -705,10 +705,30 @@ You can also keep track of the roadmap for the Z-Wave integration [here](https:/

#### Which Z-Wave controller should I buy?

Z-Wave supports all known 500 and 700 series Z-Wave controllers. If you are just starting out, we recommend that you purchase a 700 series controller (with firmware updated to >=7.17.2).
Z-Wave supports all known 500 and 700 series Z-Wave controllers. If you are just starting out, we recommend that you purchase a 700 series controller (with firmware updated to >=7.17.2). When buying a USB controller, verify that its firmware supports backup and restore of its "Non Volatile Memory" (NVM). This allows to migrate a running Z-Wave installation to another controller also supporting backup/restore of NVM. Z-Wave controller firmware may be updateable by Silicon Labs Developer software.

For more information, see [Supported Z-Wave dongles](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules)

#### Z-Wave controller NVM

Z-Wave supports backup and restore of Z-Wave controller "Non Volatile Memory" (NVM) via "Control Panel" -> "Advanced Actions". Backup will save an NVM file into "Store" -> "backups" -> "nvm", where it will automatically be saved into system backups and can also be downloaded. Restore will ask the user to restore a file from the local machine.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you're describing functionality of Z-Wave JS UI. The integration doesn't yet support any NVM features, so we shouldn't document that here yet.


#### Migrating Z-Wave network to a new controller

To migrate a Z-Wave network between Z-wave controllers, perform the following steps

1. Perform NVM backup of running Z-Wave controller
2. Disable WebSocket via Z-Wave -> Settings -> Home Assistant -> WS Server. This will disconnect Z-Wave from Home Assistant and ensure that Home Assistant will not get confused until the new Z-Wave controller is restored.
3. Remove the running Z-Wave controller, plug in the new Z-Wave controller
4. Configure Z-wave to use the new Z-Wave controller via Z-Wave -> Settings -> Z-Wave -> Serial Port. You may need to reboot Home Assistant for the new controller to be recognized.
5. Verify the new controller is recognized and operating via Z-Wave -> Control Panel
6. (Optional) Backup NVM of new controller
7. Download NVM backup from old controller via Z-Wave -> Store -> bcku -> nvm. Restore NVM backup of old controller onto new controller.
8. Verify that Z-Wave has all the Z-Wave devices of your old controller. You may need to restart Z-Wave plugin.
9. Re-enable WebSocket

Z-Wave NVM backup and restore will under the hood automatically convert(https://github.com/zwave-js/node-zwave-js/tree/master/packages/nvmedit#convert-one-nvm-to-be-compatible-with-another-one) the NVM files from different controllers, e.g.: 500 <-> 700.

#### Why was I (or why was I not) automatically prompted to install Z-Wave?

Some Z-Wave USB sticks can be auto-discovered, which can simplify the Z-Wave setup process. The following devices have been tested with discovery, and offer a quick setup experience; however, these are **not** all of the devices supported by Z-Wave:
Expand Down