Voznemozhno: /* exposes */

2024-09-05T10:06:57Z

exposes

← Предыдущая версия		Версия от 10:06, 5 сентября 2024
Строка 92:		Строка 92:

	=== <code>exposes</code> ===		=== <code>exposes</code> ===
	Массив [[Common/Exposes\|~~возможностей~~]] устройства.		Массив [[Common/Exposes\|способностей]] устройства.

	=== <code>options</code> ===		=== <code>options</code> ===

Voznemozhno: /* Характеристики устройств */

2024-09-05T10:06:40Z

Характеристики устройств

← Предыдущая версия		Версия от 10:06, 5 сентября 2024
Строка 11:		Строка 11:
	* [https://github.com/u236/homed-service-zigbee/blob/master/reporting.cpp Отчеты]		* [https://github.com/u236/homed-service-zigbee/blob/master/reporting.cpp Отчеты]
	* [https://github.com/u236/homed-service-zigbee/blob/master/poll.cpp Опросы]		* [https://github.com/u236/homed-service-zigbee/blob/master/poll.cpp Опросы]
	* [[Common/Exposes\|~~Возможности~~]]		* [[Common/Exposes\|Способности]]
	* [[Common/Options\|Опции]]		* [[Common/Options\|Опции]]

Voznemozhno в 08:45, 5 сентября 2024

2024-09-05T08:45:47Z

← Предыдущая версия		Версия от 08:45, 5 сентября 2024
Строка 92:		Строка 92:

	=== <code>exposes</code> ===		=== <code>exposes</code> ===
	Массив [https://github.com/u236/homed-service-common/blob/master/expose.cpp интеграций] конечной точки устройства. Интеграции - это абстрактные сущности, на которых основана работа функции [~~https:~~/~~/www.home-assistant.io/integrations/mqtt/#mqtt-discovery Home Assistant MQTT Discovery], а так же работа [[Web~~\|~~веб-интерфейса~~]]. Например, интеграция <code class="value">"temperature"</code> добавляет в ''Home Assistant'' датчик темературы, а <code class="value">"light"</code> добавляет лампочку.		Массив [[Common/Exposes\|возможностей]] устройства.

	=== <code>options</code> ===		=== <code>options</code> ===
	[~~https:~~/~~/github.com/search?q=repo%3Au236%2Fhomed-service-zigbee+language%3AC%2B%2B+option%28+OR+options%28&type=code Опции~~] позволяют задавать дополнительные настройки для других элементов библиотеки, например корректировать значения свойств.		Объект с [[Common/Options\|опциями]] устройства.

	=== <code>endpointId</code> ===		=== <code>endpointId</code> ===

Voznemozhno: /* Характеристики устройств */

2024-09-05T08:44:50Z

Характеристики устройств

← Предыдущая версия		Версия от 08:44, 5 сентября 2024
Строка 11:		Строка 11:
	* [https://github.com/u236/homed-service-zigbee/blob/master/reporting.cpp Отчеты]		* [https://github.com/u236/homed-service-zigbee/blob/master/reporting.cpp Отчеты]
	* [https://github.com/u236/homed-service-zigbee/blob/master/poll.cpp Опросы]		* [https://github.com/u236/homed-service-zigbee/blob/master/poll.cpp Опросы]
	* [~~https:~~/~~/github.com/u236/homed-service-common/blob/master/expose.cpp Интеграции~~]		* [[Common/Exposes\|Возможности]]
	* [~~https:/~~/~~github.com/search?q=repo%3Au236%2Fhomed-service-zigbee+language%3AC%2B%2B+option%28+OR+options%28&type=code~~ Опции]		* [[Common/Options\|Опции]]

	== Структура библиотеки ==		== Структура библиотеки ==

Voznemozhno: /* Расширения библиотеки */

2024-03-19T13:51:00Z

Расширения библиотеки

← Предыдущая версия		Версия от 13:51, 19 марта 2024
Строка 141:		Строка 141:

	[[Category:ZigBee]]		[[Category:ZigBee]]
	~~[[Category:Незавершенные статьи]]~~

Voznemozhno: /* polls */

2024-03-19T10:52:37Z

polls

Новая страница

{{DISPLAYTITLE:ZigBee: Библиотека устройств}}
{{Breadcrumbs|[[ZigBee]] > Библиотека устройств}}

== Файлы библиотеки ==
Все поддерживаемые устройства описаны в файлах библиотеки, находящихся в папке <code>/usr/share/homed-zigbee</code>. Путь к папке библиотеки может быть изменен в [[ZigBee/Configuration|конфигурации]]. Библиотека может быть дополнена при помощи пользовательских [[#Расширения библиотеки|расширений]].

== Характеристики устройств ==
* [https://github.com/u236/homed-service-zigbee/blob/master/property.cpp Свойства]
* [https://github.com/u236/homed-service-zigbee/blob/master/action.cpp Действия]
* [https://github.com/u236/homed-service-zigbee/blob/master/binding.cpp Биндинги]
* [https://github.com/u236/homed-service-zigbee/blob/master/reporting.cpp Отчеты]
* [https://github.com/u236/homed-service-zigbee/blob/master/poll.cpp Опросы]
* [https://github.com/u236/homed-service-common/blob/master/expose.cpp Интеграции]
* [https://github.com/search?q=repo%3Au236%2Fhomed-service-zigbee+language%3AC%2B%2B+option%28+OR+options%28&type=code Опции]

== Структура библиотеки ==
Каждый файл библиотеки представляет из себя JSON-объект, описывающий характеристики конечных точек каждого поддерживаемого устройства. Актуальные файлы библиотеки доступны на [https://github.com/u236/homed-service-zigbee/blob/master/deploy/data/usr/share/homed-zigbee GitHub]. Устройства идентифицируются по аттрибутам ''"ManufacturerName"'' и ''"ModelIdentifier"'' [[Media:ZigBee Cluster Library Specification.pdf|кластера]] ''"Basic"''.

{{Warning|Существуют исключения из правил, такие, как устройства TUYA, у которых всегда ''относительно'' одинаковое значение аттрибута ''"ModelIdentifier"'', зато аттрибут ''"ManufacturerName"'' всегда разный. Для этих устройств название производителя подменяется на "TUYA", а в качестве названия модели используется значение аттрибута ''"ManufacturerName"''.}}

Общая структура библиотеки выглядит так:
<syntaxhighlight lang="json">
{
"manufacturer_a":
[
{
"modelNames": ["model_m", "model_n"],
"properties": ["property", "property", "property"],
"actions": ["action", "action"],
"bindings": ["binding"],
"reportings": ["reporting"],
"exposes": ["expose", "expose"],
"endpointId": 2
},
{
"modelNames": ["model_x"],
"properties": ["property"],
"actions": ["action"],
"exposes": ["expose"],
"options": {"option": "value"}
}
],
"manufacturer_b":
[
{
"modelNames": ["model_z"],
"properties": ["property", "property"],
"bindings": ["binding"],
"polls": ["poll"],
"options": {"pollInterval": 3600}
}
]
}
</syntaxhighlight>

== Поля и значения ==

=== <code>description</code> ===
Необязательное поле, имеющее исключительно информационный характер, используется для "человекопригодного" описания секции библиотеки.

=== <code>modelNames</code> ===
Массив значений аттрибута ''"ModelIdentifier"'' для устройств с одинаковым набором характеристик. Допускается использовать повторяющиеся значения этого поля в одном блоке производителя устройств, например:
<syntaxhighlight lang="json">
...
{
"modelNames": ["model_a", "model_b"],
"properties": ["status", "level"],
"actions": ["status", "level"]
},
{
"modelNames": ["model_a"],
"properties": ["colorTemperature"],
"actions": ["colorTemperature"]
}
...
</syntaxhighlight>

=== <code>properties</code> ===
Массив [https://github.com/u236/homed-service-zigbee/blob/master/property.cpp свойств] конечной точки устройства. К свойствам относятся данные о состоянии устройства, например, температура, заряд батарейки, сигнал срабатывания датчика движения и так далее.

=== <code>actions</code> ===
Массив [https://github.com/u236/homed-service-zigbee/blob/master/action.cpp действий], которые могут быть применены к конечной точке устройства. К действиям относится то, как пользователь может управлять устройством, например, включать или выключать, изменять настройки и так далее.

=== <code>bindings</code> ===
Массив [https://github.com/u236/homed-service-zigbee/blob/master/binding.cpp биндингов] для конечной точки устройства. Дело в том, что далеко не все устройства после подключения к сети начинают отправлять отчеты координатору. Эту проблему решают биндинги, назначая адресом для отправки отчетов адрес координатора.

=== <code>reportings</code> ===
Массив предустановленных параметров отправки [https://github.com/u236/homed-service-zigbee/blob/master/reporting.cpp отчетов] конечной точки устройства. Отчеты - это функция устройства, с помощью которой оно периодически передает координатору некоторые свои свойства. Отчеты отправляются по заданным критериям - временным интервалам и изменению значения соответствующего аттрибута. Параметры отчетов хранятся на самом устройстве и настраиваются при [[ZigBee/Topics#setPermitJoin|добавлении]] устройства в сеть, при [[ZigBee/Topics#updateDevice|обновлении]] характеристик устройства или [[ZigBee/Topics#updateReporting|вручную]].

=== <code>polls</code> ===
Массив [https://github.com/u236/homed-service-zigbee/blob/master/poll.cpp опросов] конечной точки устройства. Опросы - это способ принудительно получить некоторые свойства устройств, не поддерживающих отчеты. В этом случае координатор сам обращается к устройству, либо один раз, при запуске сервиса, либо раз в заданный промежуток времени.

=== <code>exposes</code> ===
Массив [https://github.com/u236/homed-service-common/blob/master/expose.cpp интеграций] конечной точки устройства. Интеграции - это абстрактные сущности, на которых основана работа функции [https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery Home Assistant MQTT Discovery], а так же работа [[Web|веб-интерфейса]]. Например, интеграция <code class="value">"temperature"</code> добавляет в ''Home Assistant'' датчик темературы, а <code class="value">"light"</code> добавляет лампочку.

=== <code>options</code> ===
[https://github.com/search?q=repo%3Au236%2Fhomed-service-zigbee+language%3AC%2B%2B+option%28+OR+options%28&type=code Опции] позволяют задавать дополнительные настройки для других элементов библиотеки, например корректировать значения свойств.

=== <code>endpointId</code> ===
Хитрое поле, описывающее, к каким конечным точкам устройства применимы перечисленные характеристики. Если поле отсутствует, используятся конечнная точка по умолчанию, то есть <code>1</code>. Допускается перечисление нескольких конечных точек для одной и той же модели устройства:
<syntaxhighlight lang="json">
...
{
"modelNames": ["lumi.sensor_cube", "lumi.sensor_cube.aqgl01"],
"properties": ["lumiBatteryVoltage"],
"endpointId": 1
},
{
"modelNames": ["lumi.sensor_cube", "lumi.sensor_cube.aqgl01"],
"properties": ["lumiCubeMovement"],
"endpointId": 2
},
{
"modelNames": ["lumi.sensor_cube", "lumi.sensor_cube.aqgl01"],
"properties": ["lumiCubeRotation"],
"endpointId": 3
}
...
</syntaxhighlight>

Кроме того, поле может содержать не только одиночное значение номера конечной точки, но и массив значений. Это применимо к устройстам, имеющим несколько конечных точек c идентичным набором характеристик, таким, как многоканальные реле или выключатели. В таком случае, к топикам [[ZigBee/Topics#homed/fd/zigbee/00:12:4b:00:0e:24:da:ac|статусных сообщений]], содержащих перечисленные свойства, будет добавляться еще один уровень, содержащий в себе номер конкретной конечной точки.

Например:
<syntaxhighlight lang="json">
...
{
"modelNames": ["multi_channel"],
"properties": ["status"],
"actions": ["status"],
"endpointId": [1, 2, 3]
}
...
</syntaxhighlight>

== Расширения библиотеки ==
Поддержку новых устройств можно добавлять при помощи пользовательских расширений библиотеки. Расширения это файлы с ''произвольным'' именем. Содержимое таких файлов должно соответствовать формату основной библиотеки, описанному в данной статье.

Эти файлы можно создавать в папке, путь к которой настраивается парамером <code>external</code> в секции <code>[device]</code> файла [[ZigBee/Configuration|конфигурации]].

{{Warning|Пользовательские расширения имеют приоритет над основной библиотекой, список файлов расширений сортируется по имени, парсер библиотеки прекращает поиск описания устройства, как только найдет первое совпадение.}}

[[Category:ZigBee]]
[[Category:Незавершенные статьи]]

ZigBee/Library - История изменений

Voznemozhno: /* exposes */

Voznemozhno: /* Характеристики устройств */

Voznemozhno в 08:45, 5 сентября 2024

Voznemozhno: /* Характеристики устройств */

Voznemozhno: /* Расширения библиотеки */

Voznemozhno: /* polls */