ioBroker.xiaomi-gateway3

Адаптер Xiaomi-gateway3 ioBroker

Этот адаптер позволяет ioBroker взаимодействовать с Xiaomi Gateway 3 и использовать его для управления устройствами Xiaomi. Адаптер взаимодействует со шлюзом по протоколу MQTT (он подключается к встроенному MQTT-брокеру). Однако вам необходимо выполнить сопряжение шлюза и устройств через Mi Home (Cloud).

Ранняя версия

Адаптер пока находится на стадии разработки, но уже обладает готовым функционалом.

Для успешной разработки адаптеров необходима помощь сообщества, в основном в тестировании адаптеров и устройств.

Спасибо

Значительная часть кода основана на проекте AlexxIT XiaomiGateway3 и переписана на его основе.

Чем вы можете помочь?

Во-первых, вы можете просто установить адаптер, использовать его и сообщить о любых проблемах.

Кроме того, если у вас много разных устройств, вы можете помочь улучшить их поддержку, включив соответствующую опцию.Debug output (to state) (см. ниже) и предоставьте мне отладочный вывод через несколько дней после сбора отладочных данных.

Аппаратное обеспечение и ограничения

Адаптер поддерживаетXiaomi Gateway 3 (ZNDMWG03LM and ZNDMWG02LM) Работает на оригинальной прошивке следующих версий:

v1.5.0_0026 (разработано на его основе)
v1.5.0_0102 (аналогично)1.5.0_0026 (но не тестировалось)

Вы можете прошить шлюз пользовательской или стандартной прошивкой следующих версий: wiki .

!!Внимание: Версии прошивки ниже1.4.7_0000 Адаптер не поддерживает и не будет поддерживаться. Поддержка версий ниже указанной.v1.5.0_0026 не гарантировано.

Поддерживаемые устройства

Проверено
Не тестировалось

Устройства Zigbee

BLE-устройства

Примечание: После сопряжения устройства BLE могут не иметь состояний, поскольку я не знаю их характеристик и пока не определил свойства для всех устройств. Состояния будут добавлены, когда устройство обновит соответствующие свойства. Надеюсь, со временем я смогу это исправить с вашей помощью.

Описание некоторых штатов

`Button long press`

Для кнопочных устройств можно увидеть комбинацию двух состояний (например).long_press иlong_timeout Как это работает? Кнопки, поддерживающие длительное нажатие, отправляют сообщение при нажатии и при отпускании. Иногда может возникнуть ситуация, когда кнопка не отправляет сообщение при отпускании. В этом случаеtimeout Это должно помочь "освободить" состояние.

По умолчаниюtimeout Значение состояния не установлено иlong_press Кнопка будет отпущена через 1 секунду после начала удержания, даже если вы продолжаете её удерживать. Если вы это настроитеlong_timeout Истечение времени ожидания -1 будет полностью проигнорировано, и состояние будет "освобождено" только сообщением от кнопки.

В большинстве случаев разумно установитьtimeout до небольшого значения, например, 4 или 5 секунд.

`Occupancy` и`Occupancy timeout`

Датчики движения RTCGQ11LM и другие имеют задержку (тайм-аут) после обнаружения движения от 5 до 60 секунд (в зависимости от версии и модификаций). Это означает, что в течение этого периода новое движение не может быть обнаружено (технически датчик не отправляет сообщение).

occupancyСтановится истинным, когда датчик обнаруживает движение, и остается таковым .

Цельoccupancy_timeout установленoccupancy Значение false устанавливается , когда датчик может снова отправлять сообщения. По умолчаниюoccupancy_timeout не задано иoccupancy Через 60 секунд значение снова станет «нет» . Если у вашего датчика другая задержка, лучше установить другое значение.occupancy_timeout до этого значения задержки.

Если вы хотите, чтобы значение возвращалось к false сразу после обнаружения движения, вы можете установить соответствующее значение.occupancy_timeout до 1 секунды.

Конфигурация

Для подключения шлюза необходимо получить IP-адрес и токен шлюза. Это можно сделать вручную или через облако.

Также вам нужно выбрать команду открытия telnet (в большинстве случаев вариант №2). Проверить соединение и подключиться к telnet можно с помощью кнопок.

Здесь используется не совсем ping, а скорее проверка доступности устройства.

У вас есть несколько вариантов настройки адаптера и шлюза.

Настройки адаптера

Собрать статистику
Адаптер собирает статистику о сообщениях, поступающих от устройств Zigbee: сколько получено, сколько пропущено и т. д. Статистика сохраняется в состоянии каждого устройства и может быть просмотрена на вкладке (из бокового меню).
Примечание: Адаптер сбрасывает статистику при перезапуске.
Отладочный вывод (в состояние)
Адаптер будет выводить некоторую отладочную информацию в состояние каждого устройства.

Основные настройки Gateway3

Telnet включен
Включено по умолчанию и должно оставаться включенным. Это просто для информации.
Включен публичный MQTT
Включено по умолчанию и должно оставаться включенным. Это просто для информации.
Блокировка прошивки
Установите значение true (или false), чтобы отключить (или включить) возможность обновления прошивки шлюза.
Отключить звуковой сигнал
Установите значение true, чтобы отключить надоедливые звуковые сигналы, или false, чтобы включить все сигналы.

Расширенные настройки Gateway3

Хранение в оперативной памяти (бета-версия)
Переместите файлы баз данных устройств в оперативную память. Это может улучшить работу устройств Zigbee и Bluetooth. Однако это может привести к потере части данных. Используйте на свой страх и риск.

Настройки ведения журнала

Примечание: Чтобы увидеть отладочные сообщения в журнале ioBroker, необходимо установить соответствующий параметр.debug уровень логирования для адаптера нижеInstances страница (включить экспертный режим)

Сообщения Lumi MQTT
Включить отладочное логирование сообщений MQTT на устройствах Lumi (Zigbee).
Сообщения Ble MQTT
Включить отладочное логирование сообщений MQTT на устройствах BLE.
Все остальное
Включите отладочное логирование для всех остальных сообщений адаптера.
Удалите спам
Включить удаление повторяющихся сообщений. Если одинаковые сообщения об ошибках повторяются несколько раз, они будут скрыты, а через 1 час отобразится общее количество.

Вкладка

Устройства

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

Также вы можете изменитьfriendly name устройства.

Примечание: На данный момент эта страница имеет базовый функционал. В будущем он будет расширен.

Конфигурация устройства

Вы можете задать некоторые параметры для настройки устройства (и карты устройства), написав конфигурацию в формате YAML. Доступные параметры описаны ниже в таблице. Вы можете вызвать окно настройки устройства (окно с текстовым полем ввода) с помощьюConfig указать в меню.

Параметры конфигурации устройства

Поле	Тип	Описание
cardStates	Словарь	Этот словарь содержит параметры состояний карты устройства.
cardStates.hide	Список	Список состояний (идентификаторов состояний), которые необходимо скрыть с карты устройства.

Статистика

Статистика по умолчанию не загружается. Вам нужно использовать кнопку.RELOAD Обновить статистику на странице.
Также вы можете очистить статистику с помощью кнопки.CLEAR Это фактически не очищает статистику. Вы просто очищаете состояния, которые содержат статистику. Это может быть полезно в случае перезапуска адаптера, поскольку состояния ioBroker не очищаются при перезапуске.

Внимание: следует помнить, что это не статистика сообщений Zigbee между шлюзом и устройством (статистика протокола Zigbee). Это статистика сообщений, которые получает адаптер. Что это значит? Для адаптера нет разницы, получает ли шлюз сообщение от устройства или сам адаптер не получает сообщение от шлюза (по протоколу MQTT). И если по какой-либо причине (например, из-за проблем с подключением Wi-Fi) адаптер не получает сообщения от шлюза, он интерпретирует эти сообщения как пропущенные, но на самом деле Zigbee работает нормально.

Changelog

0.3.6 (2022-06-14)

Fixes and improvements

0.3.5 (2022-05-08)

Added configuration for devices
Added cutting SPAM messages at log
Remove unnecessary Debug log option
Fixes and improvements

0.3.4 (2022-02-10)

Fix issue getting devices from cloud and switch to RC4
Add devices page
Other fixes and improvements

0.3.3 (2022-01-30)

Fix lumi temperature and voltage

0.3.2 (2022-01-30)

Bug fixes and code improvements
Add curtain and buttons support
Update README

0.3.1 (2022-01-17)

Bug fixes and code improvements
Improved support firmware 1.5.1_0032 and some devices

0.3.0 (2021-12-10)

Improved adapter logging

0.2.0 (2021-12-07)

Added states classes and rewrote code with using them
Added tab-page of adapter
Added zigbee (lumi) devices statistic
A lot of code improvements

0.1.0 (2021-11-09)

(Evgenii Abramov) Added support for BLE devices (needed tests)
(Evgenii Abramov) Improvements for zigbee and BLE support
(Evgenii Abramov) Added output for debug purpose
(Evgenii Abramov) A lot of code improvements

0.0.1-alpha.0 (2021-10-13)

(Evgenii Abramov) Initial release

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Xiaomi Gateway 3