Ansible-Rolle zigbee2mqtt

Beschreibung

Diese Rolle ermöglicht die Installation und Konfiguration von zigbee2mqtt auf einem Raspberry Pi, der mit stock Raspbian lite oder full läuft. Sie sollte auch auf anderen Debian-Distributionen funktionieren.

Es stellt ein Skript /usr/local/bin/zigbee2mqtt-backup zur Verfügung, um die Konfiguration und die Geräte-Datenbank zu sichern und wiederherzustellen.

Die Rolle basiert auf igami.zigbee2mqtt.

Anforderungen

Raspberry Pi mit aktiviertem SSH und CC2531 USB-Sniffer.

Wenn Sie auf einem neuen 'headless' Raspberry Pi-Server installieren, fügen Sie eine leere Datei mit dem Namen 'ssh' in das Boot-Verzeichnis der SD-Karte ein, um den Remote-SSH-Zugang zu aktivieren.

Rollenvariablen

Variable	Typ	Standard	Kommentare
zigbee_user	string	zigbee	Benutzer, der zigbee2mqtt ausführt.
zigbee_user_groups	string	tty,dialout	Notwendige Gruppen für den Zigbee-Benutzer, um auf den Serial-Port zugreifen zu können.
zigbee_user_append	boolean	false	Wenn true, wird der Benutzer zu den in zigbee_user_groups angegebenen Gruppen hinzugefügt. Wenn false, wird der Benutzer nur zu den in zigbee_user_groups angegebenen Gruppen hinzugefügt, wobei alle anderen Gruppen entfernt werden.
zigbee_dir	string	/opt/zigbee2mqtt	Installationsverzeichnis für zigbee2mqtt.
zigbee_repository	string	https://github.com/Koenkk/zigbee2mqtt.git	URL des Git-Repositorys von zigbee2mqtt, das für die Installation verwendet wird.
zigbee_version	string	HEAD	Version, die installiert werden soll (sollte ein Commit-Hash, ein Branch oder ein Tag-Name sein).
zigbee_permit_join	boolean	false	Erlaubt neuen Geräten, sich zu verbinden.
zigbee_mqtt	object		MQTT-Einstellungen (siehe zigbee_mqtt).
zigbee_advanced	object		Erweiterte zigbee2mqtt-Einstellungen zur Konfiguration des Adapters und anderer Dinge (siehe zigbee_advanced).
zigbee_serial	object		Einstellungen für den Serial-Port (siehe zigbee_serial).
zigbee_frontend	object/boolean		Wenn false, wird das Frontend deaktiviert. Ein Objekt konfiguriert die Frontend-Einstellungen (siehe zigbee_frontend).
zigbee_ota	object		OTA-Geräte-Firmware-Update-Einstellungen (siehe zigbee_ota).
zigbee_device_options	object		Einstellungen für Geräteoptionen (siehe den Konfigurationsleitfaden für Geräte und Gruppen).
zigbee_blocklist	object		Gerätblockliste (siehe den Konfigurationsleitfaden für die Gerätblockliste / Passliste).
zigbee_passlist	object		Gerätpassliste (siehe den Konfigurationsleitfaden für die Gerätblockliste / Passliste).
zigbee_external_converters	list of objects		Einstellungen für externe Konverter (siehe die externen Konverter).
zigbee_map_options	object		Einstellungen für die Netzwerk-Karte (siehe den Konfigurationsleitfaden zur Netzwerk-Karte).
zigbee_availability	object		Einstellungen für die Geräteverfügbarkeit (siehe den Konfigurationsleitfaden zur Geräteverfügbarkeit). Wenn nicht definiert, wird die Funktion zur Geräteverfügbarkeit deaktiviert.
zigbee_homeassistant	object		Einstellungen zur Integration mit Home Assistant (siehe den Konfigurationsleitfaden zur Home Assistant-Integration). Wenn nicht definiert, wird die Home Assistant-Integration deaktiviert.
zigbee_generate_new_network_key	boolean	false	Wenn true, erzwingt die Generierung eines neuen Netzwerk-Schlüssels (nur wenn kein Netzwerk-Schlüssel in zigbee_advanced.network_key angegeben ist).

zigbee_mqtt

Details zu allen Einstellungen finden Sie im Konfigurationsleitfaden für MQTT.

Variable	Typ	Standard	Kommentare
base_topic	string	zigbee2mqtt	Basis-Thema für zigbee2mqtt MQTT-Nachrichten.
server	string	mqtt://localhost	URL zur Verbindung zum MQTT-Server.
user	string		Benutzername zur Verbindung zum MQTT-Server.
password	string		Passwort zur Verbindung zum MQTT-Server.

zigbee_advanced

Details zu allen Einstellungen finden Sie in:

• dem Konfigurationsleitfaden für Adaptereinstellungen
• dem Konfigurationsleitfaden für das Zigbee-Netzwerk
• dem Konfigurationsleitfaden für Logging

Variable	Typ	Standard	Kommentare
pan_id	hex	0x1a62	ZigBee PAN-ID.
ext_pan_id	array	[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]	Zigbee erweiterte PAN-ID.
channel	integer	11	ZigBee-Kanal (Hinweis: Verwenden Sie einen ZLL-Kanal: 11, 15, 20 oder 25, um Probleme zu vermeiden). Hinweis: Eine Änderung erfordert das Reparieren aller Geräte.
network_key	string	'!network_key network_key'	Netzwerk-Verschlüsselungsschlüssel, der die Sicherheit verbessert. Hinweis: Eine Änderung erfordert das Reparieren aller Geräte.

zigbee_serial

Details zu allen Einstellungen finden Sie im Konfigurationsleitfaden für Adaptereinstellungen.

Variable	Typ	Standard	Kommentare
port	string	/dev/ttyACM0	Standort des Zigbee-USB-Adapters.
baudrate	integer	115200	Baudrate für den seriellen Port.
rtscts	boolean	false	RTS/CTS Hardware-Flusskontrolle für den seriellen Port.

zigbee_frontend

Details zu allen Frontend-Einstellungen finden Sie im Konfigurationsleitfaden für das Frontend.

Variable	Typ	Standard	Kommentare
port	integer	8080	Port, auf dem das Frontend hört.

zigbee_ota

Details zu allen Einstellungen finden Sie im Konfigurationsleitfaden für OTA-Geräte-Firmware-Updates.

Variable	Typ	Standard	Kommentare
ikea_ota_use_test_url	boolean	false	Verwende den IKEA TRADFRI OTA-Testserver, siehe OTA-Dokumentation.
update_check_interval	integer	1440	Minimale Zeit zwischen OTA-Update-Prüfungen.
disable_automatic_update_check	boolean	false	Deaktivieren Sie automatische Update-Prüfungen.

zigbee_external_converters

Konfiguration der externen Konverter.

Variable	Typ	Standard	Kommentare
name	string		Name des externen Konverters.
script	string		Externes Konverter-Skript.
state	string	present	present erstellt oder aktualisiert den externen Konverter. absent entfernt einen bestehenden externen Konverter.

Abhängigkeiten

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

Beispiel-Playbook

Um zigbee2mqtt mit dem Standard-Serial-Port zu installieren:

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

      roles:
      - finalgene.zigbee2mqtt

Um zigbee2mqtt mit einem benutzerdefinierten Serial-Port zu installieren:

    - name: zigbee2mqtt octoprint auf 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

Um zigbee2mqtt mit dem Standard-Serial-Port und MQTT-Authentifizierung zu installieren:

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

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

Lizenz

BSD

Autor Informationen

• igami
• Frank Giesecke