Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support of Zigbee2Mqtt Assistant #22

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add support of Zigbee2Mqtt Assistant #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2ce8172
Add support of Zigbee2Mqtt Assistant
robertcsakany Apr 13, 2020
80821d5
Merge branch 'master' into feature/AddZigbee2MqttAssistant
robertcsakany Apr 26, 2020
3b3e76b
Merge branch 'master' into feature/AddZigbee2MqttAssistant
Willem-Dekker Jun 14, 2020
46c378d
Updating zigbee2mqttassistant documentation
robertcsakany Jul 9, 2020
0aecea7
Fixing whitespace
robertcsakany Jul 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .templates/zigbee2mqttassistant/service.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
zigbee2mqttassistant:
container_name: zigbee2mqttassistant
image: carldebilly/zigbee2mqttassistant
restart: unless-stopped
env_file:
- ./services/zigbee2mqttassistant/zigbee2mqttassistant.env
ports:
- 8880:80
environment:
- VIRTUAL_HOST=~^zigbee2mqttassistant\..*\.xip\.io
- VIRTUAL_PORT=8880
4 changes: 4 additions & 0 deletions .templates/zigbee2mqttassistant/zigbee2mqttassistant.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#TZ=Europe/Budapest \
Z2MA_SETTINGS__MQTTSERVER=mosquitto
#Z2MA_SETTINGS__MQTTUSERNAME=
#Z2MA_SETTINGS__MQTTPASSWORD=
20 changes: 20 additions & 0 deletions docs/Zigbee2mqttassistant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Zigbee2Mqtt Assistant
## References
- [Docker](https://hub.docker.com/r/carldebilly/zigbee2mqttassistant)
- [Website](https://github.com/yllibed/Zigbee2MqttAssistant/blob/master/README.md)

## About

This service a web frontend which displays Zigbee2Mqtt service messages and able to control it over Mqtt. For the
servie a working Mqtt server is required and that have to be configured.

## Environment Parameters

Z2MA_SETTINGS__MQTTSERVER=mosquitto - The mqtt service instance which is used by Zigbee2Mqtt instance.
Z2MA_SETTINGS__MQTTUSERNAME=<optional> - When mqtt server have authentication this user is used.
Z2MA_SETTINGS__MQTTPASSWORD=<optional> - When mqtt server have authentication this user is used.
TZ=Europe/Budapest <optional> - Recommmended to setup for correct timestamps.

## Accessing the UI
The Zigbee2Mqtt Assistant UI is available using port 8880 (http://your.local.ip.address:8880/)

4 changes: 3 additions & 1 deletion menu.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ declare -A cont_array=(
[diyhue]="diyHue"
[homebridge]="Homebridge"
[python]="Python 3"
[zigbee2mqttassistant]="zigbee2mqttassistant"
[gitea]="Gitea"
[dozzle]="Dozzle"
)
Expand All @@ -62,7 +63,7 @@ declare -a armhf_keys=(
"adminer"
"openhab"
"zigbee2mqtt"
"deconz"
"deconz"
"pihole"
"plex"
"tasmoadmin"
Expand All @@ -75,6 +76,7 @@ declare -a armhf_keys=(
"diyhue"
"homebridge"
"python"
"zigbee2mqttassistant"
"gitea"
"dozzle"
# add yours here
Expand Down