README.md

smarthome.zigbee2mqtt

Installs the koenkk/zigbee2mqtt image.

Requirements

• A ZigBee Adapter.
• An MQTT server.

Role Variables

• zigbee2mqtt_version
  • Default: latest
  • Description: The version of the Zigbee2MQTT image to install. See published tags.
  • Type: str
  • Required: no
• zigbee2mqtt_network
  • Default: zigbee2mqtt
  • Description: The name of the Docker network.
  • Type: str
  • Required: no
• zigbee2mqtt_port
  • Default: 8124
  • Description: The port for the Zigbee2MQTT WebUI.
  • Type: int
  • Required: no
• zigbee2mqtt_install_dir
  • Default: /opt/docker/zigbee2mqtt
  • Description: The directory where Zigbee2MQTT will be installed.
  • Type: str
  • Required: no
• zigbee2mqtt_env
  • Default: {}
  • Description: Docker container environment variables. See zigbee2mqtt.io.
  • Type: dict
  • Required: no
• zigbee2mqtt_config
  • Default: See zigbee2mqtt_config_default
  • Description: Configuration for configuration.yaml. Must include server to operate.
  • Type: dict
  • Required: yes
• zigbee2mqtt_adapter
  • Default: ``
  • Description: Path to the ZigBee Adapter. See requirements.
  • Type: str
  • Required: yes

Dependencies

• community.docker

Example Playbook

- hosts: localhost

  vars:
    zigbee2mqtt_adapter: "/dev/ttyUSB0"
    zigbee2mqtt_config:
      mqtt:
        server: "mqtt://mosquitto"
        user: "mosquitto"
        password: "changeme"

  roles:
    - artyorsh.smarthome.zigbee2mqtt