Z-Stick Gen5 Utilitaire de sauvegarde

Lorsque son réseau Z-Wave devient conséquent, il faut se prémunir des possibles pannes. On n’est jamais à l’abri d’un défaut matériel sur un module et le cas échéant sur son contrôleur principal. La perte du contrôleur principal entraînerait la perte complète de votre réseau Z-Wave avec jeedom, seule les associations directes continueront de fonctionner. Dans l’éventualité du remplacement de votre contrôleur ou simplement de devoir effectuer une remise à zéro complète du contrôleur il faudrait alors refaire les inclusions de chaque module un à un. Vos modules auraient des IDs différents et il faudrait les associer manuellement aux anciens équipements, la tâche est vraiment fastidieuse.

Cet article vous guidera à travers les étapes de création d’un fichier de sauvegarde et comment restaurer votre réseau sur un nouveau Z-Stick Gen5 ou revenir à une itération précédente de votre réseau.

Pourquoi faire une sauvegarde de la topologie ?

Il est fortement recommandé de sauvegarder, occasionnellement, votre Z-Stick Gen5 au cas où le Z-Stick Gen5 deviendrait défectueux et /ou si vous avez besoin de le remplacer.

Les liens entre le contrôleur et les nœuds sont conservés dans la mémoire interne du contrôleur, on appelle cela, la topologie réseau.

Dans le plugin Z-Wave vous disposez d’un fichier zwcfgxxx.xml qui est seulement utilisé comme cache des interviews afin de lancer plus rapidement votre réseau Z-Wave. Ce fichier peut être supprimé ou modifier mais aucun lien entre le contrôleur et les modules ne seront perdus.

Dans Jeedom les modules sont virtuellement représentés par ce qu’on appelle des équipements. La synchronisation permet de reprendre l’ensemble des nœuds présents sur le contrôleur et de créer les équipements non présents coté jeedom. C’est aussi pour cette raison que la suppression d’un équipement dans jeedom n’entraîne pas l’exclusion de module sur le contrôleur.  Et c’est aussi pour cette même raison qu’un équipement supprimé revient dès que l’on effectue une synchronisation.

Si vous êtes un des heureux possesseurs d’un Z-Stick Gen5 de chez Aeotec, il vous est possible de sauvegarder votre topologie réseau Z-Wave, les liens entre le contrôleur et les modules.

En cas de panne ou de remplacement de votre contrôleur, si vous avez préalablement effectué une sauvegarde de votre topologie Z-Wave pour n’avez qu’à lancer une restauration dans le nouveau Z-Stick Gen5 et vous vous retrouvez avec le même réseau.Note importante, le backup jeedom ne contient pas de sauvegarde de la topologie Z-Wave.

Prérequis

Z-Stick Gen5

L’utilitaire de chez Aeotec ne fonctionne qu’avec le Z-Stick Gen5.

Il ne fonctionnera pas avec les versions Z-Stick Lite, ou le S2. Il ne fonctionne pas non plus avec les contrôleurs des autres marques évidemment.

L’utilitaire de sauvegarde

Télécharger l’utilitaire directement sur le site de support d’Aeotec. Il s’agit d’une archive .zip contenant l’utilitaire zwave_500.exe et ces DLLs nécessaires. Vous n’avez pas à installer, il faut seulement dézipper l’archive dans dans un dossier, par exemple « Z-Stick Gen5 Backup Tool » de votre lecteur C:.

Il requière un poste de travail sous Windows, en versions 7, 8, ou 10. Il n’existe pas d’utilitaire sous Linux ou en ligne de commande, donc on ne peut pas automatiser ce processus à l’heure actuelle.

Pilote USB

Afin que le Z-Stick Gen5 soit reconnu sous Windows il vous faudra aussi télécharger un pilote INF.  Lui aussi disponible sur le site de support Aeotec.

Windows 10 devrait déjà avoir le pilote, votre Z-Stick Gen5 devrait donc être automatiquement reconnu.

Pour installer le driver avec Windows 8 ou 10, il suffit simplement de faire un clic droit sur le fichier uzb.inf puis sélectionner et l’installer.

Avec Windows 7 il vous faudra passer par le gestionnaire de périphérique, retrouver le périphérique inconnu, faire bouton droit et mettre à jour le pilote.

On parcourt pour sélectionner l’emplacement du fichier INF téléchargé. Votre Z-Stick devrait apparaître sous le nom de « UZB (COMx) » le x étant le nom du port affecté.

Noter le nom de port pour plus tard.

Clé réseau Z-Wave

Il nous faut aussi la clé de sécurité de votre réseau. Dans la majorité des cas vous avez la clé définie par défaut.

La clé correspond à l’option « NetworkKey » du fichier resources/openzwaved/ozwave/manager_utils.py c’est une suite 16 valeurs hexadécimales.
« 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10 »

Pour l’utilitaire on donne la valeur « 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0^E 0F 10 » c’est l’ensemble des valeurs de « NetworkKey » sans séparation ni le préfixe 0x.

Fréquence des sauvegardes

Il n’est pas nécessaire d’effectuer des sauvegardes journalières ou périodiques, je recommande d’effectuer une sauvegarde de la topologie lorsque votre réseau ZWave contient des changements au niveau des nœuds, que ce soit suite à une inclusion ou exclusion d’un ou plusieurs modules. Il n’est pas non plus obligatoire de faire une nouvelle sauvegarde à chaque inclusion / exclusion, on pense à le faire lorsque notre réseau est stable et qu’il ne doit pas bouger.

Effectuer une sauvegarde

Pour lancer une sauvegarde, il vous faudra stopper l’exécution du plugin Z-Wave afin de débrancher votre contrôleur de votre Jeedom pour le brancher sur l’ordinateur Windows. Vous pouvez désactiver la gestion automatique du plugin dans l’écran de configuration du plugin Z-Wave puis stopper le deamon Z-Wave. Une fois arrêté, vous pouvez débrancher le Z-Stick Gen5 de jeedom pour le brancher sur votre poste Windows.

Assurez-vous que le Z-Stick Gen5 est bien reconnu par Windows, sinon reportez-vous à l’installation du pilote INF de l’étape précédente.

On lance l’outil de sauvegarde « zwave_500.exe » il devrait détecter automatiquement votre port USB ou est branché le Z-Stick Gen5.

Le nom du port USB devrait être affiché dans le haut de la fenêtre et une mention «Load ZStick Success » dans la barre d’état vous confirme qu’il a bien été reconnu.

En cas de problème le message « Application Load ZStick Fail ! » sera affiché dans la barre d’état et le nom du port sera vide comme dans la copie écran suivante.

Il faudra alors débrancher le Z-Stick Gen5 une seconde, le rebrancher, puis cliquer sur « Setting » et sélectionner manuellement le bon Port USB.

Si votre port USB n’est pas affiché, quitter l’outil, débrancher et rebrancher le Z-Stick Gen5 avant de réessayer.

Une fois que le dongle est bien reconnu, Il faut activer la sécurité « Enable Security » et ajouter votre clé de sécurité.

On veut effectuer la lecteur de la mémoire du dongle on lance donc Read Eeprom

Une boîte de dialogue nous demande un emplacement et nom de fichier où l’on souhaite sauvegarder la topologie de notre contrôleur USB. Exemple on nomme le fichier « ZWaveBackup-12.10.2017.bin » l’extension est prédéfinie.

Il sera important de choisir un emplacement sécurisé et aussi sauvegardé de votre fichier de topologie réseau, comme par exemple sur un NAS.

Puis on clique sur « Save »

La sauvegarde s’effectue en quelque minute (3 à 5).

Suivi d’une confirmation de l’opération. On confirme avec OK.

Félicitations, vous venez de créer une sauvegarde complète de la topologie de votre réseau Z-Wave.

Vous pouvez maintenant quitter l’utilitaire, débrancher le dongle USB et le remettre sur votre jeedom.

Pensez à réactiver la gestion automatique du deamon Z-Wave.

Effectuer une restauration

On assume ici que vous avez déjà votre ordinateur avec l’outil de sauvegarder et le pilote USB installé et reconnu avec l’outil Aeotec.

Tout comme pour la sauvegarde on active la sécurité et on renseigne la valeur de la clé de réseau Z-Wave.

Et cette fois on souhaite écrire dans la mémoire de notre contrôleur on utilise donc le bouton Write eeprom.

Une boîte de dialogue nous demande de sélectionner le fichier à récupérer.

Je sélectionne le fichier « ZWaveBackup-12.10.2017.bin » qui correspond à ma dernière sauvegarde, puis ouvrir.

La restauration de la topologie débute et devrait aussi durer entre 3 et 5 minutes.

A la fin une confirmation de l’opération.

Il ne vous reste plus qu’à quitter l’outil de sauvegarde puis brancher votre Z-Stick Gen5 dans votre  jeedom et relancer le démon Z-Wave.

La topologie de votre réseau Z-Wave sera la même qu’au moment de la sauvegarde.

Modification de la topologie après une sauvegarde

Si vous avez effectué des changements dans votre réseau, que ce soit inclusion ou exclusion de modules sans avoir effectué un nouveau backup et que vous devez restaurer votre backup ces changements seront perdus. Il vous faudra alors refaire ces inclusions et ou exclusions à nouveau. Devoir refaire quelques nœuds sur un réseau n’est pas trop grave surtout s’il ne s’agit que d’exclusion.

Plus vous serez rigoureux dans le suivi de vos sauvegardes de topologie de votre réseau Z-Wave plus simple sera le retour à la normale en cas d’avarie.

Mon réseau de production comporte plus de 80 modules, refaire mon réseau deviendrait une corvée que je préfère éviter.

Il est juste dommage qu’on ne puisse pas automatiser l’opération de sauvegarde.

Limitation

La sauvegarde doit être effectuée lorsque votre contrôleur est stable, si votre contrôleur semble défectueux et que vous effectuez une sauvegarde dans cet état il n’est pas garanti que le réseau restauré soit de bonne facture.

Lorsqu’on est satisfait de son réseau que tout tourne comme on le souhaite, c’est le bon moment de faire une sauvegarde.

Durant le temps de l’opération de la sauvegarde vos scénarios dans jeedom ne seront plus actifs. Une fois le réseau relancé et qu’il aura chargé la topologie tout revient dans l’ordre.  Vos modules sur piles resteront en « cacheload » jusqu’à leur prochain réveil, il ne faut pas se soucier de ça.

Petit Extra

Vous avez probablement remarqué un paramètre de l’utilitaire de sauvegarde avec la mention « Led ON/OFF »

C’est pour désactiver totalement le clignotement de la LED de son contrôleur. En décochant la case la LED reste éteinte, même sur activité sur le réseau Z-Wave.

Il vous est aussi possible de désactiver ou activer le clignotement en ligne de commande directement en ssh.

Conclusion

Lorsque votre réseau Z-Wave et votre domotique deviennent essentiels à votre quotidien il faut se prémunir au maximum des risques de panne matériel. Avec une bonne sauvegarde de sa topologie réseau il est tout aussi simple de remplacer un contrôleur principal par un nouveau, qu’un autre module défaillant.

Je vous recommande cette bonne pratique qui pourrait vous prémunir beaucoup d’une perte de temps si la malchance venait à vous arriver.

La procédure de sauvegarder et de restauration est celle prescrite par Aeotec, je n’ai pas inventé l’eau chaude.