Welcome to Abeille!¶
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ébutez avec Abeille et Zigate.
Important
Cette documentation est en cours de « ré-écriture ».
Attention
Plugin en développement continu. Le développement n est pas terminé. De nombreux ajustements sont en cours …
Indication
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.
Cagnotte¶
Participez à la 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 utilisateurs 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 est aussi complètement transparente.
Abeille¶
Le chapitre Presentation contient les premières informations nécessaires à l’utilisation du plugin Abeille.
Installation¶
Pre-requis¶
Avant de vous lancer dans l’installation d’Abeille, vérifiez que vous avez un Système qui est dans le cadre de ce developpement.
Installation¶
La première étape est l”Installation du plugin dans Jeedom.
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 des équipements 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 Widget qui seront utilisés. C’est optionel. C’est juste pour faire beau.
Utilisation¶
Inclusion¶
La première étape pour pouvoir utiliser un équipement est de l” Inclusion 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” Inclusion et rejoigne le réseau.
Suppression¶
Vous avez la possibilité de faire une Suppression d’un équipement du réseau zigbee géré par la zigate.
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 Groupes . Cela permet d’avoir par exemple des équipements qui réagissent simultanément.
Scenes¶
Le Groupes 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 Scènes. Vous pouvez preconfigurer une ensemble d’équipments dans des configurations spécifiques est les associer à des Scènes. Ensuite il vous suffit de rappeler une Scènes pour remettre tout le monde dans la configuration désirée.
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: Santé
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.
Cron¶
Abeille de façon régulière fait Actions régulières (cron) un certain nombre de taches pour maintenir/monitorer le système.
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.
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.
Trucs et Astuces¶
D’autres fonctions de Jeedom sont bien pratiques, par exemple si vous devez Fonctions Jeedom remplacer des équipements par d’autres, ou Fonctions Jeedom des commandes par d’autres.
Equipements¶
Compatible¶
Liste des équipements compatibles Liste des équipements compatibles
Eurotronics¶
Ce chapithre regroupe les informations sur les équipements Eurotronics
Philips Hue¶
Ce chapithre regroupe les informations sur les équipements Philips Hue
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 link:https://github.com/KiwiHC16/Abeille/commits/master[Abeille GitHub]
Avancé¶
OnLine¶
Un statut Online est géré pour les équipements sur secteur. Le besoins était né du fait du plugin Homebridge. Plus de détails dans OnLine.
Debug¶
Si vous rencontrez des soucis, je vous propose ce chapitre Debug / Troubleshooting / Investigations vous donnant les méthodes à suivre pour vérifier les points de bon fonctionnement.
Developement¶
Si certains d’entre vous souhaitent comprendre ou modifier le code, vous des informations de base pour comprendre la structure de Developpement.
Modèles¶
Les équipements ZigBee sont representés dans Abeille par des fichiers de configuration appelés: Modele et Fichier JSON. Ces fichiers peuvent être modifiés et d’autres peuvent être créer pour ajouter de nouveau équipements.
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 qui me permet de s’implifier mon developpement et de faire des backup de mes Jeedom distant et difficilement accessibles.
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 Zigate 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.