zigbee2mqtt README

The project's README from github.com/Koenkk/zigbee2mqtt. As one markdown file: README.md.



Zigbee2MQTT 🌉 🐝

Allows you to use your Zigbee devices without the vendor's bridge or gateway.

It bridges events and allows you to control your Zigbee devices via MQTT. In this way you can integrate your Zigbee devices with whatever smart home infrastructure you are using.

Getting started

The documentation provides you all the information needed to get up and running! Make sure you don't skip sections if this is your first visit, as there might be important details in there for you.

If you aren't familiar with Zigbee terminology make sure you read this to help you out.

Integrations

Zigbee2MQTT integrates well with (almost) every home automation solution because it uses MQTT. However the following integrations are worth mentioning:

Home Assistant

Home Assistant


Home Assistant OS using the official addon (other installations)


Homey

Homey


Integration implemented in the Homey App (documentation & support)


Domoticz

Domoticz


Integration implemented in Domoticz (documentation).


Gladys Assistant

Gladys Assistant


Integration implemented natively in Gladys Assistant (documentation).


ioBroker

ioBroker


Integration implemented in ioBroker (documentation).


Architecture

Architecture

Internal Architecture

Zigbee2MQTT is made up of three modules, each developed in its own Github project. Starting from the hardware (adapter) and moving up; zigbee-herdsman connects to your adapter to handle Zigbee communication and makes an API available to the higher levels of the stack. For e.g. Texas Instruments hardware, zigbee-herdsman uses the TI zStack monitoring and test API to communicate with the adapter. The module zigbee-herdsman-converters handles the mapping from individual device models to the Zigbee clusters they support. Zigbee clusters are the layers of the Zigbee protocol on top of the base protocol that define things like how lights, sensors and switches talk to each other over the Zigbee network. Finally, the Zigbee2MQTT module drives zigbee-herdsman and maps the zigbee messages to MQTT messages. Zigbee2MQTT also keeps track of the state of the system. It uses a database.db file to store this state; a text file with a JSON database of connected devices and their capabilities. Zigbee2MQTT provides several web-based interfaces (zigbee2mqtt-frontend, zigbee2mqtt-windfront) that allows monitoring and configuration.

Developing

Zigbee2MQTT uses TypeScript. Therefore after making changes to files in the lib/ directory you need to recompile Zigbee2MQTT. This can be done by executing pnpm run build. For faster development instead of running pnpm run build you can run pnpm run build:watch in another terminal session, this will recompile as you change files.

Before running any of the commands, you'll first need to run pnpm install --include=dev. Before submitting changes run pnpm run check:w then pnpm run test:coverage.

Supported devices

See Supported devices to check whether your device is supported. There is quite an extensive list, including devices from vendors like Xiaomi, Ikea, Philips, OSRAM and more.

If it's not listed in Supported devices, support can be added (fairly) easily, see How to support new devices.

Support & help

If you need assistance you can check opened issues. Feel free to help with Pull Requests when you were able to fix things or add new devices or just share the love on social media.

zigbee2mqtt (Koenkk/zigbee2mqtt)

Searching Database…

15.7K ·GitHub
Zigbee2mqtt
Что это такое?Zigbee2MQTT позволяет управлять вашими устройствами Zigbee через MQTT вместо фирменного моста или шлюза производителя, поэтому их можно подключить к любой удобной вам системе умного дома.
Это приложение, которое я устанавливаю, или сервис, который я запускаю сам?Это самостоятельно размещаемый сервис на Node.js/TypeScript, который постоянно работает на компьютере, подключённом к адаптеру Zigbee. Он включает веб-интерфейс (zigbee2mqtt-frontend или zigbee2mqtt-windfront) для мониторинга и настройки.
Как мне его запустить?Следуйте официальной документации: в ней описаны установка и первоначальная настройка, а также объяснена терминология Zigbee, если вы с ней не знакомы.
Нужны ли мне USB-адаптер Zigbee и брокер MQTT?Да. zigbee-herdsman нужен адаптер-координатор Zigbee (например, на оборудовании Texas Instruments), чтобы обмениваться данными с вашими устройствами. А поскольку Zigbee2MQTT передаёт всё через MQTT, также нужен запущенный брокер MQTT.
Поддерживает ли он каждое устройство Zigbee?Большинство популярных брендов, таких как Xiaomi, Ikea, Philips и OSRAM, поддерживаются, но сначала проверьте список поддерживаемых устройств. Устройства, которых нет в списке, обычно можно добавить достаточно легко, следуя руководству по поддержке устройств.
С какими платформами умного дома он работает?Поскольку он работает через MQTT, он подходит почти для любой системы домашней автоматизации. Есть также документированная интеграция с Home Assistant, Homey, Domoticz, Gladys Assistant и ioBroker.
Как Zigbee2MQTT отслеживает мои устройства?Он хранит подключённые устройства и их возможности в базе данных — файле database.db, который представляет собой текстовую базу данных в формате JSON и внутренне ведётся модулем Zigbee2MQTT.
Какие три внутренних модуля лежат в основе проекта?zigbee-herdsman отвечает за связь с аппаратным адаптером, zigbee-herdsman-converters сопоставляет модели устройств с кластерами Zigbee, а модуль Zigbee2MQTT объединяет всё это и передаёт сообщения в MQTT.
What are similar projects?glasshouse, esphome, WLED, ha_xiaomi_home, EchoMuse, Tasmota, core, local_roborock_server
Which topics is it in?smart-home, mqtt, home-assistant, home-automation, iot, hardware, json, dashboard, monitoring, hacktoberfest, gplv3, automation
Creator
Koenkk
Size
112.9 MB
Stars
15.7K
Updated
CommitOct 02Release2.14.2Oct 01
Age
8y
Commits · 90 Days