Utiliser les plugins sur Domoticz. Installation manuelle ou via Python Plugin Manager • Domotique et objets connectés à faire soi-même

Domoticz dispose maintenant d’un système de gestion de plugins développé en Python comme la plupart des autres serveurs domotiques Open Source (Jeedom, Home Assistant, OpenHAB). Lancé timidement courant 2018, de nombreux plugins sont aujourd’hui disponibles. Si vous avez des besoins particuliers, vous pourrez même vous lancer dans le développement de votre plugin en suivant ces spécifications.

Il existe deux solutions pour installer des plugins. Soit les installer manuellement, soit utiliser le plugin “Python Plugin Manager” (PP Manager) qui se charge de cette tâche. Nous allons voir comment faire dans les deux cas.

Vérifier l’installation de python 3 sur Raspbian, Linux, Windows, macOS

Domoticz prend en charge les plugins développés en Python 3. C’est un point critique et pour tout vous avouer, j’ai dû repartir d’un Raspbian fraîchement installé pour y arriver malgré avoir suivi à la lettre les conseils du WiKi officiel.

Exécutez la commande suivante pour vérifier la version de Python 3 installée sur Linux

python3 -V Python 3.5.3

Si Python n’est pas installé, exécutez cette commande sous Linux ou Raspbian

sudo apt install python3

Sur Windows ou macOS, allez sur le site officiel pour télécharger le programme d’installation et suivez les instructions de ce dernier.

Il faut ensuite installer les librairies supplémentaires libpython et python3-dev

sudo apt install libpython3.5 python3-dev

Relancez Domoticz pour démarrer le système de chargement des plugins

sudo systemctl restart domoticz.service

Dernière chose à faire, s’assurer que le système est à jour et que le packet git est installé. Il sera nécessaire pour télécharger et installer les plugins sur votre serveur

sudo apt-get update
sudo apt-get install git

Comment savoir si les plugins sont chargés correctement au démarrage ?

Avant d’aller plus loin, il est préférable de vérifier que tout est correctement en place. Pour savoir si les plugins seront bien chargés au démarrage, le seul moyen consiste à aller consulter le journal d’execution qui se trouve dans le menu Réglages.

Si tout est correctement installé, vous devez trouver la trace PluginSystem : Started, Python version ‘3.x.x’ dans le journal.

Si ce n’est pas le cas, allez au paragraphe Quoi faire si les plugins n’apparaissent pas dans le menu ? pour trouver une piste.

Quels sont les plugins disponibles

En plus du plugin Python Plugin Manager, il existe 60 plugins disponibles. La liste officielle se trouve ici sur le WiKi officiel. Voici la liste actuelle. Comme vous pouvez le constater, tous les plugins ne sont pas pris en charge par PP Manager, il faudra faire une installation manuelle pour ces derniers.

Installer manuellement un plugin

Maintenant que tout est prêt, on va pouvoir ajouter notre premier plugin. Je vous propose d’installer le plugin Zigbee2MQTT qui permet d’intégrer directement les accessoires domotiques Xiaomi Aqara ou Mijia dans Domoticz. Ce plugin a été développé par l’équipe du projet. En plus de configurer l’accès au broker MQTT, il permet d’activer ou désactiver la découverte des accessoires sans avoir besoin de modifier le fichier de configuration manuellement.

Ouvrez un Terminal et allez dans le répertoire des plugins

cd domoticz/plugins

puis on clone avec la commande git le plugin souhaité. Utilisez le lien vers le code source qui se trouve dans le tableau précédent en lui ajoutant .git à la fin

git clone URL_PLUGIN.git NOM_REPERTOIRE_PLUGIN

Ce qui donne pour Zigbee2MQTT.

git clone https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin.git zigbee2mqtt

Il faut rendre le script python exécutable

cd Zigbee2Mqtt
chmod +x plugin.py

Maintenant on relance Domoticz

sudo systemctl restart domoticz.service

Actualisez l’affichage du navigateur et rendez-vous sur la page du matériel Réglages -> Matériels. Dans la liste de sélection, vous devriez maintenant trouver à la fin de la liste le plugin Zigbee2MQTT.

Voilà, il ne reste plus qu’à configurer les paramètres pour intégrer les accessoires Xiami Aqara !

Installer Python Plugin Manager

Le plugin PP Manager n’est disponible que sur Linux. PP Manager s’installe comme n’importe quel autre plugin. Suivez les même étapes que précédemment.

Le fonctionnement de PP Manager est un peu particulier.

Installer un plugin avec PP Manager

Pour installer un plugin avec PP Manager, sélectionnez Plugin Python Manager comme type de matériel puis dans le sélecteur

Je vous conseille de nommer le matériel avec le nom du plugin que vous allez installer suivi du mot clé plugin. Cela vous permettra de faire la différence entre le plugin et la configuration des matériels. Ce sera très utile pour les mises à jour.

Dans la liste des plugins à installer, choisissez le plugin désiré. Si vous avez confiance dans le développeur du plugin, vous pouvez laisser PP Manager faire automatiquement la mise à jour (Auto Update) mais c’est déconseillé.

Cliquez sur Add pour terminer l’installation.

Pour le moment, il faut malheureusement redémarrer manuellement le service Domoticz depuis le Terminal pour recharger la liste des plugins

sudo systemctl restart domoticz.service

Ajouter un accessoire

Une fois le plugin installé avec PP Manger, on peut configurer un nouveau matériel comme d’habitude. Je vous conseille également de nommer différemment le matériel afin de faire rapidement la distinction avec le plugin.

Pour cela, il suffit de chercher le plugin dans la liste des matériels comme d’habitude.

PP Manager ne gère pas la désinstallation des plugins.