directman

<<< Back

Добавляем новые или недостающие метрики управления устройств в модуле zigbee2mqtt

Краткая инструкция, как самостоятельно добавить поддержку устройств в модуль поддержки zigbee2mqtt.

Введение

Колиечетво поддерживаемых устройств zigbee2mqtt растет семимильными шагами, зачастую автор модуля интеграции для MajorDoMo не успевает отслеживать появление новых устройств. К тому-же, довольно часто требуется само устройство, чтобы пртестировать правильность отправляемых параметров.

Коротко о структуре взаимодействия

Взаимодействие с устройствами происходит по протоколу MQTT. Обычно на странице устройства проекте zigbee2mqtt уже имеется описание метрик, по которым возможно взаимодействие с устройством. Возьмем для примера датчик JTYJ-GD-01LM_BW. Страница устройства доступна по кликабельной ссылке.

Как видим, для того, чтобу изменить чувствительность сенсора, необходимо отправить координатору сети сообщение, типа:

zigbee2mqtt/FRIENDLY_NAME/set
необходимо отправлять

{"sensitivity": NEW_VALUE}

Возможные значения: low, medium, high

Отправка таких вариаций возможна вручную со страницы устройства, либо с вкладки Сервис, или из сценария.

Управление из сценария:

include_once(DIR_MODULES . 'zigbee2mqtt/zigbee2mqtt.class.php');
$z2m = new zigbee2mqtt();
$z2m->sendcommand('zigbee2mqtt/0x00158D0002EE1285/set', '{"sensitivity":"medium"}');

где 0x00158D0002EE1285 - IEEE адрес вашего устройства.

Теперь настроим это взамодействие в Majordomo.

В модуле интеграции пока не предусмотрена отправка текстовых значений, кроме как ON, OFF, TRUE, FALSE, поэтому мы можем только прописать метрики, куда их необходимо отправлять со страницы устройства.

Структура базы данных устройств хранится в 2 файлах, которые вы можете править самостоятельно:
База данных устройств database1.inc.php
Список метрик устройств database1.inc.php

Вы можете править эти файлы из самого MajorDoMo с помощью дополнения KodExplorer, который устанавливается из маркета. Это очень крутой браузерный проводник с отличным редактором файлов с подсветкой синтаксиса.

Для добавления устройства в список устройств, необходимо добавить новую запись по аналогии. Путь до файлов базы данных лежит по адресу /modules/zigbee2mqtt/. В нашем примере для устройства JTYJ-GD-01LM_BW необходимо завести следующие данные.

database1.inc.php:

$par1['zigbeeModel'] = "JTYJ-GD-01LM_BW";
$par1['model'] = "JTYJ-GD-01LM_BW";
$par1['vendor'] = "Xiaomi";
$par1['type'] = "ыутыщк";
$par1['description'] = "MiJia Honeywell smoke detector";
$par1['supports'] = "";
$par1['extend'] = "";
$par1['fromZigbee'] = "";
$par1['toZigbee'] = "";
SQLInsert('zigbee2mqtt_devices_list', $par1);

и добавим для него метрики управления чувствительностью sensitivity и состоянием state:

database1.inc.php:

//JTYJ-GD-01LM_BW;
$par2['zigbeeModel'] = 'JTYJ-GD-01LM_BW';
$par2['type'] = "sensor";
$par2['state_topic'] =  "<Z2M_PATH>/<FRIENDLY_NAME>";
$par2['availability_topic'] = "<Z2M_PATH>/bridge/state";
$par2['payload_off'] = ""  ;
$par2['payload_on'] = ""  ;
$par2['value_template'] = "sensitivity";
$par2['command_topic'] = "<Z2M_PATH>/<FRIENDLY_NAME>/set"  ;
$par2['json_attributes'] = "";
$par2['device_class'] = "";
$par2['unit_of_measurement'] = "";
$par2['brightness'] = "";
$par2['color_temp'] = "";
$par2['xy'] = "";
$par2['command_value'] = "sensitivity";
SQLInsert('zigbee2mqtt_devices_command', $par2);

//JTYJ-GD-01LM_BW;
$par2['zigbeeModel'] = 'JTYJ-GD-01LM_BW';
$par2['type'] = "sensor";
$par2['state_topic'] =  "<Z2M_PATH>/<FRIENDLY_NAME>";
$par2['availability_topic'] = "<Z2M_PATH>/bridge/state";
$par2['payload_off'] = ""  ;
$par2['payload_on'] = ""  ;
$par2['value_template'] = "state";
$par2['command_topic'] = ""  ;
$par2['json_attributes'] = "";
$par2['device_class'] = "";
$par2['unit_of_measurement'] = "";
$par2['brightness'] = "";
$par2['color_temp'] = "";
$par2['xy'] = "";
$par2['command_value'] = "state";
SQLInsert('zigbee2mqtt_devices_command', $par2);

Теперь, давайте разберем все параметры, которые необходимы работы с устройствами:

zigbeeModel - модель устройства из database1.inc.php
type - тип устройства, произвольный (relay, dimmer, sensor и тд)
value_template - параметр, который будет изменяться, например state
command_value  - параметр, который будет изменяться, например state
payload_on - действие, когда   MajorDoMo отправляет  логическую единицу, обычно ON
payload_off -  действие, когда   MajorDoMo отправляет  логический ноль, обычно OFF
command_topic -  путь mqtt, куда необходимо отправлять новые значения, которые можно передать устройству (яркость, состояние, положение заслонки и тд).
availability_topic - путь mqtt, по которому модуль будет определять состояние устройства - необязательный параметр.
xy - true, если устройство поддерживает управление цветом по цветовым координатам 
json_attributes - не используется
device_class - не используется
unit_of_measurement - не используется
brightness - не используется
color_temp - не используется
availability_topic - не используется

Прошу простить, если некоторые параметры повторяются, данная структура была портирована по структуре базы данных zigbee2mqtt.

Картинки устройств хранятся по адресу /templates/zigbee2mqtt/img по имени устройства. Вы можете их самостоятельно добавить для всех пользователей через github

После того, как добавите данные по устройствам, не забудьте обновить вашу базу данных устройств на вкладке Сервис -> Update metrics.

Публикация изменений в базу данных

После тестирования огромная просьба отправить Pull Reqest для обновления базы данных в репозиторий модуля zigbee2mqtt. Это совсем не сложно, изменения можно внести даже без создания клона репозитория, прямо из браузера.

Первым делом необходимо зарегистрироваться на github, если у вас еще нет акаунта.

Если необходимо внести изменение в файл database1.inc.php, то из браузера по адресу https://github.com/directman66/majordomo-zigbee2mq... вам будет доступна кнопка с карандашом (Edit this file). При внесении изменений через этот режим, на сайте github будет автоматически создан path проекта модуля zigbee2mqtt и будет предложено создание Pull Reqest автоматически.

Конечно самый удобный вариант внесения изменений - это вариант из консоли, о ним много написано в сети.

Инструкции о том, как сделать свой первый PR
1) https://starkovden.github.io/Pull-request-workflow...
2) https://rustycrate.ru/%D1%80%D1%83%D0%BA%D0%BE%D0%...

Сделай свой вклад в развитие свободного ПО, сделай свой первый Pull Reqest.

После того, как опубликуете свой Pull Reqest, напишите пож-та автору дополнения на почту sannikovdi@yandex.ru, чтобы я его принял, так как по какойто причине уведомления с github мне не приходят.

Discuss (0) (2)

See also:
2021-02-16 Установка Majordomo на JetHUB D1
2021-02-02 Shelly 1
2020-09-30 Команды для назначения владельцев папок
2020-09-16 Собираем список ip вызывных панелей с поддержкой SIP
2020-07-03 Получаем безопасный доступ к Web странице MajorDoMo
2020-04-24 Установка MajorDoMo на synology в 3 клика
2020-02-13 Настройка модуля zigbee2mqtt для работы с zigbee2mqtt или шлюзом sls zigbee gateway
2020-02-13 Настройка модуля zigbee2mqtt для работы с zigbee2mqtt или шлюзом sls zigbee gateway
2020-01-25 Команды для настройки прав пользователей на папку с majordomo
2020-01-23 Отключаем строгий режим MYSQL штатными средствами
2019-10-12 Подключаем светодиодные ленты к контроллеру MegaD
2019-10-11 Варианты интеграции электроприводов
2019-09-30 Выбор источников сигнала телевизоров LG 2013
2019-09-29 Узнаем версию дистрибутива linux
2019-09-24 Установка необходимых пакетов в xpenology через docker
2019-09-16 Примеры разметки Markdown
2019-09-14 Краткий обзор выключателей, в том числе Sonoff T4EU1C
2019-09-13 Сценарий для канала @MajorDoMo_feed
2020-03-26 Опыт установки Synology DSM
2019-09-09 Делаем majordroid лаунчером андройд по-умолчанию.
2019-09-04 Реализация сценария "кто-то пришел"
2019-09-02 Отправляем график hightcharts свойства любого объекта в телеграмм
2019-09-17 Автономная сигнализация на базе контроллера megad-2561
2019-08-27 Управление громкостью терминалов через телеграмм
2019-08-26 Полноценная консоль в браузере (wetty)
2019-08-16 Точечное регулирование радиаторов отопления
2019-08-18 Собираем голосовой помощник на базе WM8960 Audio HAT и raspberry pi zero w
2019-08-13 Общедоступная ссылка с закатом, рассветом и текущей погодой
2019-07-24 Самый дешевый вариант видеонаблюдения
2019-07-22 Запуск MajorDroid на одноплатниках, старых планшетах, телефонах.
2019-07-22 Запуск Majordroid на старом железе
2019-07-15 Устанавливаем opencv и необходимые библиотеки на ubuntu 18.04 без использования python
2019-07-05 Решение проблемы Incorrect integer value: '' for column 'ID' at row 1
2019-07-04 О приборах учета и удаленном снятии показаний (вода и газ)
2019-07-04 О приборах учета и удаленном снятии показаний (электричество)
2019-07-03 Конвертируем rs-485 в TCP-IP
2019-06-24 Наблюдение за радиационной обстановкой в регионе
2019-06-06 Меню пылесоса Xiaomi в телеграмм
2019-06-06 Удобный просмотр данных сенсоров через телеграмм
2019-06-06 Просмотр камер через телеграмм
2019-06-06 Управление светом через телеграмм
2019-06-06 Колор-пикер для телеграм
2019-05-06 Список символов emoji
2019-04-17 Установка z-way на Ubuntu
2019-04-16 Решение проблемы ERROR 1040 (HY000): Too many connections
2018-09-09 Список домофонов с IP интерфейсом
2018-08-29 Список кондиционеров с wifi
2018-08-29 Список доступных к покупке IP колонок
2018-07-15 Интеграция датчика Mi flora plant к системе УД MAJORDOMO
2018-06-13 Полезные команды для работы с git
2018-05-27 преобразование html страниц в картинку и отправка в телеграмм
2018-05-24 Полезные sql запросы
2018-05-23 Создание образа nand памяти orange pi plus2
2018-05-16 Команды для работы с базой данных напрямую
2018-04-13 Индикаторы о заряде батареек без использования картинок
2018-04-06 Установка и настройка python на windows для работы систем распознавания
2018-04-05 Распознавание лиц подходящих к двери людей с помощью ip камеры и открытие двери, если нейросеть признала своего
2018-04-04 Управление таймерами выключения света
2018-04-04 Управление RGB контроллером на базе ESP8266
2018-04-03 Увеличение разрешения китайских камер на чипе hi3516c H264
2018-03-13 Использование колонки google home в качестве терминала Majordomo
2018-03-13 Установка и подключение rtl usb донгла для чтения датчиков температуры и кнопок 433 мгц
2018-03-13 Настройка брокера MQTT
2018-02-17 Проект "умная входная дверь"
2018-02-11 Отправка всех значений свойства объекта в телеграм
2017-12-21 получение адреса по GPS координатам
2017-12-21 получение / передача GPS координат сервису livegps.com
2017-12-21 чтение мгновенных данных U,P, I электросчетчика милур 104
2017-12-21 Получение координат с маяков и gsm сигнализаций starline-online.ru

Екатеринбург, Россия

На форуме: directman66