16 885
правок
(не показаны 43 промежуточные версии 5 участников) | |||
Строка 2: | Строка 2: | ||
== Описание == | == Описание == | ||
Для использования Zigbee-устройств с контроллером Wiren Board понадобится: | Для использования Zigbee-устройств с контроллером Wiren Board понадобится: | ||
# Модуль расширения [[ | # Модуль расширения [[WBE2R-R-ZIGBEE v.2 ZigBee Extension Module|WBE2R-R-ZIGBEE v.2]] ([[WBE2R-R-ZIGBEE v.1 ZigBee Extension Module|WBE2R-R-ZIGBEE v.1]]) или любой USB Zigbee стик. | ||
# Дополнительное ПО: | # Дополнительное ПО: | ||
#* zigbee2mqtt — мост, с помощью которого можно управлять Zigbee-устройствами через [[MQTT]], [https://www.zigbee2mqtt.io/supported-devices/ поддерживаемые устройства]. | #* zigbee2mqtt — мост, с помощью которого можно управлять Zigbee-устройствами через [[MQTT]], [https://www.zigbee2mqtt.io/supported-devices/ поддерживаемые устройства]. | ||
Строка 14: | Строка 14: | ||
=== Процесс установки === | === Процесс установки === | ||
Версия пакета zigbee2mqtt в стабильном релизе может отставать от актуальной версии, которая доступна у автора. Самая свежая версия всегда доступна в [[testing | тестовом релизе]]. | Версия пакета zigbee2mqtt в стабильном релизе может отставать от актуальной версии, которая доступна у автора. Самая свежая версия всегда доступна в [[testing | тестовом релизе]]. | ||
Мы рекомендуем устанавливать готовый пакет из нашего репозитория, их там два: | Мы рекомендуем устанавливать готовый пакет из нашего репозитория, их там два: | ||
* zigbee2mqtt — всегда свежая версия, рекомендуем ставить её. | * zigbee2mqtt — всегда свежая версия, рекомендуем ставить её. | ||
Строка 26: | Строка 24: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Чтобы установить 1.18.1, выполните: | |||
:<syntaxhighlight lang="bash"> | :<syntaxhighlight lang="bash"> | ||
apt update && apt install zigbee2mqtt-1.18.1 | apt update && apt install zigbee2mqtt-1.18.1 | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Альтернативный способ установки — сборка из исходников по [[Zigbee2mqtt-src | инструкции]]. | Альтернативный способ установки — сборка из исходников по [[Zigbee2mqtt-src | инструкции]]. | ||
Дальше мост надо настроить, смотрите раздел Конфигурация. | |||
После установки пакета сервис zigbee2mqtt будет запускаться автоматически при старте контроллера, вы можете отключать и включать автозапуск командами: | После установки пакета сервис zigbee2mqtt будет запускаться автоматически при старте контроллера, вы можете отключать и включать автозапуск командами: | ||
Строка 38: | Строка 38: | ||
systemctl enable zigbee2mqtt | systemctl enable zigbee2mqtt | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Конфигурация === | === Конфигурация === | ||
<div id="config"> | <div id="config"> | ||
Если вы используете модуль расширения [[WBE2R-R-ZIGBEE]], убедитесь, что правильно выставили модуль в '''Settings''' → '''Configs''' → '''Hardware Modules Configuration'''. При использовании USB-стика | Если вы используете модуль расширения [[WBE2R-R-ZIGBEE]], убедитесь, что правильно выставили модуль в '''Settings''' → '''Configs''' → '''Hardware Modules Configuration'''. При использовании USB-стика порт будет называться <code>/dev/ttyUSBx</code>, где x — номер порта, нумерация с нуля. | ||
Настройка: | Настройка: | ||
# Откройте файл конфигурации для редактированияː | # Откройте файл конфигурации для редактированияː | ||
#:<syntaxhighlight lang="bash"> | #:<syntaxhighlight lang="bash"> | ||
nano /mnt/data/root/zigbee2mqtt/data/configuration.yaml | |||
</syntaxhighlight> | </syntaxhighlight> | ||
# | # По умолчанию файл конфигурации выглядит так, в параметре '''port''' укажите порт, куда физически вставлен модуль: | ||
#:<syntaxhighlight lang="bash"> | #:<syntaxhighlight lang="bash"> | ||
homeassistant: false | homeassistant: false | ||
Строка 72: | Строка 56: | ||
server: 'mqtt://localhost' | server: 'mqtt://localhost' | ||
serial: | serial: | ||
port: /dev/ | port: /dev/ttyMOD4 | ||
advanced: | advanced: | ||
rtscts: false | rtscts: false | ||
last_seen: epoch | last_seen: epoch | ||
pan_id: GENERATE | |||
network_key: GENERATE | |||
</syntaxhighlight> | </syntaxhighlight> | ||
#: | #: вместо GENERATE после первого запуска моста появятся значения, не изменяйте их. | ||
# | # {{Wbincludes:Save nano}} | ||
# Перезапустите сервис <code>zigbee2mqtt</code>: | # Перезапустите сервис <code>zigbee2mqtt</code>: | ||
#:<syntaxhighlight lang="bash"> | #:<syntaxhighlight lang="bash"> | ||
systemctl restart zigbee2mqtt | systemctl restart zigbee2mqtt | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Теперь вы можете установить конвертер wb-zigbee2mqtt и Zigbee-устройства будут добавлены на вкладку '''Devices''' в стандартном веб-интерфейсе контроллера. | Теперь вы можете установить конвертер wb-zigbee2mqtt и Zigbee-устройства будут добавлены на вкладку '''Devices''' в стандартном веб-интерфейсе контроллера. | ||
Строка 92: | Строка 77: | ||
# Откройте файл <code>configuration.yaml</code> для редактированияː | # Откройте файл <code>configuration.yaml</code> для редактированияː | ||
#:<syntaxhighlight lang="bash"> | #:<syntaxhighlight lang="bash"> | ||
nano /mnt/data/root/zigbee2mqtt/data/configuration.yaml | |||
</syntaxhighlight> | </syntaxhighlight> | ||
# Добавьте в него блок: | # Добавьте в него блок: | ||
Строка 107: | Строка 92: | ||
Веб-интерфейс моста zigbee2mqtt будет доступен по адресу http://wb-ip-address:PORT, например, если IP-адрес контроллера '''192.168.42.1''', а порт указан '''8081''', то веб-интерфейс будет доступен по адресу http://192.168.42.1:8081 | Веб-интерфейс моста zigbee2mqtt будет доступен по адресу http://wb-ip-address:PORT, например, если IP-адрес контроллера '''192.168.42.1''', а порт указан '''8081''', то веб-интерфейс будет доступен по адресу http://192.168.42.1:8081 | ||
=== Обновление === | |||
Для обновления zigbee2mqtt на свежую версию просто обновите программное обеспечение контроллера по [[Wiren_Board_Software | инструкции]]. Будут сохранены все настройки и подключенные устройства. | |||
Если у вас старый адаптер [[WBE2R-R-ZIGBEE v.1 ZigBee Extension Module | WBE2R-R-ZIGBEE v.1]], выпущенный до января 2022 года, то новая версия работать не будет, в этом случае у вас есть три варианта: | |||
* Прошить старый адаптер свежей прошивкой, [[WBE2R-R-ZIGBEE v.1 ZigBee Extension Module#flashing | инструкция]]. | |||
* Поставить пакет с версией, которая работает с этими адаптерами — это возможно сделать только на релизе wb-2207, в более свежих релизах на bullseye этого пакета нет: | |||
*:<syntaxhighlight lang="bash"> | |||
apt install zigbee2mqtt-1.18.1 | |||
</syntaxhighlight> | |||
* Заменить адаптер на [[WBE2R-R-ZIGBEE v.2 ZigBee Extension Module | WBE2R-R-ZIGBEE v.2]] или использовать [https://www.zigbee2mqtt.io/guide/adapters/ поддерживаемый USB-стик]. | |||
== Конвертер wb-zigbee2mqtt == | == Конвертер wb-zigbee2mqtt == | ||
Строка 114: | Строка 110: | ||
=== Принцип работы === | === Принцип работы === | ||
Конвертер wb-zigbee2mqtt запрашивает у zigbee2mqtt список всех подключенных устройств и подписывается на их топики. При получении данных от физических устройств конвертер парсит json, создает виртуальное устройство и посылает в него полученную информацию. | Конвертер '''wb-zigbee2mqtt''' запрашивает у zigbee2mqtt список всех подключенных устройств и подписывается на их топики. При получении данных от физических устройств конвертер парсит json, создает виртуальное устройство и посылает в него полученную информацию. | ||
Так же конвертер создает виртуальное устройство | Так же конвертер создает виртуальное устройство ''zigbee2mqtt'' и передает в него логи, версию и состояние (online\offline) моста zigbee2mqtt. Можно включить и выключить режим добавления устройств. Также там расположена кнопка ''Update devices''. При нажатии на эту кнопку конвертер заново запрашивает у моста список добавленных устройств и, если они появились — подписывается на них. | ||
=== Установка === | === Установка === | ||
wb-zigbee2mqtt ставится автоматически при установке пакета zigbee2mqtt, если этого не произошло, установите его командой: | |||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
apt update && apt install wb-zigbee2mqtt | apt update && apt install wb-zigbee2mqtt | ||
</syntaxhighlight> | </syntaxhighlight> | ||
После этого в веб- | После этого в стандартном веб-интерфейсе контроллера на вкладке ''Devices'' появится устройство ''zigbee2mqtt''. | ||
=== Добавление устройств === | === Добавление устройств === | ||
[[Image: WebUI Add Zigbee Device.png |300px|thumb|right| Добавление устройства, сообщение '' | [[Image: WebUI Add Zigbee Device.png |300px|thumb|right| Добавление устройства, сообщение ''Device '0x00158d0007013f71' is supported.'']] | ||
[[Image: WebUI Add Zigbee Device Unsupported.png |300px|thumb|right| Неподдерживаемое устройство | [[Image: WebUI Add Zigbee Device Unsupported.png |300px|thumb|right| Неподдерживаемое устройство, сообщение ''Device '0x2c1165fffeabe0b8' not supported.'']] | ||
Устройства можно добавлять по одному или все разом. Чтобы добавить новые устройства: | Устройства можно добавлять по одному или все разом. Чтобы добавить новые устройства: | ||
# Перейдите в веб-интерфейс контроллера. | # Перейдите в [[Wiren Board Web Interface | стандартный веб-интерфейс контроллера]]. | ||
# Откройте вкладку '''Devices'''. | # Откройте вкладку '''Devices'''. | ||
# Найдите там карточку устройства '''Zigbee2mqtt''' и проверьте статус в поле '''State''' — должно быть написано '''online'''. | # Найдите там карточку устройства '''Zigbee2mqtt''' и проверьте статус в поле '''State''' — должно быть написано '''online'''. Если вы только, что установили zigbee2mqtt и указан статус ''offline'' — подождите пару минут. | ||
# Включите переключатель '''Permit join'''. | # Включите переключатель '''Permit join'''. | ||
# Следуйте инструкции к Zigbee-устройству: в основном требуется зажать на устройстве кнопку '''pair''' на несколько секунд и дождаться | # Следуйте инструкции к Zigbee-устройству: в основном требуется зажать на устройстве кнопку '''pair''' на несколько секунд и дождаться мигания индикатора на устростве. | ||
# В процессе добавления устройства в карточке '''Zigbee2mqtt''' в поле Log по очереди будут появляться сообщения '' | # В процессе добавления устройства в карточке '''Zigbee2mqtt''' в поле Log по очереди будут появляться сообщения ''Starting interview on 0xN → Device 0xN is supported''. Последнее сообщение означает, что устройство успешно опрошено. | ||
# Повторите шаги 5 и 6 для каждого Zigbee-устройства, которое у вас есть. | # Повторите шаги 5 и 6 для каждого Zigbee-устройства, которое у вас есть. | ||
# Завершите добавление устройств, для этого выключите переключатель '''Permit join'''. | # Завершите добавление устройств, для этого выключите переключатель '''Permit join'''. | ||
# Нажмите кнопку '''Update devices''', добавленные устройства будут доступны на вкладке '''Devices'''. | # Нажмите кнопку '''Update devices''', добавленные устройства будут доступны на вкладке '''Devices'''. | ||
Иногда, новые устройства не появляются на вкладке Devices — это может быть по | Иногда, новые устройства не появляются на вкладке Devices — это может быть по причинам: | ||
# Произошла ошибка в конвертере при разборе данных от zigbee2mqtt, в этом случае перезапустите движок правил: | # Произошла ошибка в конвертере при разборе данных от zigbee2mqtt, в этом случае перезапустите движок правил: | ||
#: <syntaxhighlight lang="bash"> | #: <syntaxhighlight lang="bash"> | ||
systemctl restart wb-rules | systemctl restart wb-rules | ||
</syntaxhighlight> | </syntaxhighlight> | ||
# Некоторые устройства не поддерживаются zigbee2mqtt, для таких устройств в сообщении | # Некоторые устройства не поддерживаются zigbee2mqtt, для таких устройств в сообщении будет указано ''Starting interview on 0xN → Device 0xN ... is NOT supported''. В этом случае убедитесь, что устройство есть в [https://www.zigbee2mqtt.io/supported-devices/ списке поддерживаемых] и у вас установлена свежая версия zigbee2mqtt. | ||
Ещё бывает так, что карточка устройства появилась, но пустая — это значит, что устройство добавлено, но данные пока не были получены. Если это датчик, то тут нужно немного подождать, а в случае с выключателем — выключить или включить его. | |||
=== Изменение friendly_name === | === Изменение friendly_name === | ||
Строка 151: | Строка 150: | ||
# Откройте файл конфигурации для редактированияː | # Откройте файл конфигурации для редактированияː | ||
#:<syntaxhighlight lang="bash"> | #:<syntaxhighlight lang="bash"> | ||
nano /mnt/data/root/zigbee2mqtt/data/configuration.yaml | |||
</syntaxhighlight> | </syntaxhighlight> | ||
# Найдите в секции '''devices''' ваше устройство. | # Найдите в секции '''devices''' ваше устройство. | ||
Строка 159: | Строка 158: | ||
systemctl restart zigbee2mqtt | systemctl restart zigbee2mqtt | ||
</syntaxhighlight> | </syntaxhighlight> | ||
# В стандартном веб- | # В стандартном веб-интерфейсе контроллера на вкладке Devices должно появиться устройство с заданным именем. | ||
# Удалите карточку устройства со старым именем с вкладки Devices, для этого нажмите на корзинку в заголовке. | # Удалите карточку устройства со старым именем с вкладки Devices, для этого нажмите на корзинку в заголовке. | ||
Новое имя | Новое имя устройства должно соответствовать [https://www.zigbee2mqtt.io/guide/configuration/devices-groups.html#common-device-options этим требованиям] (плюс нельзя использовать косую черту <code>/</code>) и не должно быть одинаковым для нескольких устройств, а также соответствовать определённым правилам — так называемым соглашениям ([https://github.com/wirenboard/conventions/blob/main/README.md Wiren Board MQTT Conventions]). | ||
<gallery mode="packed" heights="150px" caption="Изменение friendly_name"> | <gallery mode="packed" heights="150px" caption="Изменение friendly_name"> | ||
Строка 171: | Строка 170: | ||
=== Управление устройствами === | === Управление устройствами === | ||
Управление | Управление через конвертер wb-zigbee2mqtt пока не реализовано, но вы можете управлять устройствами [https://www.zigbee2mqtt.io/information/mqtt_topics_and_message_structure.html#zigbee2mqttfriendly_nameset стандартными инструментами zigbee2mqtt] через wb-rules, отправляя команды с помощью функции ''publish''. | ||
Пример включения и отключения реле в правилах [[wb-rules]]: | Пример включения и отключения реле с ''friendly_name'' равным ''0x00158d0001f3fc34'' в правилах [[wb-rules]]: | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
publish("zigbee2mqtt/0x00158d0001f3fc34/set", JSON.stringify({ state: "ON" }), 2, false); | publish("zigbee2mqtt/0x00158d0001f3fc34/set", JSON.stringify({ state: "ON" }), 2, false); | ||
publish("zigbee2mqtt/0x00158d0001f3fc34/set", JSON.stringify({ state: "OFF" }), 2, false); | publish("zigbee2mqtt/0x00158d0001f3fc34/set", JSON.stringify({ state: "OFF" }), 2, false); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Вместо wb-rules вы можете использовать [[Node-RED]]. | |||
=== Удаление устройств === | === Удаление устройств === | ||
Чтобы удалить устройство | Чтобы удалить устройство: | ||
# | # Убедитесь, что в карточке устройства с заголовком ''Zigbee2mqtt'' перключатель '''Permit join''' находится в положении ''OFF''. | ||
# | # Разорвите связь устройства с координатором. Обычно для этого нужно зажать кнопку сопряжения на 5 секунд, смотрите документацию на устройство. | ||
# | # Проследите, чтобы в карточке с заголовком ''Zigbee2mqt''t в поле '''Log''' появилось сообщение ''left_network''. | ||
# | # Удалите карточку этого Zigbee-устройства из веб-интерфейса, для этого наведите на заголовок карточки курсор мыши и нажмите на корзинку. | ||
# Подключитесь к контроллеру по [[SSH]] и перезапустите wb-rules — это перезапустит конвертер wb-zigbee2mqtt: | |||
#:<syntaxhighlight lang="bash"> | #:<syntaxhighlight lang="bash"> | ||
systemctl restart wb-rules | systemctl restart wb-rules | ||
Строка 191: | Строка 193: | ||
<gallery mode="packed" heights="180px"> | <gallery mode="packed" heights="180px"> | ||
Image: WebUI Zigbee Device Left Network.png | Сообщение ''left_network'' | Image: WebUI Zigbee Device Left Network.png | Сообщение ''left_network'' | ||
Image: WebUI Zigbee Device Remove.png | Корзинка для удаления Zigbee-устройства | Image: WebUI Zigbee Device Remove.png | Корзинка для удаления карточки Zigbee-устройства | ||
</gallery> | </gallery> | ||
=== Как переустановить с сохранением данных === | |||
В некоторых случаях может потребоваться переустановить конвертер с сохранением данных, например, если мост не стартует после обновления. | |||
Инструкция: | |||
# Перейдите в домашний каталог: | |||
#:<syntaxhighlight lang="bash"> | |||
cd ~ | |||
</syntaxhighlight> | |||
# Сохраните настройки: | |||
#:<syntaxhighlight lang="bash"> | |||
cp -R /mnt/data/root/zigbee2mqtt/data data-backup | |||
</syntaxhighlight> | |||
# Удалите zigbee2mqtt командой: | |||
#:<syntaxhighlight lang="bash"> | |||
apt purge zigbee2mqtt | |||
</syntaxhighlight> | |||
# Если остался каталог с node-modules — удалите его: | |||
#:<syntaxhighlight lang="bash"> | |||
rm -r /mnt/data/root/zigbee2mqtt/node_modules | |||
</syntaxhighlight> | |||
# Заново поставьте zigbee2mqtt: | |||
#:<syntaxhighlight lang="bash"> | |||
apt install zigbee2mqtt | |||
</syntaxhighlight> | |||
# Восстановите настройки из архива: | |||
#:<syntaxhighlight lang="bash"> | |||
cp -R data-backup/* /mnt/data/root/zigbee2mqtt/data | |||
</syntaxhighlight> | |||
# Перезапустите сервис: | |||
#:<syntaxhighlight lang="bash"> | |||
systemctl restart zigbee2mqtt | |||
</syntaxhighlight> | |||
== Диагностика неисправностей == | == Диагностика неисправностей == | ||
Если вы столкнулись с проблемами в работе zigbee2mqtt, то прояснить ситуацию поможет | Если вы столкнулись с проблемами в работе zigbee2mqtt, то прояснить ситуацию поможет статус сервиса и чтение подробных логов. Для выполнения команд подключитесь к контроллеру по [[SSH]]. | ||
Посмотреть текущий статус и последние несколько сообщений из лога можно командой: | Посмотреть текущий статус и последние несколько сообщений из лога можно командой: | ||
Строка 212: | Строка 248: | ||
[[Image: zigbee2mqtt-wrong-start.png |300px|thumb|right| Пример проблем при запуске zigbee2mqtt командой ''npm start'' ]] | [[Image: zigbee2mqtt-wrong-start.png |300px|thumb|right| Пример проблем при запуске zigbee2mqtt командой ''npm start'' ]] | ||
[[Image: zigbee2mqtt-successful-start.png |300px|thumb|right| Пример успешного запуска zigbee2mqtt при выполнении команды ''npm start'' ]] | [[Image: zigbee2mqtt-successful-start.png |300px|thumb|right| Пример успешного запуска zigbee2mqtt при выполнении команды ''npm start'' ]] | ||
Часто бывает так, что из предыдущего шага причина непонятна, в этом случае нужно смотреть логи: | Часто бывает так, что из предыдущего шага мы видим наличие проблемы, но причина непонятна, в этом случае нужно смотреть логи: | ||
# Остановите сервис командой: | # Остановите сервис командой: | ||
#:<syntaxhighlight lang="bash"> | #:<syntaxhighlight lang="bash"> | ||
Строка 221: | Строка 257: | ||
cd /mnt/data/root/zigbee2mqtt/ | cd /mnt/data/root/zigbee2mqtt/ | ||
</syntaxhighlight> | </syntaxhighlight> | ||
# Запустите zigbee2mqtt в ручном режиме с выводом | # Запустите zigbee2mqtt в ручном режиме с выводом всех сообщений в консоль командой <code>npm start</code>: | ||
#:<syntaxhighlight lang="console" highlight="12"> | #:<syntaxhighlight lang="console" highlight="12"> | ||
# npm start | # npm start | ||
Строка 270: | Строка 306: | ||
== Полезные ссылки == | == Полезные ссылки == | ||
* [https://www.zigbee2mqtt.io/ Документация zigbee2mqtt] | * [https://www.zigbee2mqtt.io/ Документация zigbee2mqtt] | ||
* [https://habr.com/ru/company/wirenboard/blog/713274/ Работаем с Zigbee-устройствами через Zigbee2mqtt и Node-RED] | |||
* [https://habr.com/ru/companies/wirenboard/articles/750640/ Подключаем Zigbee-устройства к контроллеру Wiren Board и пишем сценарии на wb-rules] | |||
* [[zigbee2mqtt-src| Сборка zigbee2mqtt из исходников]] | * [[zigbee2mqtt-src| Сборка zigbee2mqtt из исходников]] |