Compare commits

...

No commits in common. "main" and "docs" have entirely different histories.
main ... docs

25 changed files with 522 additions and 1054 deletions

View File

@ -1,159 +0,0 @@
local PipelineLinting = {
kind: 'pipeline',
name: 'linting',
platform: {
os: 'linux',
arch: 'amd64',
},
steps: [
{
name: 'ansible-later',
image: 'thegeeklab/ansible-later',
commands: [
'ansible-later',
],
},
{
name: 'python-format',
image: 'python:3.11',
environment: {
PY_COLORS: 1,
},
commands: [
'pip install -qq yapf',
'[ -z "$(find . -type f -name *.py)" ] || (yapf -rd ./)',
],
},
{
name: 'python-flake8',
image: 'python:3.11',
environment: {
PY_COLORS: 1,
},
commands: [
'pip install -qq flake8',
'flake8',
],
},
],
trigger: {
ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
},
};
local PipelineDeployment(scenario='centos7') = {
kind: 'pipeline',
name: 'testing-' + scenario,
platform: {
os: 'linux',
arch: 'amd64',
},
concurrency: {
limit: 1,
},
workspace: {
base: '/drone/src',
path: '${DRONE_REPO_NAME}',
},
steps: [
{
name: 'ansible-molecule',
image: 'thegeeklab/molecule:4',
environment: {
HCLOUD_TOKEN: { from_secret: 'hcloud_token' },
},
commands: [
'molecule test -s ' + scenario,
],
},
],
depends_on: [
'linting',
],
trigger: {
ref: ['refs/heads/main', 'refs/tags/**'],
},
};
local PipelineDocumentation = {
kind: 'pipeline',
name: 'documentation',
platform: {
os: 'linux',
arch: 'amd64',
},
steps: [
{
name: 'generate',
image: 'thegeeklab/ansible-doctor',
environment: {
ANSIBLE_DOCTOR_LOG_LEVEL: 'INFO',
ANSIBLE_DOCTOR_FORCE_OVERWRITE: true,
ANSIBLE_DOCTOR_EXCLUDE_FILES: 'molecule/',
ANSIBLE_DOCTOR_TEMPLATE: 'hugo-book',
ANSIBLE_DOCTOR_ROLE_NAME: '${DRONE_REPO_NAME#*.}',
ANSIBLE_DOCTOR_OUTPUT_DIR: '_docs/',
},
},
{
name: 'publish',
image: 'plugins/gh-pages',
settings: {
remote_url: 'https://gitea.rknet.org/ansible/${DRONE_REPO_NAME}',
netrc_machine: 'gitea.rknet.org',
username: { from_secret: 'gitea_username' },
password: { from_secret: 'gitea_token' },
pages_directory: '_docs/',
target_branch: 'docs',
},
when: {
ref: ['refs/heads/main'],
},
},
],
trigger: {
ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
},
depends_on: [
'testing-centos7',
],
};
local PipelineNotification = {
kind: 'pipeline',
name: 'notification',
platform: {
os: 'linux',
arch: 'amd64',
},
clone: {
disable: true,
},
steps: [
{
name: 'matrix',
image: 'thegeeklab/drone-matrix',
settings: {
homeserver: { from_secret: 'matrix_homeserver' },
roomid: { from_secret: 'matrix_roomid' },
template: 'Status: **{{ .Build.Status }}**<br/> Build: [{{ .Repo.Owner }}/{{ .Repo.Name }}]({{ .Build.Link }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}<br/> Message: {{ .Commit.Message.Title }}',
username: { from_secret: 'matrix_username' },
password: { from_secret: 'matrix_password' },
},
},
],
depends_on: [
'documentation',
],
trigger: {
status: ['success', 'failure'],
ref: ['refs/heads/main', 'refs/tags/**'],
},
};
[
PipelineLinting,
PipelineDeployment(scenario='centos7'),
PipelineDocumentation,
PipelineNotification,
]

View File

@ -1,152 +0,0 @@
---
kind: pipeline
name: linting
platform:
os: linux
arch: amd64
steps:
- name: ansible-later
image: thegeeklab/ansible-later
commands:
- ansible-later
- name: python-format
image: python:3.11
commands:
- pip install -qq yapf
- "[ -z \"$(find . -type f -name *.py)\" ] || (yapf -rd ./)"
environment:
PY_COLORS: 1
- name: python-flake8
image: python:3.11
commands:
- pip install -qq flake8
- flake8
environment:
PY_COLORS: 1
trigger:
ref:
- refs/heads/main
- refs/tags/**
- refs/pull/**
---
kind: pipeline
name: testing-centos7
platform:
os: linux
arch: amd64
concurrency:
limit: 1
workspace:
base: /drone/src
path: ${DRONE_REPO_NAME}
steps:
- name: ansible-molecule
image: thegeeklab/molecule:4
commands:
- molecule test -s centos7
environment:
HCLOUD_TOKEN:
from_secret: hcloud_token
trigger:
ref:
- refs/heads/main
- refs/tags/**
depends_on:
- linting
---
kind: pipeline
name: documentation
platform:
os: linux
arch: amd64
steps:
- name: generate
image: thegeeklab/ansible-doctor
environment:
ANSIBLE_DOCTOR_EXCLUDE_FILES: molecule/
ANSIBLE_DOCTOR_FORCE_OVERWRITE: true
ANSIBLE_DOCTOR_LOG_LEVEL: INFO
ANSIBLE_DOCTOR_OUTPUT_DIR: _docs/
ANSIBLE_DOCTOR_ROLE_NAME: ${DRONE_REPO_NAME#*.}
ANSIBLE_DOCTOR_TEMPLATE: hugo-book
- name: publish
image: plugins/gh-pages
settings:
netrc_machine: gitea.rknet.org
pages_directory: _docs/
password:
from_secret: gitea_token
remote_url: https://gitea.rknet.org/ansible/${DRONE_REPO_NAME}
target_branch: docs
username:
from_secret: gitea_username
when:
ref:
- refs/heads/main
trigger:
ref:
- refs/heads/main
- refs/tags/**
- refs/pull/**
depends_on:
- testing-centos7
---
kind: pipeline
name: notification
platform:
os: linux
arch: amd64
clone:
disable: true
steps:
- name: matrix
image: thegeeklab/drone-matrix
settings:
homeserver:
from_secret: matrix_homeserver
password:
from_secret: matrix_password
roomid:
from_secret: matrix_roomid
template: "Status: **{{ .Build.Status }}**<br/> Build: [{{ .Repo.Owner }}/{{ .Repo.Name }}]({{ .Build.Link }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}<br/> Message: {{ .Commit.Message.Title }}"
username:
from_secret: matrix_username
trigger:
ref:
- refs/heads/main
- refs/tags/**
status:
- success
- failure
depends_on:
- documentation
---
kind: signature
hmac: 8deae8ced5d7f9c3945e28632266d5573cf0ce26d1a21b1e494e34128c05e2a1
...

13
.gitignore vendored
View File

@ -1,13 +0,0 @@
# ---> Ansible
*.retry
filter/plugins/
library
# ---> Python
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# ---> Docs
/_docs

View File

@ -1,19 +0,0 @@
---
ansible:
custom_modules:
- iptables_raw
- openssl_pkcs12
- proxmox_kvm
- ucr
- corenetworks_dns
- corenetworks_token
rules:
exclude_files:
- molecule/
- "LICENSE*"
- "**/*.md"
- "**/*.ini"
exclude_filter:
- LINT0009

21
LICENSE
View File

@ -1,21 +0,0 @@
MIT License
Copyright (c) 2022 Robert Kaussow <mail@thegeeklab.de>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -1,12 +0,0 @@
# xoxys.zigbee2mqtt
[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.zigbee2mqtt?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.zigbee2mqtt)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](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.
You can find the full documentation at [https://galaxy.geekdocs.de](https://galaxy.geekdocs.de/roles/IoT/zigbee2mqtt/).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

View File

@ -1,108 +0,0 @@
---
zigbee2mqtt_version: latest
zigbee2mqtt_image: "koenkk/zigbee2mqtt:{{ zigbee2mqtt_version }}"
zigbee2mqtt_service_directory: /var/lib/docker/services/zigbee2mqtt
zigbee2mqtt_container_name: zigbee2mqtt
zigbee2mqtt_restart_policy: always
zigbee2mqtt_service_stopped: False
# @var zigbee2mqtt_networks:example: >
# zigbee2mqtt_networks:
# - name: default
# # optional network driver, defaults to 'bride'
# driver: host
# external: false
# @end
zigbee2mqtt_networks:
- name: default
zigbee2mqtt_networks_applied:
- default
# @var zigbee2mqtt_volumes:description: Define required docker volumes.
# @var zigbee2mqtt_volumes:example: >
# zigbee2mqtt_volumes:
# # Instead of the name you could specify a path on the container host system,
# # but you also have to enable bind mount for this volume
# - name: data
# # target location inside the container
# dest: /var/www/app/data
# # enable bind mount, if false volume will be configured as named volume
# # keep in mind you MUST set bind in any case
# bind: True
# # Options for bind mounts
# bind_opt: "ro,z"
# @end
zigbee2mqtt_volumes:
- name: "{{ zigbee2mqtt_data_volume }}"
dest: /app/data
bind: True
zigbee2mqtt_data_volume: "/opt/zigbee2mqtt/data"
# @var zigbee2mqtt_devices:description: Define required devices e.g. `/dev/ttyACM0`.
# @var zigbee2mqtt_devices:example: >
# zigbee2mqtt_devices:
# - src: "{{ zigbee2mqtt_serial_port }}"
# dest: "{{ zigbee2mqtt_serial_port }}"
# opt: z
# @end
zigbee2mqtt_exposed_ports: []
zigbee2mqtt_extra_hosts: []
# @var zigbee2mqtt_memory_limit: $ "_unset_"
# @var zigbee2mqtt_memory_limit:example: $ "512m"
# @var zigbee2mqtt_memory_reservation: $ "_unset_"
# @var zigbee2mqtt_memory_reservation:example: $ "256m"
# @var zigbee2mqtt_cpu_shares: $ "_unset_"
# @var zigbee2mqtt_cpu_shares:example: $ "1024"
zigbee2mqtt_cap_add: []
zigbee2mqtt_cap_drop: []
zigbee2mqtt_security_opt: []
# @var zigbee2mqtt_pids_limit: $ "_unset_"
zigbee2mqtt_log_level: info
zigbee2mqtt_homeassistant_enabled: False
zigbee2mqtt_permit_join: True
zigbee2mqtt_mqtt_base_topic: zigbee2mqtt
zigbee2mqtt_mqtt_server: "mqtt://localhost:1883"
# @var zigbee2mqtt_mqtt_user: $ "_unset_"
# @var zigbee2mqtt_mqtt_password: $ "_unset_"
zigbee2mqtt_mqtt_client_id: zigbee2mqtt
zigbee2mqtt_mqtt_reject_unauthorized: False
zigbee2mqtt_mqtt_include_device_information: False
# @var zigbee2mqtt_serial_port: $ "_unset_"
# @var zigbee2mqtt_serial_port:example: $ ""
zigbee2mqtt_serial_disable_led: False
zigbee2mqtt_pan_id: "0x1a62"
zigbee2mqtt_ext_pan_id: "[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]"
zigbee2mqtt_channel: 11
zigbee2mqtt_cache_state: True
# @var zigbee2mqtt_network_key: $ "_unset_"
# @var zigbee2mqtt_network_key:example: $ "[1, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 10, 12, 13]"
zigbee2mqtt_last_seen: "disable"
zigbee2mqtt_elapsed: False
zigbee2mqtt_homeassistant_discovery_topic: homeassistant
zigbee2mqtt_homeassistant_status_topic: "hass/status"
zigbee2mqtt_homeassistant_legacy_entity_attributes: False
zigbee2mqtt_homeassistant_legacy_triggers: False
zigbee2mqtt_devices_ban: []
zigbee2mqtt_devices_whitelist: []
# @var zigbee2mqtt_device_options: $ "_unset"
# @var zigbee2mqtt_device_options:example: >
# zigbee2mqtt_device_options:
# occupancy_timeout: 130
# temperature_precision: 1
# @end
zigbee2mqtt_timezone: Europe/Berlin

View File

@ -1,11 +0,0 @@
---
- name: Restart zigbee2mqtt service
docker_compose:
project_src: "{{ zigbee2mqtt_service_directory }}"
pull: yes
remove_orphans: yes
stopped: "{{ zigbee2mqtt_service_stopped }}"
restarted: "{{ not zigbee2mqtt_service_stopped }}"
listen: __zigbee2mqtt_restart
become: True
become_user: root

522
index.md Normal file
View File

@ -0,0 +1,522 @@
---
title: zigbee2mqtt_docker
type: docs
---
[![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.zigbee2mqtt) [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.zigbee2mqtt?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.zigbee2mqtt) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](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.
<!--more-->
- [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_container_name](#zigbee2mqtt_container_name)
- [zigbee2mqtt_cpu_shares](#zigbee2mqtt_cpu_shares)
- [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_elapsed](#zigbee2mqtt_elapsed)
- [zigbee2mqtt_exposed_ports](#zigbee2mqtt_exposed_ports)
- [zigbee2mqtt_ext_pan_id](#zigbee2mqtt_ext_pan_id)
- [zigbee2mqtt_extra_hosts](#zigbee2mqtt_extra_hosts)
- [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_memory_limit](#zigbee2mqtt_memory_limit)
- [zigbee2mqtt_memory_reservation](#zigbee2mqtt_memory_reservation)
- [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_key](#zigbee2mqtt_network_key)
- [zigbee2mqtt_networks](#zigbee2mqtt_networks)
- [zigbee2mqtt_networks_applied](#zigbee2mqtt_networks_applied)
- [zigbee2mqtt_pan_id](#zigbee2mqtt_pan_id)
- [zigbee2mqtt_permit_join](#zigbee2mqtt_permit_join)
- [zigbee2mqtt_pids_limit](#zigbee2mqtt_pids_limit)
- [zigbee2mqtt_restart_policy](#zigbee2mqtt_restart_policy)
- [zigbee2mqtt_security_opt](#zigbee2mqtt_security_opt)
- [zigbee2mqtt_serial_disable_led](#zigbee2mqtt_serial_disable_led)
- [zigbee2mqtt_serial_port](#zigbee2mqtt_serial_port)
- [zigbee2mqtt_service_directory](#zigbee2mqtt_service_directory)
- [zigbee2mqtt_service_stopped](#zigbee2mqtt_service_stopped)
- [zigbee2mqtt_timezone](#zigbee2mqtt_timezone)
- [zigbee2mqtt_version](#zigbee2mqtt_version)
- [zigbee2mqtt_volumes](#zigbee2mqtt_volumes)
- [Dependencies](#dependencies)
---
## 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_container_name
#### Default value
```YAML
zigbee2mqtt_container_name: zigbee2mqtt
```
### zigbee2mqtt_cpu_shares
#### Default value
```YAML
zigbee2mqtt_cpu_shares: _unset_
```
#### Example usage
```YAML
zigbee2mqtt_cpu_shares: '1024'
```
### zigbee2mqtt_data_volume
#### Default value
```YAML
zigbee2mqtt_data_volume: /opt/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`.
#### 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_elapsed
#### Default value
```YAML
zigbee2mqtt_elapsed: false
```
### zigbee2mqtt_exposed_ports
#### 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_extra_hosts
#### Default value
```YAML
zigbee2mqtt_extra_hosts: []
```
### 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: koenkk/zigbee2mqtt:{{ zigbee2mqtt_version }}
```
### zigbee2mqtt_last_seen
#### Default value
```YAML
zigbee2mqtt_last_seen: disable
```
### zigbee2mqtt_log_level
#### Default value
```YAML
zigbee2mqtt_log_level: info
```
### zigbee2mqtt_memory_limit
#### Default value
```YAML
zigbee2mqtt_memory_limit: _unset_
```
#### Example usage
```YAML
zigbee2mqtt_memory_limit: 512m
```
### zigbee2mqtt_memory_reservation
#### Default value
```YAML
zigbee2mqtt_memory_reservation: _unset_
```
#### Example usage
```YAML
zigbee2mqtt_memory_reservation: 256m
```
### 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_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_networks
#### Default value
```YAML
zigbee2mqtt_networks:
- name: default
```
#### Example usage
```YAML
zigbee2mqtt_networks:
- name: default
# optional network driver, defaults to 'bride'
driver: host
external: false
```
### zigbee2mqtt_networks_applied
#### Default value
```YAML
zigbee2mqtt_networks_applied:
- default
```
### zigbee2mqtt_pan_id
#### Default value
```YAML
zigbee2mqtt_pan_id: '0x1a62'
```
### zigbee2mqtt_permit_join
#### Default value
```YAML
zigbee2mqtt_permit_join: true
```
### zigbee2mqtt_pids_limit
#### Default value
```YAML
zigbee2mqtt_pids_limit: _unset_
```
### zigbee2mqtt_restart_policy
#### Default value
```YAML
zigbee2mqtt_restart_policy: always
```
### zigbee2mqtt_security_opt
#### Default value
```YAML
zigbee2mqtt_security_opt: []
```
### 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_directory
#### Default value
```YAML
zigbee2mqtt_service_directory: /var/lib/docker/services/zigbee2mqtt
```
### zigbee2mqtt_service_stopped
#### Default value
```YAML
zigbee2mqtt_service_stopped: false
```
### zigbee2mqtt_timezone
#### Default value
```YAML
zigbee2mqtt_timezone: Europe/Berlin
```
### zigbee2mqtt_version
#### Default value
```YAML
zigbee2mqtt_version: latest
```
### zigbee2mqtt_volumes
Define required docker volumes.
#### Default value
```YAML
zigbee2mqtt_volumes:
- name: '{{ zigbee2mqtt_data_volume }}'
dest: /app/data
bind: true
```
#### Example usage
```YAML
zigbee2mqtt_volumes:
# Instead of the name you could specify a path on the container host system,
# but you also have to enable bind mount for this volume
- name: data
# target location inside the container
dest: /var/www/app/data
# enable bind mount, if false volume will be configured as named volume
# keep in mind you MUST set bind in any case
bind: True
# Options for bind mounts
bind_opt: "ro,z"
```
## Dependencies
None.

View File

@ -1,30 +0,0 @@
# Standards: 0.2
---
galaxy_info:
# @meta author:value: [Robert Kaussow](https://gitea.rknet.org/xoxys)
author: Robert Kaussow <mail@thegeeklab.de>
namespace: xoxys
role_name: zigbee2mqtt_docker
# @meta description: >
# [![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.zigbee2mqtt)
# [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.zigbee2mqtt?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.zigbee2mqtt)
# [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](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.
# @end
description: Setup zigbee2mqtt
license: MIT
min_ansible_version: 2.10
platforms:
- name: EL
versions:
- 7
galaxy_tags:
- zigbee
- zigbee2mqtt
dependencies: []
collections:
- xoxys.general
- community.general

View File

@ -1,23 +0,0 @@
---
- name: Converge (Stage 1)
hosts: all
vars:
dockerengine_packages_extra:
- epel-release
- python-pip
- python-virtualenv
roles:
- role: xoxys.docker_engine
- name: Converge (Stage 2)
hosts: all
environment:
PYTHONPATH: /opt/python2/ansible-deps/lib/python2.7/site-packages
vars:
mosquitto_bind_address: "127.0.0.1"
zigbee2mqtt_service_stopped: True
roles:
- role: xoxys.mosquitto
- role: xoxys.zigbee2mqtt_docker

View File

@ -1,120 +0,0 @@
---
- name: Create
hosts: localhost
connection: local
gather_facts: false
no_log: "{{ molecule_no_log }}"
vars:
ssh_port: 22
ssh_user: root
ssh_path: "{{ lookup('env', 'MOLECULE_EPHEMERAL_DIRECTORY') }}/ssh_key"
tasks:
- name: Create SSH key
user:
name: "{{ lookup('env', 'USER') }}"
generate_ssh_key: true
ssh_key_file: "{{ ssh_path }}"
force: true
register: generated_ssh_key
- name: Register the SSH key name
set_fact:
ssh_key_name: "molecule-generated-{{ 12345 | random | to_uuid }}"
- name: Register SSH key for test instance(s)
hcloud_ssh_key:
name: "{{ ssh_key_name }}"
public_key: "{{ generated_ssh_key.ssh_public_key }}"
state: present
- name: Create molecule instance(s)
hcloud_server:
name: "{{ item.name }}"
server_type: "{{ item.server_type }}"
ssh_keys:
- "{{ ssh_key_name }}"
image: "{{ item.image }}"
location: "{{ item.location | default(omit) }}"
datacenter: "{{ item.datacenter | default(omit) }}"
user_data: "{{ item.user_data | default(omit) }}"
api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
state: present
register: server
loop: "{{ molecule_yml.platforms }}"
async: 7200
poll: 0
- name: Wait for instance(s) creation to complete
async_status:
jid: "{{ item.ansible_job_id }}"
register: hetzner_jobs
until: hetzner_jobs.finished
retries: 300
loop: "{{ server.results }}"
- name: Create volume(s)
hcloud_volume:
name: "{{ item.name }}"
server: "{{ item.name }}"
location: "{{ item.location | default(omit) }}"
size: "{{ item.volume_size | default(10) }}"
api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
state: "present"
loop: "{{ molecule_yml.platforms }}"
when: item.volume | default(False) | bool
register: volumes
async: 7200
poll: 0
- name: Wait for volume(s) creation to complete
async_status:
jid: "{{ item.ansible_job_id }}"
register: hetzner_volumes
until: hetzner_volumes.finished
retries: 300
when: volumes.changed
loop: "{{ volumes.results }}"
# Mandatory configuration for Molecule to function.
- name: Populate instance config dict
set_fact:
instance_conf_dict:
{
"instance": "{{ item.hcloud_server.name }}",
"ssh_key_name": "{{ ssh_key_name }}",
"address": "{{ item.hcloud_server.ipv4_address }}",
"user": "{{ ssh_user }}",
"port": "{{ ssh_port }}",
"identity_file": "{{ ssh_path }}",
"volume": "{{ item.item.item.volume | default(False) | bool }}",
}
loop: "{{ hetzner_jobs.results }}"
register: instance_config_dict
when: server.changed | bool
- name: Convert instance config dict to a list
set_fact:
instance_conf: "{{ instance_config_dict.results | map(attribute='ansible_facts.instance_conf_dict') | list }}"
when: server.changed | bool
- name: Dump instance config
copy:
content: |
# Molecule managed
{{ instance_conf | to_nice_yaml(indent=2) }}
dest: "{{ molecule_instance_config }}"
when: server.changed | bool
- name: Wait for SSH
wait_for:
port: "{{ ssh_port }}"
host: "{{ item.address }}"
search_regex: SSH
delay: 10
loop: "{{ lookup('file', molecule_instance_config) | from_yaml }}"
- name: Wait for VM to settle down
pause:
seconds: 30

View File

@ -1,78 +0,0 @@
---
- name: Destroy
hosts: localhost
connection: local
gather_facts: false
no_log: "{{ molecule_no_log }}"
tasks:
- name: Check existing instance config file
stat:
path: "{{ molecule_instance_config }}"
register: cfg
- name: Populate the instance config
set_fact:
instance_conf: "{{ (lookup('file', molecule_instance_config) | from_yaml) if cfg.stat.exists else [] }}"
- name: Destroy molecule instance(s)
hcloud_server:
name: "{{ item.instance }}"
api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
state: absent
register: server
loop: "{{ instance_conf }}"
async: 7200
poll: 0
- name: Wait for instance(s) deletion to complete
async_status:
jid: "{{ item.ansible_job_id }}"
register: hetzner_jobs
until: hetzner_jobs.finished
retries: 300
loop: "{{ server.results }}"
- pause:
seconds: 5
- name: Destroy volume(s)
hcloud_volume:
name: "{{ item.instance }}"
server: "{{ item.instance }}"
api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
state: "absent"
register: volumes
loop: "{{ instance_conf }}"
when: item.volume | default(False) | bool
async: 7200
poll: 0
- name: Wait for volume(s) deletion to complete
async_status:
jid: "{{ item.ansible_job_id }}"
register: hetzner_volumes
until: hetzner_volumes.finished
retries: 300
when: volumes.changed
loop: "{{ volumes.results }}"
- name: Remove registered SSH key
hcloud_ssh_key:
name: "{{ instance_conf[0].ssh_key_name }}"
state: absent
when: (instance_conf | default([])) | length > 0
# Mandatory configuration for Molecule to function.
- name: Populate instance config
set_fact:
instance_conf: {}
- name: Dump instance config
copy:
content: |
# Molecule managed
{{ instance_conf | to_nice_yaml(indent=2) }}
dest: "{{ molecule_instance_config }}"
when: server.changed | bool

View File

@ -1,24 +0,0 @@
---
dependency:
name: galaxy
options:
role-file: molecule/requirements.yml
requirements-file: molecule/requirements.yml
env:
ANSIBLE_GALAXY_DISPLAY_PROGRESS: "false"
driver:
name: delegated
platforms:
- name: centos7-zigbee2mqtt
image: centos-7
server_type: cx11
lint: |
/usr/local/bin/flake8
provisioner:
name: ansible
env:
ANSIBLE_FILTER_PLUGINS: ${ANSIBLE_FILTER_PLUGINS:-./plugins/filter}
ANSIBLE_LIBRARY: ${ANSIBLE_LIBRARY:-./library}
log: False
verifier:
name: testinfra

View File

@ -1,15 +0,0 @@
---
- name: Prepare
hosts: all
gather_facts: false
tasks:
- name: Bootstrap python for Ansible
raw: |
command -v python3 python || (
(test -e /usr/bin/dnf && sudo dnf install -y python3) ||
(test -e /usr/bin/apt && (apt -y update && apt install -y python-minimal)) ||
(test -e /usr/bin/yum && sudo yum -y -qq install python3) ||
echo "Warning: Python not boostrapped due to unknown platform."
)
become: true
changed_when: false

View File

@ -1,15 +0,0 @@
import os
import testinfra.utils.ansible_runner
testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
os.environ["MOLECULE_INVENTORY_FILE"]
).get_hosts("all")
# TODO: add some tests if zigbee2mqtt can work with a
# dummy interface
def test_hosts_file(host):
f = host.file('/etc/hosts')
assert f.exists

View File

@ -1 +0,0 @@
centos7

View File

@ -1,3 +0,0 @@
[pytest]
filterwarnings =
ignore::DeprecationWarning

View File

@ -1,15 +0,0 @@
---
collections:
- name: https://gitea.rknet.org/ansible/xoxys.general/releases/download/v2.1.1/xoxys-general-2.1.1.tar.gz
- name: community.general
roles:
- src: https://gitea.rknet.org/ansible/xoxys.docker_engine.git
name: xoxys.docker_engine
scm: git
version: main
- src: https://gitea.rknet.org/ansible/xoxys.mosquitto.git
name: xoxys.mosquitto
scm: git
version: main

View File

@ -1,12 +0,0 @@
[flake8]
ignore = D100, D101, D102, D103, D105, D107, E402, W503
max-line-length = 99
inline-quotes = double
exclude = .git,.tox,__pycache__,build,dist,tests,*.pyc,*.egg-info,.cache,.eggs,env*
[yapf]
based_on_style = google
column_limit = 99
dedent_closing_brackets = true
coalesce_brackets = true
split_before_logical_operator = true

View File

@ -1,2 +0,0 @@
---
- include_tasks: setup.yml

View File

@ -1,54 +0,0 @@
---
- block:
- name: Ensure service directory exists
file:
path: "{{ zigbee2mqtt_service_directory }}"
mode: 0750
state: directory
- name: Create bind mount source directory
file:
path: "{{ item.name }}"
mode: 0750
state: directory
loop: "{{ zigbee2mqtt_volumes }}"
loop_control:
label: "{{ item.name }}"
when: item.bind | bool
- name: Deploy compose file to '{{ zigbee2mqtt_service_directory }}'
template:
src: "services/zigbee2mqtt_compose.yml.j2"
dest: "{{ zigbee2mqtt_service_directory }}/docker-compose.yml"
owner: root
group: root
mode: 0640
validate: "docker-compose -f %s config -q"
- name: Deploy configuration file
template:
src: "zigbee2mqtt/data/configuration.yaml.j2"
dest: "{{ zigbee2mqtt_data_volume }}/configuration.yaml"
mode: 0600
notify: __zigbee2mqtt_restart
- name: Ensure device files exists
file:
path: "{{ item }}"
mode: 0640
state: touch
access_time: preserve
modification_time: preserve
loop:
- "{{ zigbee2mqtt_data_volume }}/devices.yaml"
- "{{ zigbee2mqtt_data_volume }}/groups.yaml"
- name: Ensure service is up and running
docker_compose:
project_src: "{{ zigbee2mqtt_service_directory }}"
pull: yes
remove_orphans: yes
stopped: "{{ zigbee2mqtt_service_stopped }}"
state: present
become: True
become_user: root

View File

@ -1,90 +0,0 @@
#jinja2:lstrip_blocks: True
{{ ansible_managed | comment }}
version: "2.4"
services:
zigbee2mqtt:
container_name: {{ zigbee2mqtt_container_name }}
image: {{ zigbee2mqtt_image }}
restart: {{ zigbee2mqtt_restart_policy }}
{% if zigbee2mqtt_exposed_ports | default([]) %}
ports:
{% for port in zigbee2mqtt_exposed_ports %}
- {{ port | quote }}
{% endfor %}
{% endif %}
{% if zigbee2mqtt_volumes | default([]) %}
volumes:
{% for volume in zigbee2mqtt_volumes %}
- "{{ volume.name }}:{{ volume.dest }}{% if volume.bind_opt is defined %}:{{ volume.bind_opt }}{% endif %}"
{% endfor %}
{% endif %}
{% if zigbee2mqtt_devices | default([]) %}
devices:
{% for device in zigbee2mqtt_devices %}
- "{{ device.src }}:{{ device.dest }}{% if device.opt is defined %}:{{ device.opt }}{% endif %}"
{% endfor %}
{% endif %}
{% if zigbee2mqtt_networks_applied | default([]) %}
networks:
{% for network in zigbee2mqtt_networks_applied %}
- {{ network }}
{% endfor %}
{% endif %}
{% if zigbee2mqtt_extra_hosts | default([]) %}
extra_hosts:
{% for host in zigbee2mqtt_extra_hosts %}
- {{ host | quote }}
{% endfor %}
{% endif %}
environment:
- TZ={{ zigbee2mqtt_timezone }}
{% if zigbee2mqtt_memory_limit is defined %}
mem_limit: {{ zigbee2mqtt_memory_limit }}
{% endif %}
{% if zigbee2mqtt_memory_reservation is defined %}
mem_reservation: {{ zigbee2mqtt_memory_reservation }}
{% endif %}
{% if zigbee2mqtt_cpu_shares is defined %}
cpu_shares: {{ zigbee2mqtt_cpu_shares }}
{% endif %}
{% if not zigbee2mqtt_cap_add | length == 0 %}
cap_add:
{% for item in zigbee2mqtt_cap_add %}
- {{ item }}
{% endfor %}
{% endif %}
{% if not zigbee2mqtt_cap_drop | length == 0 %}
cap_drop:
{% for item in zigbee2mqtt_cap_drop %}
- {{ item }}
{% endfor %}
{% endif %}
{% if not zigbee2mqtt_security_opt | length == 0 %}
security_opt:
{% for item in zigbee2mqtt_security_opt %}
- {{ item }}
{% endfor %}
{% endif %}
{% if zigbee2mqtt_pids_limit is defined %}
pids_limit: {{ zigbee2mqtt_pids_limit }}
{% endif %}
{% if zigbee2mqtt_volumes | default([]) | rejectattr("bind") | list | length > 0 %}
volumes:
{% for volume in zigbee2mqtt_volumes | rejectattr("bind") %}
{{ volume.name }}:
{% endfor %}
{% endif %}
{% if zigbee2mqtt_networks | default([]) | length > 0 %}
networks:
{% for network in zigbee2mqtt_networks %}
{{ network.name }}:
{% if network.external | default(False) | bool %}
external: true
{% else %}
driver: {{ network.backend | default("bridge") }}
{% endif %}
{% endfor %}
{% endif %}

View File

@ -1,65 +0,0 @@
#jinja2:lstrip_blocks: True
---
{{ ansible_managed | comment }}
permit_join: {{ zigbee2mqtt_permit_join }}
{% if zigbee2mqtt_homeassistant_enabled | bool %}
homeassistant:
discovery_topic: "{{ zigbee2mqtt_homeassistant_discovery_topic }}"
status_topic: "{{ zigbee2mqtt_homeassistant_status_topic }}"
legacy_entity_attributes: {{ zigbee2mqtt_homeassistant_legacy_entity_attributes | bool }}
legacy_triggers: {{ zigbee2mqtt_homeassistant_legacy_triggers | bool }}
{% endif %}
mqtt:
base_topic: "{{ zigbee2mqtt_mqtt_base_topic }}"
server: "{{ zigbee2mqtt_mqtt_server }}"
{% if zigbee2mqtt_mqtt_user is defined and zigbee2mqtt_mqtt_user and zigbee2mqtt_mqtt_password is defined and zigbee2mqtt_mqtt_password %}
user: "{{ zigbee2mqtt_mqtt_user }}"
password: "{{ zigbee2mqtt_mqtt_password }}"
{% endif %}
client_id: "{{ zigbee2mqtt_mqtt_client_id }}"
reject_unauthorized: {{ zigbee2mqtt_mqtt_reject_unauthorized }}
include_device_information: {{ zigbee2mqtt_mqtt_include_device_information }}
{% if zigbee2mqtt_serial_port is defined and zigbee2mqtt_serial_port %}
serial:
port: "{{ zigbee2mqtt_serial_port }}"
disable_led: {{ zigbee2mqtt_serial_disable_led }}
{% endif %}
{% if zigbee2mqtt_devices_ban %}
# Ban devices from the network (by ieeeAddr)
ban:
{% for item in zigbee2mqtt_devices_ban %}
- "{{ item }}"
{% endfor %}
{% endif %}
{% if zigbee2mqtt_devices_whitelist %}
# Whitelist devices from the network (by ieeeAddr)
whitelist:
{% for item in zigbee2mqtt_devices_whitelist %}
- "{{ item }}"
{% endfor %}
{% endif %}
advanced:
pan_id: {{ zigbee2mqtt_pan_id }}
ext_pan_id: {{ zigbee2mqtt_ext_pan_id }}
{% if zigbee2mqtt_network_key is defined and zigbee2mqtt_network_key %}
network_key: {{ zigbee2mqtt_network_key }}
{% endif %}
channel: {{ zigbee2mqtt_channel }}
cache_state: {{ zigbee2mqtt_cache_state }}
log_level: "{{ zigbee2mqtt_log_level }}"
last_seen: "{{ zigbee2mqtt_last_seen }}"
elapsed: {{ zigbee2mqtt_elapsed }}
{% if zigbee2mqtt_device_options is defined %}
device_options:
{{ zigbee2mqtt_device_options | to_nice_yaml | indent(2) }}
{% endif %}
devices: "devices.yaml"
groups: "groups.yaml"

View File

@ -1,12 +0,0 @@
---
__zigbee2mqtt_npm_executable: /usr/local/bin/npm
__zigbee2mqtt_release_exclude:
- data/
- docker/
- docs/
- images/
- LICENSE
- README.md
- scripts/
- test/
- update.sh