Rola Ansible zigbee2mqtt

Opis

Ta rola pozwala na instalację i konfigurację zigbee2mqtt na Raspberry Pi z systemem Raspbian lite lub pełnym. Powinna również działać na innych dystrybucjach Debiana.

Zapewnia skrypt /usr/local/bin/zigbee2mqtt-backup do tworzenia kopii zapasowej i przywracania konfiguracji oraz bazy urządzeń.

Rola opiera się na igami.zigbee2mqtt

Wymagania

Raspberry Pi z włączonym SSH i skanerem USB CC2531.

Jeśli instalujesz na nowym serwerze Raspberry Pi bez interfejsu graficznego, dodaj pusty plik o nazwie 'ssh' do katalogu startowego karty SD, aby włączyć zdalny dostęp SSH.

Zmienne roli

Zmienna	Typ	Domyślna	Komentarze
zigbee_user	tekst	zigbee	Użytkownik uruchamiający zigbe2mqtt.
zigbee_user_groups	tekst	tty,dialout	Konieczne grupy dla użytkownika zigbee, aby móc uzyskać dostęp do portu szeregowego.
zigbee_user_append	boolean	false	Jeśli true, dodaje użytkownika do grup określonych w zigbee_user_groups. Jeśli false, użytkownik będzie dodany tylko do grup określonych w zigbee_user_groups, usuwając go z innych grup.
zigbee_dir	tekst	/opt/zigbee2mqtt	Katalog instalacji dla zigbee2mqtt.
zigbee_repository	tekst	https://github.com/Koenkk/zigbee2mqtt.git	URL do repozytorium git zigbee2mqtt używanego do instalacji.
zigbee_version	tekst	HEAD	Wersja do zainstalowania (powinna być skrótem commit, nazwą gałęzi lub tagiem).
zigbee_permit_join	boolean	false	Zezwól nowym urządzeniom na dołączenie.
zigbee_mqtt	obiekt		Ustawienia MQTT (patrz zigbee_mqtt).
zigbee_advanced	obiekt		Zaawansowane ustawienia zigbee2mqtt do konfiguracji adaptera i innych rzeczy (patrz zigbee_advanced).
zigbee_serial	obiekt		Ustawienia portu szeregowego (patrz zigbee_serial).
zigbee_frontend	obiekt/boolean		Jeśli false, frontend będzie wyłączony. Obiekt skonfiguruje ustawienia frontendu (patrz zigbee_frontend).
zigbee_ota	obiekt		Ustawienia aktualizacji oprogramowania urządzeń OTA (patrz zigbee_ota).
zigbee_device_options	obiekt		Ustawienia opcji dla urządzeń (patrz przewodnik konfiguracyjny dla urządzeń i grup).
zigbee_blocklist	obiekt		Lista zablokowanych urządzeń (patrz przewodnik konfiguracyjny dotyczący listy zablokowanej/puszczonej).
zigbee_passlist	obiekt		Lista dozwolonych urządzeń (patrz przewodnik konfiguracyjny dotyczący listy zablokowanej/puszczonej).
zigbee_external_converters	lista obiektów		Ustawienia konwerterów zewnętrznych (patrz konwertery zewnętrzne).
zigbee_map_options	obiekt		Ustawienia mapy sieci (patrz przewodnik konfiguracyjny dotyczący mapy sieci).
zigbee_availability	obiekt		Ustawienia funkcji dostępności urządzeń (patrz przewodnik konfiguracyjny dotyczący dostępności urządzeń). Jeśli nie jest zdefiniowana, funkcja dostępności urządzenia będzie wyłączona.
zigbee_homeassistant	obiekt		Ustawienia integracji z Home Assistant (patrz przewodnik konfiguracyjny dotyczący integracji z Home Assistant). Jeśli nie jest zdefiniowana, integracja z Home Assistant będzie wyłączona.
zigbee_generate_new_network_key	boolean	false	Jeśli true, wymusza wygenerowanie nowego klucza sieciowego (tylko jeśli nie podano klucza sieciowego w zigbee_advanced.network_key).

zigbee_mqtt

Szczegóły wszystkich ustawień można znaleźć w przewodniku konfiguracyjnym dla MQTT.

Zmienna	Typ	Domyślna	Komentarze
base_topic	tekst	zigbee2mqtt	Główny temat dla wiadomości MQTT zigbee2mqtt.
server	tekst	mqtt://localhost	URL do połączenia z serwerem MQTT.
user	tekst		Nazwa użytkownika do połączenia z serwerem MQTT.
password	tekst		Hasło do połączenia z serwerem MQTT.

zigbee_advanced

Szczegóły wszystkich ustawień można znaleźć w:

• przewodniku konfiguracyjnym dla ustawień adaptera
• przewodniku konfiguracyjnym dla sieci zigbee
• przewodniku konfiguracyjnym dotyczącym logowania

Zmienna	Typ	Domyślna	Komentarze
pan_id	hex	0x1a62	ZigBee pan ID.
ext_pan_id	tablica	[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]	Rozszerzony pan ID Zigbee.
channel	liczba	11	Z kanał ZigBee (Uwaga: Użyj kanału ZLL: 11, 15, 20 lub 25, aby uniknąć problemów). Uwaga: Zmiana wymaga ponownego sparowania wszystkich urządzeń.
network_key	tekst	'!network_key network_key'	Klucz szyfrowania sieci, poprawi bezpieczeństwo. Uwaga: Zmiana wymaga ponownego sparowania wszystkich urządzeń.

zigbee_serial

Szczegóły wszystkich ustawień można znaleźć w przewodniku konfiguracyjnym dla ustawień adaptera.

Zmienna	Typ	Domyślna	Komentarze
port	tekst	/dev/ttyACM0	Lokalizacja adaptera USB zigbee.
baudrate	liczba	115200	Prędkość baud dla portu szeregowego.
rtscts	boolean	false	Kontrola przepływu sprzętowego RTS / CTS dla portu szeregowego.

zigbee_frontend

Szczegóły wszystkich ustawień frontendu można znaleźć w przewodniku konfiguracyjnym dla frontendu.

Zmienna	Typ	Domyślna	Komentarze
port	liczba	8080	Port, którego nasłuchuje frontend.

zigbee_ota

Szczegóły wszystkich ustawień można znaleźć w przewodniku konfiguracyjnym dla aktualizacji oprogramowania urządzeń OTA.

Zmienna	Typ	Domyślna	Komentarze
ikea_ota_use_test_url	boolean	false	Użyj testowego serwera OTA IKEA TRADFRI, zobacz dokumentację aktualizacji OTA.
update_check_interval	liczba	1440	Minimum czas między sprawdzeniami aktualizacji OTA.
disable_automatic_update_check	boolean	false	Wyłącz automatyczne sprawdzanie aktualizacji.

zigbee_external_converters

Konfiguracja zewnętrznych konwerterów.

Zmienna	Typ	Domyślna	Komentarze
name	tekst		Nazwa zewnętrznego konwertera.
script	tekst		Skrypt konwertera zewnętrznego.
state	tekst	present	present utworzy lub zaktualizuje zewnętrzny konwerter. absent usunie istniejący zewnętrzny konwerter.

Zależności

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

Przykład Playbooka

Aby zainstalować zigbee2mqtt z domyślnym portem szeregowym:

- name: zigbee2mqtt octoprint na raspbianie
  hosts: ip_address_of_rpi
  become: true

  roles:
  - finalgene.zigbee2mqtt

Aby zainstalować zigbee2mqtt z niestandardowym portem szeregowym:

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

Aby zainstalować zigbee2mqtt z domyślnym portem szeregowym i autoryzacją MQTT:

- name: zigbee2mqtt octoprint na raspbianie
  hosts: ip_address_of_rpi
  become: true

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

Licencja

BSD

Informacje o autorze

• igami
• Frank Giesecke