Rôle Ansible zigbee2mqtt

Description

Ce rôle permet d'installer et de configurer zigbee2mqtt sur un Raspberry Pi fonctionnant avec Raspbian Lite ou complet. Il devrait également fonctionner sur d'autres distributions Debian.

Il fournit un script /usr/local/bin/zigbee2mqtt-backup pour sauvegarder et restaurer la configuration et la base de données des appareils.

Le rôle est basé sur igami.zigbee2mqtt

Exigences

Un Raspberry Pi avec SSH activé et un sniffteur USB CC2531.

Si vous installez sur un nouveau serveur Raspberry Pi sans interface graphique, ajoutez un fichier vide nommé 'ssh' au répertoire de démarrage de la carte SD pour activer l'accès SSH à distance.

Variables du Rôle

Variable	Type	Par défaut	Commentaires
zigbee_user	chaîne	zigbee	Utilisateur exécutant zigbee2mqtt.
zigbee_user_groups	chaîne	tty,dialout	Groupes nécessaires pour que l'utilisateur zigbee puisse accéder au port série.
zigbee_user_append	booléen	false	Si true, ajoute l'utilisateur aux groupes spécifiés dans zigbee_user_groups. Si false, l'utilisateur sera seulement ajouté aux groupes spécifiés dans zigbee_user_groups, en les retirant de tous les autres groupes.
zigbee_dir	chaîne	/opt/zigbee2mqtt	Répertoire d'installation pour zigbee2mqtt.
zigbee_repository	chaîne	https://github.com/Koenkk/zigbee2mqtt.git	URL du dépôt git zigbee2mqtt utilisé pour l'installation.
zigbee_version	chaîne	HEAD	Version à installer (doit être un hash de commit, un nom de branche ou un tag).
zigbee_permit_join	booléen	false	Autoriser de nouveaux appareils à se connecter.
zigbee_mqtt	objet		Paramètres MQTT (voir zigbee_mqtt).
zigbee_advanced	objet		Paramètres avancés de zigbee2mqtt pour configurer l'adaptateur et d'autres éléments (voir zigbee_advanced).
zigbee_serial	objet		Paramètres du port série (voir zigbee_serial).
zigbee_frontend	objet/booléen		Si false, le frontend sera désactivé. Un objet configurera les paramètres du frontend (voir zigbee_frontend).
zigbee_ota	objet		Paramètres de mise à jour du firmware des appareils OTA (voir zigbee_ota).
zigbee_device_options	objet		Paramètres des options des appareils (voir le guide de configuration des appareils et groupes).
zigbee_blocklist	objet		Liste noire des appareils (voir le guide de configuration de la liste noire / liste autorisée).
zigbee_passlist	objet		Liste blanche des appareils (voir le guide de configuration de la liste noire / liste autorisée).
zigbee_external_converters	liste d'objets		Paramètres des convertisseurs externes (voir les convertisseurs externes).
zigbee_map_options	objet		Paramètres de la carte réseau (voir le guide de configuration de la carte réseau).
zigbee_availability	objet		Paramètres de la fonctionnalité de disponibilité des appareils (voir le guide de configuration de la disponibilité des appareils). Si non défini, la fonctionnalité sera désactivée.
zigbee_homeassistant	objet		Paramètres d'intégration avec Home Assistant (voir le guide de configuration pour l'intégration avec Home Assistant). Si non défini, l'intégration sera désactivée.
zigbee_generate_new_network_key	booléen	false	Si true, force la génération d'une nouvelle clé réseau (uniquement si aucune clé réseau n'est spécifiée dans zigbee_advanced.network_key).

zigbee_mqtt

Les détails de tous les paramètres peuvent être trouvés dans le guide de configuration pour MQTT.

Variable	Type	Par défaut	Commentaires
base_topic	chaîne	zigbee2mqtt	Sujet de base pour les messages MQTT de zigbee2mqtt.
server	chaîne	mqtt://localhost	URL pour se connecter au serveur MQTT.
user	chaîne		Nom d'utilisateur pour se connecter au serveur MQTT.
password	chaîne		Mot de passe pour se connecter au serveur MQTT.

zigbee_advanced

Les détails de tous les paramètres peuvent être trouvés dans :

• le guide de configuration des paramètres d'adaptateur
• le guide de configuration du réseau zigbee
• le guide de configuration des journaux

Variable	Type	Par défaut	Commentaires
pan_id	hex	0x1a62	ID de pan ZigBee.
ext_pan_id	tableau	[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]	ID de pan étendu Zigbee.
channel	entier	11	Canal ZigBee (Remarque: Utilisez un canal ZLL : 11, 15, 20 ou 25 pour éviter des problèmes). Remarque: Changer nécessite de réparer tous les appareils.
network_key	chaîne	'!network_key network_key'	Clé de cryptage du réseau, améliorera la sécurité. Remarque: Changer nécessite de réparer tous les appareils.

zigbee_serial

Les détails de tous les paramètres peuvent être trouvés dans le guide de configuration des paramètres d'adaptateur.

Variable	Type	Par défaut	Commentaires
port	chaîne	/dev/ttyACM0	Emplacement de l'adaptateur USB zigbee.
baudrate	entier	115200	Vitesse de transmission pour le port série.
rtscts	booléen	false	Contrôle de flux matériel RTS / CTS pour le port série.

zigbee_frontend

Les détails de tous les paramètres du frontend peuvent être trouvés dans le guide de configuration du frontend.

Variable	Type	Par défaut	Commentaires
port	entier	8080	Port sur lequel le frontend écoute.

zigbee_ota

Les détails de tous les paramètres peuvent être trouvés dans le guide de configuration des mises à jour de firmware des appareils OTA.

Variable	Type	Par défaut	Commentaires
ikea_ota_use_test_url	booléen	false	Utiliser le serveur de test OTA IKEA TRADFRI, voir la documentation sur les mises à jour OTA.
update_check_interval	entier	1440	Temps minimum entre les vérifications de mise à jour OTA.
disable_automatic_update_check	booléen	false	Désactiver les vérifications automatiques de mise à jour.

zigbee_external_converters

Configuration des convertisseurs externes.

Variable	Type	Par défaut	Commentaires
name	chaîne		Nom du convertisseur externe.
script	chaîne		Script du convertisseur externe.
state	chaîne	present	present créera ou mettra à jour le convertisseur externe. absent supprimera un convertisseur externe existant.

Dépendances

• git
• npm >=5.8
• nodejs >=10

Exemple de Playbook

Pour installer zigbee2mqtt avec le port série par défaut :

    - name: zigbee2mqtt octoprint sur raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - finalgene.zigbee2mqtt

Pour installer zigbee2mqtt avec un port série personnalisé :

    - name: zigbee2mqtt octoprint sur raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - role: finalgene.zigbee2mqtt
        vars: 
          zigbee_serial:
            port: /dev/serial/by-id/usb-Texas_Instruments_TI_CC2531_USB_CDC___0X00124B0018ED3DDF-if00

Pour installer zigbee2mqtt avec le port série par défaut et une authentification MQTT :

    - name: zigbee2mqtt octoprint sur raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - role: finalgene.zigbee2mqtt
        vars:
          zigbee_mqtt:
            user: mqtt_user
            password: mqtt_password

Licence

BSD

Informations sur les Auteurs

• igami
• Frank Giesecke