ZHA libraries will soon support ConBee/RaspBee backup and restore that can be used for Zigbee network migrations

Hedda · January 3, 2022, 4:26pm

zigpy developers are apparently working on deconz backup and draft pull request can be found here:

https://github.com/zigpy/zigpy-cli/pull/2

Part of that larger PR include: “Initial implementation of cross-adapter network backup/restore”.

So that means that users of ZHA with ConBee or RaspBee can soon do backup and migrations too.

At least that is how I interpret answer from puddly when posted this feature request for zigpy-deconz:

https://github.com/zigpy/zigpy-deconz/issues/177

Request for developers who own ConBee or RaspBee (deCONZ based adapters) and are depending on zigpy-deconz to consider implementing Zigbee network backup and restore tools to zigpy-deconz (or zigpy-cli) supporting “Open ZigBee Coordinator Backup Format” as already supported by both zigpy-znp and bellows radio libraries:

FYI, this open format is already used as a migration method for other types of adapters as seen here:

Note! Please understand that zigpy and the zigpy-deconz radio libraries which ZHA depends on are all free and open-source library with only volunteering developers working on them without pay so remember and you and anyone else are also are more than welcome to code the feature for it (the zigpy developers have so far been more than happy to help and other volenteering developers who are willing to step in to assist with helping to fix bugs or add features).

PS: This Open ZigBee Coordinator Backup Format is also used by the Zigbee2MQTT (Z2M) project.

PPS: This open backup format is not supported by dresden elektronik’s official Phoscon Software.

PPPS: Until this happens will need to backup ConBee and RaspBee NVRAM with Phoscon/deCONZ:

https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Backup-%26-Restore

https://flemmingss.com/how-to-backup-and-restore-deconz-from-a-defective-installation/

bjorn.sivertsen · January 4, 2022, 4:35pm

I’m considering moving from ZHA to Z2M and from a Conbee II to a Sonoff Zigbee 3.0 coordinator. This initiative sounds like it would lessen my workload considerably! Big yay!

Hedda · February 9, 2022, 7:53am

FYI, testers testing it has now confirmed that patches for the mentioned pull request work with ConBee:

https://github.com/zigpy/zigpy-cli/pull/2

github.com/zigpy/zigpy-cli

Implement new radio API

zigpy:dev ← puddly:puddly/zigpy-radio-api

opened 05:12PM - 14 Nov 21 UTC

puddly

+43 -24

This change introduces a network backup/restore utility for any adapter implemen…ting the new radio API: - [x] zigpy: https://github.com/zigpy/zigpy/pull/848 - [x] zigpy-znp: https://github.com/zigpy/zigpy-znp/pull/97 - [x] zigpy-deconz: https://github.com/zigpy/zigpy-deconz/pull/172 - [x] bellows: https://github.com/zigpy/bellows/pull/445 The following adapters also implement the new radio API but their firmware does not allow much network information to be read, making this form of migration impossible: - [x] zigpy-zigate: https://github.com/zigpy/zigpy-zigate/pull/117 - [x] zigpy-xbee: https://github.com/zigpy/zigpy-xbee/pull/123 --- <h1 id="instructions">Instructions</h1> You'll need access to a Python environment. zigpy-znp has documentation [that describes how to do this](https://github.com/zigpy/zigpy-znp/blob/dev/TOOLS.md#installation) for every common platform. This package depends on unreleased patches to various radio libraries so you must install them all directly from Git: ```bash # Make a new venv, these packages are heavily modified virtualenv -p 3 venv # Python 3.7 or above is required # Or python3 -m venv venv (if `virtualenv` isn't installed) source venv/bin/activate # Install modified versions of zigpy, zigpy-znp, zigpy-deconz, bellows, and the new zigpy-cli pip install \ git+https://github.com/puddly/zigpy.git@puddly/new-radio-settings-api \ git+https://github.com/puddly/zigpy-cli.git@puddly/zigpy-radio-api \ git+https://github.com/puddly/zigpy-znp.git@puddly/new-radio-settings-api \ git+https://github.com/puddly/zigpy-deconz.git@puddly/new-radio-api \ git+https://github.com/puddly/bellows.git@puddly/zigpy-radio-api # Back up the old radio. Note: this backup format will change in the future. # Conbee/Raspbee zigpy -vv radio deconz /dev/serial/by-id/... backup deconz.json # CC2531, CC2652, etc. # zigpy -vv radio znp /dev/serial/by-id/... backup znp.json # HUSBZB-1, EFR32, etc. # zigpy -vv radio ezsp /dev/serial/by-id/... backup ezsp.json # Restore a backup to the new one zigpy -vv radio znp /dev/serial/by-id/... restore deconz.json # zigpy -vv radio ezsp /dev/serial/by-id/... restore deconz.json # zigpy -vv radio deconz /dev/serial/by-id/... restore deconz.json # Leave the virtualenv deactivate ``` Once that's done, edit `/config/.storage/core.config_entries` (take a backup of the file first!) and change the coordinator's `path` to the new radio's `/dev/serial/by-id/...` path. If you're switching to a CC2652, make sure to delete the `flow_control` key and set the `baudrate` to `115200`.

PS: Consider voting for related feature request → ZHA integration to do nightly backup of both Zigbee Coordinator adapter/dongle/stick and Zigbee database?

isibizi · July 8, 2022, 10:42am

Is it possible now to move from CC2531 to Conbee II or Raspbee ? 2022.07 is released now, but i cant find informations about backup&restore.

Hedda · August 4, 2022, 9:42pm

It is possible but currently, you still have to do the backup and restore via zigpy / zigpy-cli, again see → https://github.com/zigpy/zigpy-cli/pull/2

But keep an eye on ZHA integration to do nightly backup of both Zigbee Coordinator adapter/dongle/stick and Zigbee network/database?

benschi11 · February 14, 2023, 10:27pm

Have you done it already. I am in the same situation. Will get my Sonoff Zigbee 3.0 Dongle tomorrow.

bjorn.sivertsen · February 15, 2023, 6:10am

Went with the SkyConnect instead.

benschi11 · February 15, 2023, 12:22pm

Ok, thanks. But did you re-pair every device you have? That is my trouble - have one device which I can’t reach without unmounting the furniture.

bjorn.sivertsen · February 15, 2023, 12:49pm

Yes, unfortunately I did it the manual way.

But I found this guide, that might be of help:

Home Assistant SkyConnect (home-assistant.io)

Hedda · February 15, 2023, 3:53pm

FYI; they posted some guides for migrating Zigbee devices from deCONZ/Phoscon or Zigbee2MQTT:

https://skyconnect.home-assistant.io/zigbee-migration-selection/
- https://skyconnect.home-assistant.io/migrate-zigbee-zha-only/ (migrate ZHA to ZHA)
- https://skyconnect.home-assistant.io/migrate-conbee/ (migrate deCONZ/Phoscon to ZHA)
- https://skyconnect.home-assistant.io/migrate-zigbee-zha/ (migrate Zigbee2MQTT to ZHA)
  - https://skyconnect.home-assistant.io/migrate-zigbee-backup/ (migrate Z2M backup)

Again, migration from deCONZ/Phoscon or Zigbee2MQTT is not seamless, as it will only migrate the Zigbee network, (that way you at least do not need to run around and re-pair/re-join all your devices), unfortunately, it does not migrate the entries in Home Assistant so still need to rename those devices and update any automations and scripts that are using the old device names.

Note that if using a ConBee/RaspBee adapter then you first need to upgrade deconz firmware on it.

There is currently no migration path to migrate all settings, devices and entities to Home Assistant ZHA.

benschi11 · February 16, 2023, 9:01pm

Thank you for the information. I tried it but in my case it wasn’t very successfull. Migration from deconz to zha with the conbee II stick did work - but the network was very unstable. I tried to reconfigure the coordinator to the new sonoff stick - but this failed - the entities in ha where correct but they didn’t do anything.
So I reverted to the snapshot and leave it on my deconz for now.
If I get more time - I will try it again
Thanks for all the help.