Utiliser les plugins sur Domoticz. Installation manuelle ou via Python Plugin Manager

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

Comme vous pouvez le constater, j’ai testé avec la version 3.5.3 (la dernière au moment de la rédaction du tutoriel) sans aucun problème. Il semblait y avoir des problèmes lors du passage de la version 3.4 à la version 3.5 mais cela ne semble plus le cas maintenant. Inutile donc d’installer une version plus ancienne.

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.

domoticz python plugon system loaded

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.

Plugin Nom dans le menu matériel Lien vers le code source Pris en charge par PP Manager
Python Plugin Manager(Linux Only) https://github.com/ycahome/pp-manager  ?
Battery monitoring for Z-Wave nodes ZWave Devices Battery Monitoring Plugins/BatteryLevel.html Oui
Buienradar.nl (Weather lookup) Buienradar Weather Lookup https://github.com/ffes/domoticz-buienradar Oui
Bluetooth Beacon Presence https://github.com/mrin/domoticz-bt-presence
Bluetooth MAC Ping https://github.com/heggink/domoticz-bluetooth-ping Pas testé
Crow Runner Alarm Crow/AAP Alarm IP Module https://github.com/febalci/DomoticzCrowAlarm Oui (v.1.5.6)
Daikin Airconditioning (BRP069A42) Daikin BRP069A42 WiFi adapter https://github.com/leejoow/domoticz_daikin_BRP069A42 Non
Denon/Marantz Amplifier https://github.com/dnpwwo/Domoticz-Denon-Plugin Oui
Disc usage https://github.com/Xorfor/Domoticz-Disc-usage-Plugin Oui
domoticz-storm-report (burze.dzis.net) Storm Reporting (Europe) https://github.com/lrybak/domoticz-storm-report Non
DSC EnvisaLink DSC EnvisaLink Alarm Interface https://github.com/dnpwwo/Domoticz-DSCEnvisalink-Plugin
Dutch earthquakes https://github.com/Xorfor/Domoticz-LastDutchEarthquake-Plugin Oui
ebusd bridge https://github.com/guillaumezin/DomoticzEbusd Oui
EwpeSmart Air Conditioners via MQTT (Gree Smart) https://github.com/stas-demydiuk/domoticz-ewpe-smart-mqtt-plugin
Freebox https://github.com/supermat/PluginDomoticzFreebox
GlobalCache GC-100 https://github.com/dnpwwo/Domoticz-GlobalCache-Plugin Oui
H801 LED WiFi controller Plugin H801 LED WiFi controller with Tasmota firmware https://github.com/stas-demydiuk/domoticz-h801-tasmota-plugin
Hive Plugin Hive Active Heating https://github.com/imcfarla2003/domoticz-hive Oui
Homewizard https://github.com/rvdvoorde/domoticz-homewizard Oui
Hosola / Omnik solar inverter https://github.com/ericstaal/domoticz/tree/master/plugin/hosola
Hyperion https://github.com/ericstaal/domoticz/blob/master/plugin/hyperion
IKEA Tradfri Trådfri Gateway (Ikea) https://github.com/moroen/IKEA-Tradfri-plugin Oui (v.1.5.6)
iCloud device locator https://github.com/heggink/domoticz-icloud Pas encore testé
Kodi Players Kodi https://github.com/dnpwwo/Domoticz-Kodi-Plugin
Ledenet / Ufolight RGB controller [https://github.com/ericstaal/domoticz/tree/master/plugin/ledenet
Life 360 Presence Life 360 Presence Detection https://github.com/febalci/DomoticzLife360 Oui (v.1.5.6)
Linky https://github.com/guillaumezin/DomoticzLinky Oui
MAC address presence Mac presence https://github.com/Xorfor/Domoticz-Mac-Presence-Plugin
MELCloud Control Mitsubishi AC [https://github.com/gysmo38/domoticz-python-melcloud
Meteo Alarm EU RSS Reader https://github.com/ycahome/MeteoAlarmEU Oui
Mikrotik RouterOS https://github.com/mrin/domoticz-routeros-plugin Oui
Moon Phases https://github.com/ycahome/MoonPhases Oui
Motherboard PSUtil Sensors https://github.com/febalci/DomoticzPsutil
MQTT discovery https://github.com/emontnemery/domoticz_mqtt_discovery Oui
NUKI Locks https://github.com/heggink/domoticz-nuki Pas encore testé
Onkyo AV Receiver Onkyo receivers https://github.com/jorgh6/domoticz-onkyo-plugin Oui
OpenAQ https://github.com/Xorfor/Domoticz-OpenAQ-Plugin Oui
Paradox Alarm PRT3 serial interface Domoticz-ParadoxPrt3-Plugin https://github.com/Masurov/Domoticz-ParadoxPrt3-Plugin
Parrot Flower Power & Pot plugin https://github.com/tazounet/parrot_flower_plugin
Pi-hole summary Pi-hole https://github.com/Xorfor/Domoticz-Pi-hole-Plugin Oui
PiMonitor https://github.com/Xorfor/Domoticz-PiMonitor-Plugin Oui
Pinger (ICMP) Pinger https://github.com/dnpwwo/Domoticz-Pinger-Plugin
Pioneer AVR https://github.com/febalci/DomoticzPioneerAVR Oui (v.1.5.6)
RAVEn Zigbee energy monitor RAVEn Power Monitor https://github.com/dnpwwo/Domoticz-RAVEn-Plugin Oui (v.1.5.6)
RFSwitches RF 433 Switches https://github.com/flatsiedatsie/433Switches
Smart Virtual Thermostat Plugins/Smart_Virtual_Thermostat.html
SNMP Reader https://github.com/ycahome/SNMPreader Oui
Sonos Plugins/Sonos.html Oui
Sony Bravia TV (with Kodi remote) Sony Bravia TV https://github.com/gerard33/sony-bravia Oui
Speedtest https://github.com/Xorfor/Domoticz-Speedtest-Plugin Oui
SYSFS-Switches GPIO SYSFS Switches https://github.com/flatsiedatsie/GPIO-SYSFS-Switches Oui
UPS Monitor Plugins/NUT_UPS.html Oui
WAN IP Checker https://github.com/ycahome/WAN-IP-CHECKER Oui
Windcentrale https://github.com/Xorfor/Domoticz-Windcentrale-Plugin
Xiaomi Mi Flower Mate Xiaomi Mi Flower Mates https://github.com/flatsiedatsie/Mi_Flower_mate_plugin Oui
Xiaomi Mi Robot Vacuum https://github.com/mrin/domoticz-mirobot-plugin Oui
Xiaomi PM2.5 Sensor Xiaomi PM2.5 Air Quality Sensor https://github.com/febalci/DomoticzXiaomiPM2.5 Oui
Yamaha AV Receiver https://github.com/thomas-villagers/domoticz-yamaha Oui
Zigate https://github.com/sasu-drooz/Domoticz-Zigate/ Oui
Zigbee2MQTT Passerelle Zigbee https://github.com/stas-demydiuk/domoticz-zigbee2mqtt-plugin Oui
Ziggo Mediabox XL (Kodi remote) Ziggo Mediabox XL (Horizon) https://github.com/Xorfor/Domoticz-ZiggoHorizon-Plugin

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.

domoticz plugin zigbee2mqtt installed

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

zigbee2mqtt connector settings domoticz plugin

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

domoticz pp manager install new plugin zigbee2mqtt

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é.

domoticz pp manager install new plugin selector

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.

domoticz plugin zigbee2mqtt installed

Les plugins gérés avec PP Manager sont installés avec l’utilisateur root. Il faudra donc se connecter en root ou changer d’utilisateur pour faire des modifications dans les fichiers.

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

Quoi faire si les plugins n’apparaissent pas dans le menu ?

Sur le WiKi officiel, il est préconisé d’installer la version beta de Domoticz en cas de problème. Tout fonctionne parfaitement avec la version 4.9700.

Il faut systématiquement redémarrer le serveur Domoticz y compris lorsqu’on utilise le plugin Python Plugin Manager depuis le Terminal avec la commande

sudo systemctl restart domoticz.service

N’oubliez pas de rafraîchir le navigateur pour recharger la liste des plugins dans le sélecteur.

Si ça ne fonctionne toujours pas, re-démarrez le système (sudo reboot) ou depuis le navigateur Réglages -> Plus d’Options -> Redémarrer.

Si ça ne fonctionne toujours pas, il ne vous reste plus qu’à repartir avec une nouvelle installation de Raspbian 🙁

 

Inscrivez-vous à la newsletter hebdomadaire

Aucun spam et aucun autre usage ne sera fait de votre email. Vous pouvez vous désinscrire à tout moment.

Promos à ne pas louper

Donnez votre avis

Laisser un commentaire

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.

Domotique et objets connectés à faire soi-même