https://github.com/zigbee2mqtt/hassio-zigbee2mqtt
Official Zigbee2MQTT Home Assistant add-on
https://github.com/zigbee2mqtt/hassio-zigbee2mqtt
hassio hassio-addons hassio-repository home-assistant zigbee zigbee2mqtt
Last synced: 14 days ago
JSON representation
Official Zigbee2MQTT Home Assistant add-on
- Host: GitHub
- URL: https://github.com/zigbee2mqtt/hassio-zigbee2mqtt
- Owner: zigbee2mqtt
- License: apache-2.0
- Created: 2020-10-10T07:23:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T20:25:31.000Z (20 days ago)
- Last Synced: 2025-04-11T00:49:59.980Z (14 days ago)
- Topics: hassio, hassio-addons, hassio-repository, home-assistant, zigbee, zigbee2mqtt
- Language: Shell
- Homepage: https://www.zigbee2mqtt.io
- Size: 534 KB
- Stars: 1,450
- Watchers: 33
- Forks: 543
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Official Zigbee2MQTT Home Assistant add-on
> [!CAUTION]
> If you're using a Raspberry Pi, ensure you have at least a Raspberry Pi 4, as running it on a Raspberry Pi 3 may cause instability due to its limited resources.
## Installation
1. If you don't have an MQTT broker yet; in Home Assistant go to **[Settings → Add-ons → Add-on store](https://my.home-assistant.io/redirect/supervisor_store/)** and install the **[Mosquitto broker](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_mosquitto)** add-on, then start it.
1. Go back to the **Add-on store**, click **⋮ → Repositories**, fill in `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).
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fzigbee2mqtt%2Fhassio-zigbee2mqtt)
1. The repository includes two add-ons:
- **Zigbee2MQTT** is the stable release that tracks the released versions of Zigbee2MQTT. (**recommended for most users**)
- **Zigbee2MQTT Edge** tracks the `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.
1. Click on the add-on and press **Install** and wait till the add-on is installed.
1. Start the add-on by going to **Info** and click **Start**
1. Wait a few seconds and press **OPEN WEB UI**, you will now see the onboarding page. More information about the onboarding can be found [here](https://www.zigbee2mqtt.io/guide/getting-started/#onboarding).
1. Fill in the desired settings, for most setups changing the following is enough:
- Select your adapter under _Found Devices_, this will configure the _Coordinator/Adapter Port/Path_ and _Coordinator/Adapter Type/Stack/Driver_.
- Fill in the _Closests WiFi Channel_ to select the most optimal Zigbee channel.
1. Press **Submit**, Zigbee2MQTT will now start, wait a few seconds and refresh the page. You should now see the Zigbee2MQTT frontend.
- If it shows `502: Bad Gateway` wait a bit more and refresh the page.
- If this takes too long (e.g. 2 minutes +) check the **Log** tab to see what went wrong.
- In case the add-on fails to start with the following error: `USB adapter discovery error (No valid USB adapter found). Specify valid 'adapter' and 'port' in your configuration.`, we need to fill in the `serial` section. Format can be found [here](https://www.zigbee2mqtt.io/guide/configuration/adapter-settings.html#adapter-settings), but skip the initial `serial:` indent. e.g.:
```yaml
adapter: zstack
port: /dev/serial/by-id/usb-Texas_Instruments_TI_CC2531_USB_CDC___0X00124B0018ED3DDF-if00
```
If you don't know the port and you have just one USB device connected to your machine try `/dev/ttyUSB0` or `/dev/ttyAMA0`. Else use the [Home Assistant CLI](https://www.home-assistant.io/common-tasks/os#home-assistant-via-the-command-line) and execute `ha hardware info` to find out.
For more information see [the documentation](https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/blob/master/zigbee2mqtt/DOCS.md).
## Restoring data from a standalone installation
1. Ensure that both environments are running the same version
1. Ensure you can [SSH to your Home Assistant OS](https://community.home-assistant.io/t/howto-how-to-access-the-home-assistant-os-host-itself-over-ssh/263352) (NOT to the SSH Add-on)
1. Backup your standalone environment `data` folder (possibly leaving out the `logs/` folder)
1. Start the Zigbee2MQTT HA add-on with a non-existing `tty` device, to create the `data` folder
1. Restore your `data` folder contents into `/mnt/data/supervisor/homeassistant/zigbee2mqtt`, e.g. via `scp -O -P 22222 -i PATHTOUSEDSSHKEY ./data/* root@hass:/mnt/data/supervisor/homeassistant/zigbee2mqtt/`
1. Configure your serial port and MQTT settings using the HA add-on configuration UI
1. Edit the `/usr/share/hassio/homeassistant/zigbee2mqtt/configuration.yaml` file:
- Ensure that the serial port section matches the one configured with the UI
- Remove any irrelevant sections from the config (e.g. `mqtt` (if not needed), `advanced/log_syslog`, `frontend`)
1. Start the add-on
## Changelog
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
All notable changes to this project will be documented in the [CHANGELOG.md](zigbee2mqtt/CHANGELOG.md) file.
Version for releases is based on [Zigbee2MQTT](https://github.com/Koenkk/zigbee2mqtt) format: `X.Y.Z`.
Any changes on the add-on 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 add-on.
Edge version will not maintain a CHANGELOG and doesn't have a version.
## Issues
If you find any issues with the add-on, please check the [issue tracker](https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/issues) 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](https://github.com/Koenkk/zigbee2mqtt/issues).
Feel free to create a PR for fixes and enhancements.
### Testing changes locally
If you're submitting a PR and wish to test it locally:
- Gain root access to your Home Assistant installation
- In the Add-on Settings, Ensure "Watchdog" is turned off so the container isn't automatically restarted when it's stopped via the CLI
- Enter the `zigbee2mqtt` container interactively.
```
docker exec -it $(docker ps | grep zigbee2mqtt | cut -d" " -f 1) /bin/sh
```
- Edit the file you'd like to test & save.
```
vi node_modules/zigbee-herdsman-converters/converters/toZigbee.js
```
- Back on the Home Assistant installation, restart the `zigbee2mqtt` container
```
docker restart $(docker ps | grep zigbee2mqtt | cut -d" " -f 1)
```
- Refresh the web UI and perform your testing.
## Credits
- [danielwelch](https://github.com/danielwelch)
- [ciotlosm](https://github.com/ciotlosm)
- [Koenkk](https://github.com/Koenkk)