finalgene.zigbee2mqtt

Descripción general Versiones Perspectivas

Rol de Ansible zigbee2mqtt

Descripción

Este rol permite instalar y configurar zigbee2mqtt en una Raspberry Pi que corre Raspbian lite o completo. También debería funcionar en otras distribuciones de Debian.

Proporciona un script /usr/local/bin/zigbee2mqtt-backup para hacer copias de seguridad y restaurar la configuración y la base de datos de dispositivos.

El rol está basado en igami.zigbee2mqtt

Requisitos

Raspberry Pi con SSH habilitado y un sniffer USB CC2531.

Si se instala en un servidor 'headless' (sin interfaz gráfica) de Raspberry Pi, agrega un archivo vacío llamado 'ssh' en el directorio de arranque de la tarjeta SD para habilitar el acceso SSH remoto.

Variables del Rol

Variable Tipo Predeterminado Comentarios
zigbee_user cadena zigbee Usuario que ejecuta zigbee2mqtt.
zigbee_user_groups cadena tty,dialout Grupos necesarios para que el usuario zigbee pueda acceder al puerto serie.
zigbee_user_append booleano false Si es true, añade al usuario a los grupos especificados en zigbee_user_groups.
Si es false, el usuario sólo será agregado a estos grupos, removiéndolo de otros grupos.
zigbee_dir cadena /opt/zigbee2mqtt Directorio de instalación para zigbee2mqtt.
zigbee_repository cadena https://github.com/Koenkk/zigbee2mqtt.git URL del repositorio git de zigbee2mqtt utilizado para la instalación.
zigbee_version cadena HEAD Versión a instalar (debe ser un hash de commit, nombre de rama o etiqueta).
zigbee_permit_join booleano false Permitir que nuevos dispositivos se unan.
zigbee_mqtt objeto Configuración de MQTT (ver zigbee_mqtt).
zigbee_advanced objeto Configuraciones avanzadas de zigbee2mqtt para configurar el adaptador y otras cosas (ver zigbee_advanced).
zigbee_serial objeto Configuración del puerto serie (ver zigbee_serial).
zigbee_frontend objeto/booleano Si es false, se deshabilitará el frontend. Un objeto configurará los ajustes del frontend (ver zigbee_frontend).
zigbee_ota objeto Configuraciones de actualización de firmware OTA de dispositivos (ver zigbee_ota).
zigbee_device_options objeto Configuraciones de opciones de dispositivo (ver la guía de configuración para dispositivos y grupos).
zigbee_blocklist objeto Lista de dispositivos bloqueados (ver la guía de configuración para lista de bloqueos/pasa).
zigbee_passlist objeto Lista de dispositivos permitidos (ver la guía de configuración para lista de bloqueos/pasa).
zigbee_external_converters lista de objetos Configuración de convertidores externos (ver convertidores externos).
zigbee_map_options objeto Configuraciones del mapa de red (ver la guía de configuración para mapa de red).
zigbee_availability objeto Configuraciones de la función de disponibilidad del dispositivo (ver la guía de configuración para disponibilidad de dispositivos).
Si no está definido, la función de disponibilidad se deshabilitará.
zigbee_homeassistant objeto Configuraciones de integración con Home Assistant (ver la guía de configuración para integración con Home Assistant).
Si no está definido, la integración con Home Assistant se deshabilitará.
zigbee_generate_new_network_key booleano false Si es true, forzar a generar una nueva clave de red (solo si no se especifica una clave de red en zigbee_advanced.network_key).

zigbee_mqtt

Los detalles de todos los ajustes se pueden encontrar en la guía de configuración para MQTT.

Variable Tipo Predeterminado Comentarios
base_topic cadena zigbee2mqtt Tema base para los mensajes MQTT de zigbee2mqtt.
server cadena mqtt://localhost URL para conectarse al servidor MQTT.
user cadena Nombre de usuario para conectarse al servidor MQTT.
password cadena Contraseña para conectarse al servidor MQTT.

zigbee_advanced

Los detalles de todos los ajustes se pueden encontrar en:

Variable Tipo Predeterminado Comentarios
pan_id hex 0x1a62 ID pan de ZigBee.
ext_pan_id array [0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD] ID pan extendido de ZigBee.
channel entero 11 Canal ZigBee (Nota: Usa un canal ZLL: 11, 15, 20 o 25 para evitar problemas).
Nota: Cambiar requiere reparar todos los dispositivos.
network_key cadena '!network_key network_key' Clave de encriptación de red, mejora la seguridad.
Nota: Cambiar requiere reparar todos los dispositivos.

zigbee_serial

Los detalles de todos los ajustes se pueden encontrar en la guía de configuración para ajustes del adaptador.

Variable Tipo Predeterminado Comentarios
port cadena /dev/ttyACM0 Ubicación del adaptador USB zigbee.
baudrate entero 115200 Velocidad de baud para el puerto serie.
rtscts booleano false Control de flujo hardware RTS / CTS para el puerto serie.

zigbee_frontend

Los detalles de todas las configuraciones del frontend se pueden encontrar en la guía de configuración para el frontend.

Variable Tipo Predeterminado Comentarios
port entero 8080 Puerto que escucha el frontend.

zigbee_ota

Los detalles de todas las configuraciones se pueden encontrar en la guía de configuración para actualización de firmware OTA de dispositivos.

Variable Tipo Predeterminado Comentarios
ikea_ota_use_test_url booleano false Usar servidor de prueba OTA de IKEA TRADFRI, ver documentación de actualizaciones OTA.
update_check_interval entero 1440 Tiempo mínimo entre verificaciones de actualización OTA.
disable_automatic_update_check booleano false Desactivar verificaciones automáticas de actualizaciones.

zigbee_external_converters

Configuración de convertidores externos.

Variable Tipo Predeterminado Comentarios
name cadena Nombre del convertidor externo.
script cadena Script del convertidor externo.
state cadena present present creará o actualizará el convertidor externo.
absent eliminará un convertidor externo existente.

Dependencias

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

Ejemplo de Playbook

Para instalar zigbee2mqtt con el puerto serie predeterminado:

    - name: zigbee2mqtt en octoprint sobre raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - finalgene.zigbee2mqtt

Para instalar zigbee2mqtt con un puerto serie personalizado:

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

Para instalar zigbee2mqtt con puerto serie predeterminado y autenticación MQTT:

    - name: zigbee2mqtt en octoprint sobre raspbian
      hosts: ip_address_of_rpi
      become: true

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

Licencia

BSD

Información del Autor

Acerca del proyecto

zigbee2mqtt on Raspbian

role mqtt raspberrypi raspbian zigbee zigbee2mqtt
Instalar
ansible-galaxy install finalgene.zigbee2mqtt
GitHub repositorio
1 estrellas
1 bifurcaciones
0 problemas abiertos
Licencia
Unknown
Descargas
421
Propietario
final gene
Software Development