IQRF IDE backup and restore

This blog describes how to backup and restore coordinator and nodes of an existing IQRF network

Create backup file

The backup file contains necessary information about existing IQRF network. It is recommended to create it every time you have changed the network and you need to reconstruct or fix it when something has been broken (HW failure, unintended bonds/unbonds, stolen node, etc)

Connect the coordinator via CK-USB or remotely as described in https://logimic.org/2019/11/19/iqrf-ide-remotely-connect-iqrf-gateway-daemon/ and create the backup file for whole network:

Create backup file

Note you can create the file just for the coordinator or a particulate node. It can be more suitable for large networks as the whole backup may run for a long time.

Restore the coordinator

This is most straightforward. We need it if the coordinator stops working for any reason. If we have the backup file it is easy. Prepare a new coordinator with appropriate plug-in as described e.g.: https://logimic.org/2019/09/23/how-to-start-with-iqrf/#Configure_Coordinator

Connect the coordinator via CK-USB. In the IQRF IDE select IQMESH Network Manager select Control choose Backup/Coordinator option and hit Restore button:

Coordinator restore

You will be guided to browse the backup file. Select the right one and follow the instruction provided by the IQRF IDE

Restore Node

This is more tricky. As we want to use unbonded node, it is not possible to communicate with it directly via DPA messages. However IQRF IDE offer another way called DSM (DPA Service Mode)

Create CATS

CATS (Configurator Analyzer Tester Scanner) is special device created automatically by IQRF IDE. Put IQRF TR module just with OS (recommended the latest). Put it to CK-USB and choose the button Create CATS

Follow the instructions, keep default options. At the end, you have created CATS device. It can be used for various purposes. It communicates via RF with any connected node. It is not necessary to create CATS again. You can put it to your drawer and used it repeatedly. However CATS would be re-created after installation of newer IQRF IDE.

We will use it now for a node restore.

Use CATS DSM to restore Node

A restored device has to be ready with correct plug-in (os/dpa version), custom handler and configuration with the access password matching the one set on the original device. Switch to DPA Service Mode tab, fill the password and push the button Connect.

Now reset or just switch off/on the device. The CATS DSM shall connect and get the device info from the connected node:

Push the button Restore. You will be asked to browse for a backup file. If you have chosen the whole network backup file you have a possibility to select a node to be restored:

Select the one you would like to restore according its Addr and push the button Restore. As we want to replace broken original device the MIDs are different and we have set the password already so we can accept the warning:

When finished, disconnect CATS DSM:

It is all. We have hust created the node remotely without direct access to the network. The new device is part of the network and when it is in the range of the network it behaves as the original one.