Le manuel de l’utilisateur possède plusieurs chapitre essayant de détailler chaque sujet. En tant qu’utilisateur final, le chapitre tuto vous sera probablement le plus intéressant, mais noubliez pas les autres surtout si vous débuteez avec Abeille et Zigate.

Note Cette documentation est en cours de "ré-écriture".
Note Plugin en développement continu. Le développement n’est pas terminé. De nombreux ajustements sont en cours …
Note Cette documentation est la derniere version disponible. Elle ne dépend pas de la verion Abeille sur votre système. Cette doc peut d'écrire des fonctionalité pas encore disponibles dans votre système. Et inversement cette doc peut ne pas être à jour si des fonctions sont dans Abeille mais je n’ai pas fait la doc.

1. Cagnotte

Cagnotte pour acheter des équipements pour supporter le développement

Le budget depuis le début est assez conséquent, surtout quand j’investis dans des équipements que je n’utiliserai pas moi même. Alors j’ouvre une cagnotte pour financer l’achat d'équipements pour faciliter l’intégration dans Abeille. L’idée est d’avoir au moins un exemplaire de ce que les utilisateur d’Abeille utilisent. Je n’ai aucune idée de votre participation à cette cagnotte mais comme tout est open source depuis le début, la cagnotte sera aussi complètement transparente (Tous les détails).

2. Abeille

Le chapitre Présentation contient les premières informations nécessaires à l’utilisation du plugin Abeille.

Abeille_icon.png

3. Timer

Le plugin contient une fonctionalité Timer qui peut être utilisé avec ou sans la zigate et le réseau zigbee associé. Ces timers fonctionnent à la seconde ce qui n’existe pas à ma connaissance dans Jeedom.

node_Timer.png

4. Installation

4.1. Pre-requis

Avant de vous lancer dans l’installation d’Abeille, vérifiez que vous avez un systeme Jeedom qui est dans le cadre de ce developpement.

4.2. Installation

La première étape est l’installation du plugin dans Jeedom.

4.3. Parametrage

Une fois l’installation faite, il est nécessaire de vérifier la configuration du plugin et de l’adapter à votre situation, pour se faire il est nécessaire de faire le parametrage du plugin.

Quand tout est en place, vous allez ajouter des équipements. Afin d’avoir une interface graphique jolie dans Jeedom vous pouvez adapter les Widgets qui seront utilisés. C’est optionel. C’est juste pour faire beau.

5. Utilisation

5.1. Inclusion

La première étape pour pouvoir utiliser un équipement est de l’inclure dans le réseau zigbee géré par la zigate. Il n’existe pas de méthode universelle car chaque fabriquant est libre de procéder de la façon qu’il souhaite. Le grand principe est de mettre la zigate en mode inclusion et de faire des manipulations sur l'équipement pour qu’il s’inclus et rejoigne le réseau.

5.2. Groups

Un fois l'équipement dans le réseau, la zigate lui attribue une adresse pour qu’il puisse dialoguer. La zigate peut lui envoyer des messages directement à cette adresse. Maintenant si la ZiGate souhaite envoyer un même message à plusieurs équipements en même temps, elle peut utiliser une adresse de groupe. Cela permet d’avoir par exemple des équipements qui réagissent simultanément.

5.3. Scenes

Le groupe permet d’adresser des équipements en même temps pour une même action mais ne permet pas d’envoyer des demandes differentes. Ce point est résolu par les scenes. Vous pouvez preconfigurer une ensemble d'équipments dans des configurations spécifiques est les associer à des scenes. Ensuite il vous suffit de rappeler une scene pour remettre tout le monde dans la configuration désirée.

5.4. Santé

Le réseau est constitué de nombreux équipements qui vivent au rythme et aléa du réseau radio, des coupures de courant, etc. Afin de monitorer le réseau Abeille propose plusieurs outils: Health

5.5. Polling

Certains équipements communiquent naturellement et échangent des messages avec la Zigate, ce qui nous permet de s’assurer qu’ils sont en vie. D’autres restent silencieux et nous devons les interroger pour savoir s’ils sont toujours dans le réseau ou simplement connaitre leur état. Abeille contient une fonction de Polling interrogeant régulièrement les équipements.

5.6. Cron

Abeille de façon régulière fait un certain nombre de taches pour maintenir/monitorer le système.

5.7. Radio

Le ZigBee fonctionne en Radio. La radio est sujette à divers problemes. Même si la norme Zigbee inclus plein de fonction pour nous faciliter la vie, il arrive que cela ne fonctionne pas aussi bien qu’attendu. Pour avoir une meilleur comprehension de ce qui se passe, Abeille inclus des informations, graphes representant les informations radio récupérées par les équipements.

5.8. Tuto

Dans la mesure ou Abeille à pour objectif d’exploité le réseau, je vous propose quelques Tuto permettant de mettre en application et répondre à vos besoins.

5.9. Trucs et Astuces

D’autres fonctions de Jeedom sont bien pratiques, par exemple si vous devez remplacer des équipements par d’autres, ou des commandes par d’autres.

6. Equipements

6.1. Ikea

Ce chapithre regroupe les informations sur les équipements Ikea

6.2. Osram

Ce chapithre regroupe les informations sur les équipements OSRAM

6.3. Philips Hue

Ce chapithre regroupe les informations sur les équipements Philips Hue

6.4. Profalux

Ce chapithre regroupe les informations sur les équipements Profalux

6.5. Xiaomi

Ce chapithre regroupe les informations sur les équipements Xiaomi

6.6. Eurotronics

Ce chapithre regroupe les informations sur les équipements Eurotronics

6.7. Livolo

Ce chapithre regroupe les informations sur les équipements Livolo

7. Changelog

Afin de vous donner de la visibilité sur l'évolution du plugin vous trouverez des informations génériques dans ChangeLog. Bien évidement pour les personnes qui savent développer toutes les informations sont disponibles dans Abeille GitHub

8. Avancé

8.1. Debug

Si vous rencontrez des soucis, je vous propose ce chapitre Debug vous donnant les méthodes à suivre pour vérifier les points de bon fonctionnement.

8.2. Developement

Si certains d’entre vous souhaitent comprendre ou modifier le code, vous des informations de base pour comprendre la structure de developpement.

8.3. Modèles

Les équipements ZigBee sont representés dans Abeille par des fichiers de configuration appelés: Modeles Json. Ces fichiers peuvent être modifiés et d’autres peuvent être créer pour ajouter de nouveau équipements.

8.4. Docker / VM

Ce chapitre est très spécifique et pour les utilisateurs ayant de bonnes connaissances en informatique. Je partage ici mon installation docker/VM qui me permet de s’implifier mon developpement et de faire des backup de mes Jeedom distant et difficilement accessibles.

8.5. Backup/Restore

Ce chapitre ne devrait être utilisé que pour les personnes qui developpe le firmware ZiGate et qui comprennent ce qu’ils font. Cela permet de faire un Backup-Restore de l’EEPROM Zigate. Pour les autres SVP ne jouez pas avec cette méthode cela vous amenera plus de soucis de de biens.

8.6. Wifi

J’ai developpé mon propre module Wifi du fait de petits soucis sur le premier module disponible. Finalement il fonctionne tellement bien et fourni une protection coupure electrique avec une batterie que je l’utilise dans toutes configuration et mêm avec mon sniffer ZigBee …