{"id":13495448,"url":"https://github.com/zigbee2mqtt/hassio-zigbee2mqtt","last_synced_at":"2026-06-09T21:00:46.265Z","repository":{"id":37279285,"uuid":"302841413","full_name":"zigbee2mqtt/hassio-zigbee2mqtt","owner":"zigbee2mqtt","description":"Official Zigbee2MQTT Home Assistant add-on","archived":false,"fork":false,"pushed_at":"2026-06-01T18:51:59.000Z","size":601,"stargazers_count":1896,"open_issues_count":7,"forks_count":752,"subscribers_count":32,"default_branch":"master","last_synced_at":"2026-06-01T20:28:18.612Z","etag":null,"topics":["hassio","hassio-addons","hassio-repository","home-assistant","zigbee","zigbee2mqtt"],"latest_commit_sha":null,"homepage":"https://www.zigbee2mqtt.io","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zigbee2mqtt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-10-10T07:23:05.000Z","updated_at":"2026-06-01T18:53:12.000Z","dependencies_parsed_at":"2026-02-19T22:04:27.946Z","dependency_job_id":null,"html_url":"https://github.com/zigbee2mqtt/hassio-zigbee2mqtt","commit_stats":{"total_commits":456,"total_committers":65,"mean_commits":7.015384615384615,"dds":0.631578947368421,"last_synced_commit":"4625c6f1e2821db15bf1dbd6642f1fe961be0d58"},"previous_names":[],"tags_count":141,"template":false,"template_full_name":null,"purl":"pkg:github/zigbee2mqtt/hassio-zigbee2mqtt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbee2mqtt%2Fhassio-zigbee2mqtt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbee2mqtt%2Fhassio-zigbee2mqtt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbee2mqtt%2Fhassio-zigbee2mqtt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbee2mqtt%2Fhassio-zigbee2mqtt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zigbee2mqtt","download_url":"https://codeload.github.com/zigbee2mqtt/hassio-zigbee2mqtt/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zigbee2mqtt%2Fhassio-zigbee2mqtt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34125332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hassio","hassio-addons","hassio-repository","home-assistant","zigbee","zigbee2mqtt"],"created_at":"2024-07-31T19:01:34.850Z","updated_at":"2026-06-09T21:00:46.259Z","avatar_url":"https://github.com/zigbee2mqtt.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/zigbee2mqtt/hassio-zigbee2mqtt\"\u003e\n        \u003cimg width=\"150\" height=\"150\" src=\"zigbee2mqtt/logo.png\"\u003e\n    \u003c/a\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003cdiv style=\"display: flex;\"\u003e\n        \u003ca href=\"https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/actions?query=workflow%3ACI\"\u003e\n            \u003cimg src=\"https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/workflows/CI/badge.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/releases\"\u003e\n            \u003cimg src=\"https://img.shields.io/github/release/zigbee2mqtt/hassio-zigbee2mqtt.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/stargazers\"\u003e\n            \u003cimg src=\"https://img.shields.io/github/stars/zigbee2mqtt/hassio-zigbee2mqtt.svg\"\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://discord.gg/dadfWYE\"\u003e\n            \u003cimg src=\"https://img.shields.io/discord/556563650429583360.svg\"\u003e\n        \u003c/a\u003e\n    \u003c/div\u003e\n    \u003ch1\u003eOfficial Zigbee2MQTT Home Assistant app\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003e [!CAUTION]\n\u003e 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.\n\n## Installation\n\n1. If you don't have an MQTT broker yet; in Home Assistant go to **[Settings → Apps → App 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)** app, then start it.\n1. Go back to the **App store**, click **⋮ → Repositories**, fill in\u003c/br\u003e `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).\n   [![Open your Home Assistant instance and show the add app repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fzigbee2mqtt%2Fhassio-zigbee2mqtt)\n1. The repository includes two apps:\n   - **Zigbee2MQTT** is the stable release that tracks the released versions of Zigbee2MQTT. (**recommended for most users**)\n   - **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.\n1. Click on the app and press **Install** and wait till the app is installed.\n1. Start the app by going to **Info** and click **Start**\n1. 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).\n1. Fill in the desired settings, for most setups changing the following is enough:\n   - Select your adapter under _Found Devices_, this will configure the _Coordinator/Adapter Port/Path_ and _Coordinator/Adapter Type/Stack/Driver_.\n   - Fill in the _Closests WiFi Channel_ to select the most optimal Zigbee channel.\n1. Press **Submit**, Zigbee2MQTT will now start, wait a few seconds and refresh the page. You should now see the Zigbee2MQTT frontend.\n   - If it shows `502: Bad Gateway` wait a bit more and refresh the page.\n   - If this takes too long (e.g. 2 minutes +) check the **Log** tab to see what went wrong.\n   - In case the app 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.: \u003cbr\u003e\n     ```yaml\n     adapter: zstack\n     port: /dev/serial/by-id/usb-Texas_Instruments_TI_CC2531_USB_CDC___0X00124B0018ED3DDF-if00\n     ```\n     If you don't know the port and you have just one USB device connected to your machine try `/dev/ttyACM0` or `/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.\n\nFor more information see [the documentation](https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/blob/master/zigbee2mqtt/DOCS.md).\n\n## Restoring data from a standalone installation\n\n1. Ensure that both environments are running the same version\n1. 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 App)\n1. Backup your standalone environment `data` folder (possibly leaving out the `logs/` folder)\n1. Start the Zigbee2MQTT HA app with a non-existing `tty` device, to create the `data` folder\n1. 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/`\n1. Configure your serial port and MQTT settings using the HA app configuration UI\n1. Edit the `/usr/share/hassio/homeassistant/zigbee2mqtt/configuration.yaml` file:\n   - Ensure that the serial port section matches the one configured with the UI\n   - Remove any irrelevant sections from the config (e.g. `mqtt` (if not needed), `advanced/log_syslog`, `frontend`)\n1. Start the app\n\n## Changelog\n\nThe format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).\n\nAll notable changes to this project will be documented in the [CHANGELOG.md](zigbee2mqtt/CHANGELOG.md) file.\n\nVersion for releases is based on [Zigbee2MQTT](https://github.com/Koenkk/zigbee2mqtt) format: `X.Y.Z`.\n\nAny changes on the app 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 app.\n\nEdge version will not maintain a CHANGELOG and doesn't have a version.\n\n## Issues\n\nIf you find any issues with the app, 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).\n\nFeel free to create a PR for fixes and enhancements.\n\n### Testing changes locally\n\nIf you're submitting a PR and wish to test it locally:\n\n- Gain root access to your Home Assistant installation\n- In the App Settings, Ensure \"Watchdog\" is turned off so the container isn't automatically restarted when it's stopped via the CLI\n\n![image](https://user-images.githubusercontent.com/1923186/198087147-7ab2ba1e-1a68-41b8-9a84-76b25b329786.png)\n\n- Enter the `zigbee2mqtt` container interactively.\n\n```\ndocker exec -it $(docker ps | grep zigbee2mqtt | cut -d\" \" -f 1) /bin/sh\n```\n\n- Edit the file you'd like to test \u0026 save.\n\n```\nvi node_modules/zigbee-herdsman-converters/converters/toZigbee.js\n```\n\n- Back on the Home Assistant installation, restart the `zigbee2mqtt` container\n\n```\ndocker restart $(docker ps | grep zigbee2mqtt | cut -d\" \" -f 1)\n```\n\n- Refresh the web UI and perform your testing.\n\n## Credits\n\n- [danielwelch](https://github.com/danielwelch)\n- [ciotlosm](https://github.com/ciotlosm)\n- [Koenkk](https://github.com/Koenkk)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzigbee2mqtt%2Fhassio-zigbee2mqtt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzigbee2mqtt%2Fhassio-zigbee2mqtt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzigbee2mqtt%2Fhassio-zigbee2mqtt/lists"}