# Zigbee2MQTT

Zigbee2MQTT is a self-hosted Zigbee-to-MQTT bridge that lets home-automation users control Zigbee devices without vendor hubs by exposing device state and commands over MQTT. It is open source and self-hosted, installable on Docker Hub, Proxmox, Kubernetes (Helm), ZimaOS, TrueNAS, Umbrel and Unraid.

Canonical page: https://ourlocalhost.com/app/347/zigbee2mqtt

## Description

Zigbee2MQTT is a self-hosted Zigbee-to-MQTT bridge that lets home-automation users control Zigbee devices without vendor hubs by exposing device state and commands over MQTT.

## Platform availability

Available on 6 of 9 platforms: Unraid, TrueNAS, Umbrel, ZimaOS, Proxmox, Helm.

## Health score

39/100 (Low), based on 3 of 4 factors.
- Maintained: 0 (GitHub repository no longer exists)
- Easy to install: 85 (6 install platforms, install notes, Docker image)
- Light to run: 80 (1 GB minimum RAM, runs on ARM)

## Links

- Docker Hub: https://hub.docker.com/r/koenkk/zigbee2mqtt/
- GitHub: https://github.com/koenkk/zigbee2mqtt
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=zigbee2mqtt
- Kubernetes (Helm): https://artifacthub.io/packages/helm/andrenarchy/zigbee2mqtt
- ZimaOS: https://github.com/bigbeartechworld/big-bear-casaos/tree/master/Apps/zigbee2mqtt
- TrueNAS: https://apps.truenas.com/catalog/zigbee2mqtt/
- Umbrel: https://apps.umbrel.com/app/zigbee2mqtt
- Unraid: https://ca.unraid.net/apps/zigbee2mqtt-0t8ueud05zrtkx?q=zigbee2mqtt

## Common questions

### What do I need to set in configuration.yaml before starting a new Zigbee2MQTT network?

Point the MQTT server setting to your broker and set the serial port to your USB Zigbee stick. Leave GENERATE for the network keys if this is a new Zigbee network, because wrong values can stop devices from joining.

### How can I tell from the logs that Zigbee2MQTT started successfully?

Look for lines such as 'zigbee-herdsman started' and 'Connected to MQTT server'. If those are missing, it usually means a bad serial port, wrong MQTT address, or a startup failure.

### How do I reset a Zigbee device that was used on another network before pairing it?

Use the device’s reset procedure to remove its previous network binding. In the shared example, the user plugged the bulb in and performed a six times on/off cycle.

### Does Zigbee2MQTT support devices that only use the Zigbee Smart Energy profile?

No, Zigbee2MQTT does not currently support devices that can only use the ZSE profile. That limitation is because the Zigbee SE specification is not part of the standard Zigbee 3.0 specification it follows.

---
Source: Our Local Host (https://ourlocalhost.com/app/347/zigbee2mqtt), the self-hosted and open-source app directory.