Ansible Роль zigbee2mqtt

Описание

Эта роль позволяет установить и настроить zigbee2mqtt на Raspberry Pi с установленной стандартной версией Raspbian lite или полной. Также должна работать на других дистрибутивах Debian.

Она предоставляет скрипт /usr/local/bin/zigbee2mqtt-backup для резервного копирования и восстановления конфигурации и базы данных устройств.

Роль основана на igami.zigbee2mqtt

Требования

Raspberry Pi с включенным SSH и USB-сканером CC2531.

Если вы устанавливаете на новую "безголовку" Raspberry Pi, добавьте пустой файл с именем 'ssh' в загрузочный каталог SD-карты, чтобы включить удаленный доступ по SSH.

Переменные роли

Переменная	Тип	По умолчанию	Комментарии
zigbee_user	строка	zigbee	Пользователь, запускающий zigbee2mqtt.
zigbee_user_groups	строка	tty,dialout	Необходимые группы для пользователя zigbee для доступа к последовательному порту.
zigbee_user_append	булевый	false	Если true, добавляет пользователя в группы, указанные в zigbee_user_groups. Если false, пользователь будет добавлен только в указанные группы, удаляя их из всех других групп.
zigbee_dir	строка	/opt/zigbee2mqtt	Каталог установки для zigbee2mqtt.
zigbee_repository	строка	https://github.com/Koenkk/zigbee2mqtt.git	URL репозитория git zigbee2mqtt, используемого для установки.
zigbee_version	строка	HEAD	Версия для установки (должен быть хеш коммита, имя ветки или тег).
zigbee_permit_join	булевый	false	Разрешить новым устройствам присоединяться.
zigbee_mqtt	объект		Настройки MQTT (см. zigbee_mqtt).
zigbee_advanced	объект		Расширенные настройки zigbee2mqtt для конфигурации адаптера и других параметров (см. zigbee_advanced).
zigbee_serial	объект		Настройки последовательного порта (см. zigbee_serial).
zigbee_frontend	объект/булевый		Если false, фронтенд будет отключен. Объект конфигурирует настройки фронтенда (см. zigbee_frontend).
zigbee_ota	объект		Настройки обновления прошивки устройств OTA (см. zigbee_ota).
zigbee_device_options	объект		Настройки параметров устройств (см. руководство по конфигурации устройств и групп).
zigbee_blocklist	объект		Черный список устройств (см. руководство по конфигурации черного списка / белого списка устройств).
zigbee_passlist	объект		Белый список устройств (см. руководство по конфигурации черного списка / белого списка устройств).
zigbee_external_converters	список объектов		Настройки внешних конвертеров (см. внешние конвертеры).
zigbee_map_options	объект		Настройки сетевой карты (см. руководство по конфигурации сетевой карты).
zigbee_availability	объект		Настройки функции доступности устройств (см. руководство по конфигурации доступности устройств). Если не определено, функция доступности будет отключена.
zigbee_homeassistant	объект		Настройки интеграции с Home Assistant (см. руководство по конфигурации интеграции с Home Assistant). Если не определено, интеграция с Home Assistant будет отключена.
zigbee_generate_new_network_key	булевый	false	Если true, принудительно сгенерировать новый сетевой ключ (только если сетевой ключ не указан в zigbee_advanced.network_key).

zigbee_mqtt

Подробности всех настроек можно найти в руководстве по конфигурации MQTT.

Переменная	Тип	По умолчанию	Комментарии
base_topic	строка	zigbee2mqtt	Основная тема для сообщений MQTT zigbee2mqtt.
server	строка	mqtt://localhost	URL для подключения к MQTT-серверу.
user	строка		Имя пользователя для подключения к MQTT-серверу.
password	строка		Пароль для подключения к MQTT-серверу.

zigbee_advanced

Подробности всех настроек можно найти в:

• руководстве по настройкам адаптера
• руководстве по Zigbee сети
• руководстве по логированию

Переменная	Тип	По умолчанию	Комментарии
pan_id	шестнадцатеричная	0x1a62	Идентификатор пан ZigBee.
ext_pan_id	массив	[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]	Расширенный идентификатор пан Zigbee.
channel	целое	11	Канал ZigBee (заметьте: используйте канал ZLL: 11, 15, 20 или 25, чтобы избежать проблем). Примечание: изменения требуют повторного подключения всех устройств.
network_key	строка	'!network_key network_key'	Ключ шифрования сети, повышает безопасность. Примечание: изменения требуют повторного подключения всех устройств.

zigbee_serial

Подробности всех настроек можно найти в руководстве по настройкам адаптера.

Переменная	Тип	По умолчанию	Комментарии
port	строка	/dev/ttyACM0	Местоположение USB-адаптера Zigbee.
baudrate	целое	115200	Скорость передачи для последовательного порта.
rtscts	булевый	false	Аппаратный контроль потока RTS/CTS для последовательного порта.

zigbee_frontend

Подробности всех настроек фронтенда можно найти в руководстве по фронтенду.

Переменная	Тип	По умолчанию	Комментарии
port	целое	8080	Порт, на котором работает фронтенд.

zigbee_ota

Подробности всех настроек можно найти в руководстве по обновлению прошивки устройств OTA.

Переменная	Тип	По умолчанию	Комментарии
ikea_ota_use_test_url	булевый	false	Использовать тестовый сервер OTA IKEA TRADFRI, смотрите документацию по OTA обновлениям.
update_check_interval	целое	1440	Минимальное время между проверками обновлений OTA.
disable_automatic_update_check	булевый	false	Отключить автоматические проверки обновлений.

zigbee_external_converters

Конфигурация внешних конвертеров.

Переменная	Тип	По умолчанию	Комментарии
name	строка		Имя внешнего конвертера.
script	строка		Скрипт внешнего конвертера.
state	строка	present	present создаст или обновит внешний конвертер. absent удалит существующий внешний конвертер.

Зависимости

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

Пример сценария

Чтобы установить zigbee2mqtt с использованием порта по умолчанию:

    - name: zigbee2mqtt на Raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - finalgene.zigbee2mqtt

Чтобы установить zigbee2mqtt с использованием пользовательского последовательного порта:

    - name: zigbee2mqtt на 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

Чтобы установить zigbee2mqtt с использованием порта по умолчанию и аутентификации MQTT:

    - name: zigbee2mqtt на Raspbian
      hosts: ip_address_of_rpi
      become: true

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

Лицензия

BSD

Информация об авторах

• igami
• Frank Giesecke