igami.zigbee2mqtt

Role Name

igami.zigbee2mqtt

This Ansible role installs zigbee2mqtt on a Raspberry Pi using either Raspbian Lite or Full. It should also work on other Debian versions.

More information: Zigbee2MQTT Documentation

Requirements

You need a Raspberry Pi with SSH enabled and a CC2531 USB sniffer. If you're setting up a new 'headless' Raspberry Pi, create an empty file named 'ssh' in the boot directory of the SD card to allow SSH access.

Role Variables

zigbee_user: zigbee
zigbee_user_groups: tty,dialout
zigbee_user_append: false
zigbee_dir: /opt/zigbee2mqtt
zigbee_repository: https://github.com/Koenkk/zigbee2mqtt.git
zigbee_homeassistant: false
zigbee_permit_join: true
zigbee_mqtt_base_topic: zigbee2mqtt
zigbee_mqtt_server: mqtt://localhost
zigbee_serial_port: /dev/ttyACM0
zigbee_mqtt_user: (leave blank for no user)
zigbee_mqtt_password: (leave blank for no password)
zigbee_network_key: "'!network_key network_key'"
Zigbee2mqtt uses a default encryption key. It's recommended to change this key.
By default, this role generates a random key on the first run.
zigbee_generate_new_network_key: no

Dependencies

npm version 5.8 or higher
nodejs version 10 or higher

Example Playbook

To install zigbee2mqtt using the default serial port:

    - name: zigbee2mqtt installation on Raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - igami.zigbee2mqtt

To install zigbee2mqtt with a specific serial port:

    - name: zigbee2mqtt installation on Raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - role: igami.zigbee2mqtt
        vars: 
          zigbee_serial_port: /dev/serial/by-id/usb-Texas_Instruments_TI_CC2531_USB_CDC___0X00124B0018ED3DDF-if00

To install zigbee2mqtt with the default serial port and MQTT authentication:

    - name: zigbee2mqtt installation on Raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - role: igami.zigbee2mqtt
        vars: 
          zigbee_mqtt_user: mqtt_user
          zigbee_mqtt_password: mqtt_password