xoxys.zigbee2mqtt/README.md

# xoxys.zigbee2mqtt

[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.zigbee2mqtt/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.zigbee2mqtt)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.zigbee2mqtt/src/branch/main/LICENSE)

Setup [zigbee2mqtt](https://github.com/Koenkk/zigbee2mqtt). Zigbee2mqtt allows you to use your
Zigbee devices without the vendors bridge or gateway. It bridges events and allows you to control
your Zigbee devices via MQTT.

## Table of content

- [Requirements](#requirements)
- [Default Variables](#default-variables)
  - [zigbee2mqtt_cache_state](#zigbee2mqtt_cache_state)
  - [zigbee2mqtt_cap_add](#zigbee2mqtt_cap_add)
  - [zigbee2mqtt_cap_drop](#zigbee2mqtt_cap_drop)
  - [zigbee2mqtt_channel](#zigbee2mqtt_channel)
  - [zigbee2mqtt_data_volume](#zigbee2mqtt_data_volume)
  - [zigbee2mqtt_device_options](#zigbee2mqtt_device_options)
  - [zigbee2mqtt_devices](#zigbee2mqtt_devices)
  - [zigbee2mqtt_devices_ban](#zigbee2mqtt_devices_ban)
  - [zigbee2mqtt_devices_whitelist](#zigbee2mqtt_devices_whitelist)
  - [zigbee2mqtt_docker_args](#zigbee2mqtt_docker_args)
  - [zigbee2mqtt_elapsed](#zigbee2mqtt_elapsed)
  - [zigbee2mqtt_exposed_ports](#zigbee2mqtt_exposed_ports)
  - [zigbee2mqtt_ext_pan_id](#zigbee2mqtt_ext_pan_id)
  - [zigbee2mqtt_homeassistant_discovery_topic](#zigbee2mqtt_homeassistant_discovery_topic)
  - [zigbee2mqtt_homeassistant_enabled](#zigbee2mqtt_homeassistant_enabled)
  - [zigbee2mqtt_homeassistant_legacy_entity_attributes](#zigbee2mqtt_homeassistant_legacy_entity_attributes)
  - [zigbee2mqtt_homeassistant_legacy_triggers](#zigbee2mqtt_homeassistant_legacy_triggers)
  - [zigbee2mqtt_homeassistant_status_topic](#zigbee2mqtt_homeassistant_status_topic)
  - [zigbee2mqtt_image](#zigbee2mqtt_image)
  - [zigbee2mqtt_last_seen](#zigbee2mqtt_last_seen)
  - [zigbee2mqtt_log_level](#zigbee2mqtt_log_level)
  - [zigbee2mqtt_mqtt_base_topic](#zigbee2mqtt_mqtt_base_topic)
  - [zigbee2mqtt_mqtt_client_id](#zigbee2mqtt_mqtt_client_id)
  - [zigbee2mqtt_mqtt_include_device_information](#zigbee2mqtt_mqtt_include_device_information)
  - [zigbee2mqtt_mqtt_password](#zigbee2mqtt_mqtt_password)
  - [zigbee2mqtt_mqtt_reject_unauthorized](#zigbee2mqtt_mqtt_reject_unauthorized)
  - [zigbee2mqtt_mqtt_server](#zigbee2mqtt_mqtt_server)
  - [zigbee2mqtt_mqtt_user](#zigbee2mqtt_mqtt_user)
  - [zigbee2mqtt_network](#zigbee2mqtt_network)
  - [zigbee2mqtt_network_key](#zigbee2mqtt_network_key)
  - [zigbee2mqtt_pan_id](#zigbee2mqtt_pan_id)
  - [zigbee2mqtt_permit_join](#zigbee2mqtt_permit_join)
  - [zigbee2mqtt_security_opts](#zigbee2mqtt_security_opts)
  - [zigbee2mqtt_serial_disable_led](#zigbee2mqtt_serial_disable_led)
  - [zigbee2mqtt_serial_port](#zigbee2mqtt_serial_port)
  - [zigbee2mqtt_service_started](#zigbee2mqtt_service_started)
  - [zigbee2mqtt_timezone](#zigbee2mqtt_timezone)
  - [zigbee2mqtt_volumes](#zigbee2mqtt_volumes)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)

---

## Requirements

- Minimum Ansible version: `2.10`

## Default Variables

### zigbee2mqtt_cache_state

#### Default value

```YAML
zigbee2mqtt_cache_state: true
```

### zigbee2mqtt_cap_add

#### Default value

```YAML
zigbee2mqtt_cap_add: []
```

### zigbee2mqtt_cap_drop

#### Default value

```YAML
zigbee2mqtt_cap_drop: []
```

### zigbee2mqtt_channel

#### Default value

```YAML
zigbee2mqtt_channel: 11
```

### zigbee2mqtt_data_volume

#### Default value

```YAML
zigbee2mqtt_data_volume: zigbee2mqtt-data
```

### zigbee2mqtt_device_options

#### Default value

```YAML
zigbee2mqtt_device_options: _unset
```

#### Example usage

```YAML
zigbee2mqtt_device_options:
  occupancy_timeout: 130
  temperature_precision: 1
```

### zigbee2mqtt_devices

Define required devices e.g. `/dev/ttyACM0`.

#### Default value

```YAML
zigbee2mqtt_devices: []
```

#### Example usage

```YAML
zigbee2mqtt_devices:
  - src: "{{ zigbee2mqtt_serial_port }}"
    dest: "{{ zigbee2mqtt_serial_port }}"
    opt: z
```

### zigbee2mqtt_devices_ban

#### Default value

```YAML
zigbee2mqtt_devices_ban: []
```

### zigbee2mqtt_devices_whitelist

#### Default value

```YAML
zigbee2mqtt_devices_whitelist: []
```

### zigbee2mqtt_docker_args

#### Default value

```YAML
zigbee2mqtt_docker_args:
  - --pids-limit=-1
```

### zigbee2mqtt_elapsed

#### Default value

```YAML
zigbee2mqtt_elapsed: false
```

### zigbee2mqtt_exposed_ports

Ports you want to publish outside of docker.

#### Default value

```YAML
zigbee2mqtt_exposed_ports: []
```

### zigbee2mqtt_ext_pan_id

#### Default value

```YAML
zigbee2mqtt_ext_pan_id: '[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]'
```

### zigbee2mqtt_homeassistant_discovery_topic

#### Default value

```YAML
zigbee2mqtt_homeassistant_discovery_topic: homeassistant
```

### zigbee2mqtt_homeassistant_enabled

#### Default value

```YAML
zigbee2mqtt_homeassistant_enabled: false
```

### zigbee2mqtt_homeassistant_legacy_entity_attributes

#### Default value

```YAML
zigbee2mqtt_homeassistant_legacy_entity_attributes: false
```

### zigbee2mqtt_homeassistant_legacy_triggers

#### Default value

```YAML
zigbee2mqtt_homeassistant_legacy_triggers: false
```

### zigbee2mqtt_homeassistant_status_topic

#### Default value

```YAML
zigbee2mqtt_homeassistant_status_topic: hass/status
```

### zigbee2mqtt_image

#### Default value

```YAML
zigbee2mqtt_image: docker.io/koenkk/zigbee2mqtt:latest
```

### zigbee2mqtt_last_seen

#### Default value

```YAML
zigbee2mqtt_last_seen: disable
```

### zigbee2mqtt_log_level

#### Default value

```YAML
zigbee2mqtt_log_level: info
```

### zigbee2mqtt_mqtt_base_topic

#### Default value

```YAML
zigbee2mqtt_mqtt_base_topic: zigbee2mqtt
```

### zigbee2mqtt_mqtt_client_id

#### Default value

```YAML
zigbee2mqtt_mqtt_client_id: zigbee2mqtt
```

### zigbee2mqtt_mqtt_include_device_information

#### Default value

```YAML
zigbee2mqtt_mqtt_include_device_information: false
```

### zigbee2mqtt_mqtt_password

#### Default value

```YAML
zigbee2mqtt_mqtt_password: _unset_
```

### zigbee2mqtt_mqtt_reject_unauthorized

#### Default value

```YAML
zigbee2mqtt_mqtt_reject_unauthorized: false
```

### zigbee2mqtt_mqtt_server

#### Default value

```YAML
zigbee2mqtt_mqtt_server: mqtt://localhost:1883
```

### zigbee2mqtt_mqtt_user

#### Default value

```YAML
zigbee2mqtt_mqtt_user: _unset_
```

### zigbee2mqtt_network

Use a custom docker network for grafana.

#### Default value

```YAML
zigbee2mqtt_network: _unset_
```

### zigbee2mqtt_network_key

#### Default value

```YAML
zigbee2mqtt_network_key: _unset_
```

#### Example usage

```YAML
zigbee2mqtt_network_key: '[1, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 10, 12, 13]'
```

### zigbee2mqtt_pan_id

#### Default value

```YAML
zigbee2mqtt_pan_id: '0x1a62'
```

### zigbee2mqtt_permit_join

#### Default value

```YAML
zigbee2mqtt_permit_join: true
```

### zigbee2mqtt_security_opts

#### Default value

```YAML
zigbee2mqtt_security_opts: []
```

### zigbee2mqtt_serial_disable_led

#### Default value

```YAML
zigbee2mqtt_serial_disable_led: false
```

### zigbee2mqtt_serial_port

#### Default value

```YAML
zigbee2mqtt_serial_port: _unset_
```

#### Example usage

```YAML
zigbee2mqtt_serial_port: ''
```

### zigbee2mqtt_service_started

#### Default value

```YAML
zigbee2mqtt_service_started: true
```

### zigbee2mqtt_timezone

#### Default value

```YAML
zigbee2mqtt_timezone: Europe/Berlin
```

### zigbee2mqtt_volumes

Define required docker volumes.

#### Default value

```YAML
zigbee2mqtt_volumes:
  - name: '{{ zigbee2mqtt_data_volume }}'
    dest: /app/data
```

## Dependencies

None.

## License

MIT

## Author

[Robert Kaussow](https://gitea.rknet.org/xoxys)