https://github.com/zigbee2mqtt/hassio-zigbee2mqtt
and click Add → Close or click the Add repository button below, click Add → Close (You might need to enter the internal IP address of your Home Assistant instance first).dev
branch of Zigbee2MQTT such that you can install the edge version if there are features or fixes in the Zigbee2MQTT dev branch that are not yet released.mqtt:
indent. e.g.: server: mqtt://localhost:1883
user: my_user
password: "my_password"
Note: If the password
includes certain special characters (reserved by yaml specification), the enclosing quotes are required. So it is recommended to always quote it when in doubt.
serial:
indent. e.g.: port: /dev/ttyUSB0
/dev/ttyUSB0
. Else use the Home Assistant CLI and execute ha hardware info
to find out. secrets.yaml
file (not the Zigbee2MQTT one!) by using e.g. password: '!secret mqtt_pass'
502: Bad Gateway
wait a bit more and refresh the page.For more information see the documentation.
data
folder (possibly leaving out the logs/
folder)data
folder contents into /usr/share/hassio/homeassistant/zigbee2mqtt
/usr/share/hassio/homeassistant/zigbee2mqtt/configuration.yaml
file:
mqtt
, advanced/log_syslog
, frontend
)The format is based on Keep a Changelog.
All notable changes to this project will be documented in the CHANGELOG.md file.
Version for releases is based on Zigbee2MQTT format: X.Y.Z
.
Any changes on the addon that do not require a new version of Zigbee2MQTT will use the format: X.Y.Z-A
where X.Y.Z
is fixed on the Zigbee2MQTT release version and A
is related to the addon.
Edge version will not maintain a CHANGELOG and doesn't have a version.
If you find any issues with the add-on, please check the issue tracker for similar issues before creating one. If your issue is regarding specific devices or, more generally, an issue that arises after Zigbee2MQTT has successfully started, it should likely be reported in the Zigbee2MQTT issue tracker.
Feel free to create a PR for fixes and enhancements.
If you're submitting a PR and wish to test it locally:
zigbee2mqtt
container interactively.
docker exec -it $(docker ps | grep zigbee2mqtt | cut -d" " -f 1) /bin/sh
vi node_modules/zigbee-herdsman-converters/converters/toZigbee.js
zigbee2mqtt
container
docker restart $(docker ps | grep zigbee2mqtt | cut -d" " -f 1)