Plugin ZigbeeLinker (Jeedom)

Introduction

Gérez vos équipements Zigbee dans Jeedom grâce à une connexion avec MQTT et Zigbee2MQTT.

Le plugin vous aide à installer une solution complète pour gérer et intégrer facilement vos équipements compatibles avec l’outil gratuit Zigbee2MQTT. Plusieurs possibilité d’installations. Les équipements sont intégrés avec leurs photos et commandes.
Zigbee2MQTT est disponible gratuitement ici : https://github.com/Koenkk/zigbee2mqtt.io
MQTT est disponible ici : https://mqtt.org/
Mosquitto-PHP est disponible ici : https://mosquitto-php.readthedocs.io/en/latest/overview.html

Installation

Vidéo de présentation

Merci à la chaîne Usine a Gaz Domotique pour cette vidéo de présentation.
Présentation des principales options pour bien démarrer avec le plugin.
Visionnage ici : Le plugin pour Zigbee to mqtt

Installation du plugin et de ses dépendances

Sur le Market Jeedom recherchez « zigbeelinker » :

Lorsque le plugin est installé, allez sur l’écran de configuration du plugin.
Deux options sont obligatoires avant l’installation des dépendances :

  • Dans la liste déroulante, sélectionnez le type d’installation :
  • Si Zigbee2MQTT est installé sur votre box, sélectionnez le type d’adaptateur :

Sauvegardez avec le bouton en face de Configuration (attention à ne pas vous tromper de bouton).

  • Maintenant, lancez l’installation des dépendances :
    Remarque importante : Effectuez l’installation en local et sans passer par le dns de Jeedom par exemple. Le service apache va redémarrer, et votre box risquerait de devenir indisponible temporairement.
  • C’est terminé, vérifiez que le statut du démon est bien sur OK (Laissez lui du temps, cela peut prendre 5mn pour une nouvelle installation) :

Explications sur les options d’installation

Plusieurs options sont possibles :

  • Solution complète locale : Tout pour démarrer sur votre Jeedom.
    L’adaptateur Zigbee est installé sur cette machine, et les équipements seront créés dans votre Jeedom.
  • Zigbee2mqtt + Client MQTT :
    Idem à la solution en dessus, mais le serveur MQTT sera géré par un autre plugin ou par vos soins.
  • Zigbee2mqtt + Serveur MQTT : Mode « Antenne »
    Permet de déporter l’adaptateur Zigbee (Ex : clé usb) sur une autre machine. Sur votre Jeedom principal, vous installez ce plugin avec l’option « Client MQTT » pour intégrer les équipements.
  • Client MQTT : Client seulement
    Zigbee2mqtt + MQTT sont sur une autre machine (pas d’installation sur cette machine). Ici vont remonter les équipements grâce au Client MQTT.
  • Zigbee2mqtt : Seulement Zigbee2mqtt
    Installer Zigbee2mqtt sur cette machine.

Ajout d’un Client MQTT

Pour que les équipements remontent dans votre Jeedom, il faut obligatoirement ajouter un Client MQTT.
Important : Un Client est automatiquement ajouté à votre installation si vous avez sélectionné l’option « Solution complète » ou une autre solution avec MQTT Server.
Dans d’autres cas, Client MQTT seulement par exemple, allez dans Plugins -> Protocole domotique -> ZigbeeLinker, et cliquez sur « Ajouter un client MQTT ».

Renseignez au minimum l’IP de la machine où est hébergé le serveur MQTT (si c’est sur la machine locale, ne renseignez rien, ce sera automatique).

Utilisation

Présentation

Les équipements se créent automatiquement et se gèrent comme tout équipement dans Jeedom.

Remarque : Il faut qu’un équipement se réveille pour remonter dans Jeedom. Pour réveiller une prise, actionnez là. Pour remonter un capteur, cliquez sur le petit bouton de réveil s’il en a un.

Onglet général

On retrouve la partie Général qui contient le nom de l’équipement, l’objet parent et les autres options des équipements Jeedom.

La partie Informations contient les éléments au sujet de l’appareil et un lien vers la documentation sur le site de Zigbee2MQTT.

Onglet commandes

Dans l’onglet commandes, nous avons accès aux commandes de l’équipement. Ces commandes sont automatiquement créées lorsque l’équipement est intégré dans Jeedom.

Il est possible d’ajouter d’autres commandes manuellement :

  • Valeur reçue : Si une valeur est reçue par Jeedom (via le Payload MQTT), mais n’est pas créée automatiquement. Il est possible de l’ajouter en spécifiant la clé (le nom) à écouter :
  • Envoyer un ordre : Permet d’envoyer un ordre de type {« clé » : « valeur »} à l’équipement. Par défaut la commande est /set, mais il est possible de la personnaliser.
  • Envoyer un ordre par payload : La même chose qu’au dessus mais cette option permet d’ajouter un ordre au format Payload.

Equipements en erreur

Si un équipement est souligné en rouge, c’est qu’il n’est pas intégré complètement. Cliquez sur l’équipement souligné en rouge.
Un carré rouge apparaît en haut de l’équipement :

Copiez le message avec le bouton « Copier le message », puis cliquez sur « Envoyer les informations … ».
Vous allez êtres redirigé vers Community de Jeedom.
Cliquez sur « Message direct » pour envoyer le message au Développeur.

Lorsque le développeur vous dira que l’équipement est corrigé. Attendez la prochaine mise à jour (et lancez là), puis retournez sur le plugin pour lancer une Synchronisation :