Important
Currently in testing.
Zigbee2MQTT Home Assistant add-ons.
This is a refactoring of https://github.com/zigbee2mqtt/hassio-zigbee2mqtt with the following (major) changes:
- Rewrite to use s6-overlay & co, and improve configuration handling
⚠️ BREAKING: Useaddon_configmapping. See migration- Config folder is now included in Home Assistant add-on backups
- Each add-on now has its own config folder (if wanting to switch between regular and edge add-ons, you must copy over the data)
- The toggle to delete the add-on data when uninstalling the add-on will now remove your Zigbee2MQTT configuration (yaml, db, logs, etc.)
- All
configuration.yamlsettings are now handled either through the onboarding (can be forced in add-on configuration tab), the frontend once Zigbee2MQTT has started, or directly in the file itself (using add-on) while Zigbee2MQTT is stopped - The Zigbee2MQTT watchdog is now enabled by default, with
defaultsettings - For easier debugging (advanced), can now override app code through
app_overridesfolder in add-on config folder- On add-on start, if the
app_overridesfolder exists, its content is copied over the Zigbee2MQTT app folder (using exact folder structure) - Deleting the
app_overridesfolder will remove any override on next add-on start
- On add-on start, if the
For more details: https://www.home-assistant.io/common-tasks/os#installing-a-third-party-add-on-repository
If you are migrating an existing installation from https://github.com/zigbee2mqtt/hassio-zigbee2mqtt you will need to move your configuration.yaml (& logs if wanted). You can either do this with the config migrator add-on available in this repository, or manually (see below).
- Install the add-on, (check the add-on configuration page if anything needs changing for your setup)
- Install, start and open the Studio Code Server add-on from the add-on store
- In Menu > File > Add folder to workspace, select the
addon_configsfolder and add it - After the interface is done reloading, you should then see both the
/configand the/addon_configsfolders - If the appropriate
*_zigbee2mqtt*folder does not exist, you must create it- You can get the exact name the folder should have by navigating to the add-on page and taking note of the URL:
- Example URL:
http://homeassistant.local:8123/hassio/addon/abcd1234_zigbee2mqtt/info - Example folder name:
abcd1234_zigbee2mqtt ⚠️ Be sure to take the right add-on if you have multiple Zigbee2MQTT installed
- Example URL:
- You can get the exact name the folder should have by navigating to the add-on page and taking note of the URL:
- Move the contents of the
/config/zigbee2mqttfolder to the previously identified folder under/addon_configs- You should end up with something like this (uses example folder name from above):
addon_configsabcd1234_zigbee2mqttlogconfiguration.yamlcoordinator_backup.jsondatabase.dbdatabase.db.backupstate.json- ...
- You should end up with something like this (uses example folder name from above):
- Update the settings on the new add-on configuration page as needed (e.g. socat)
- Start the new add-on
Important
If, after this, Zigbee2MQTT keeps showing the onboarding page on start, check the above steps again.
Important
Once done, make sure to remove the old Zigbee2MQTT add-on so it does not conflict with the new one (auto-start & co). You can also remove the old repository from the add-on store and the old /config/zigbee2mqtt folder using Studio Code Server add-on to prevent misuse.