Common/Options: различия между версиями

Материал из HOMEd Wiki
 
(не показано 8 промежуточных версий этого же участника)
Строка 3: Строка 3:


== Общие сведения ==
== Общие сведения ==
Опции устройств это дополнительные настройки, позволяющие управлять поведением устройств и их [[Common/Exposes|возможностями]]. Примеры использования различных опций в коде HOMEd можно посмотреть [https://github.com/search?q=user%3Au236+language%3AC%2B%2B+option%28+OR+options%28&type=code здесь].
Опции устройств это дополнительные настройки, позволяющие управлять поведением устройств и их [[Common/Exposes|способностями]]. Примеры использования различных опций в коде HOMEd можно посмотреть [https://github.com/search?q=user%3Au236+language%3AC%2B%2B+option%28+OR+options%28&type=code здесь].


== Опции возможностей (exposes) ==
== Опции способностей (exposes) ==
Опции для большинства часто-используемых возможностей описаны в файле <code>/usr/share/homed-common/expose.json</code>. Это сделано для того, чтобы не дублировать одни и те же опции для каждогого типового случая описания таких возможностей, как температура, влажность, напряжение, сила тока и так далее.
Опции для большинства часто используемых [[Common/Exposes|способностей]] описаны в файле <code>/usr/share/homed-common/expose.json</code>. Это сделано для того, чтобы не дублировать одни и те же опции для каждого типового случая описания таких способностей, как температура, влажность, напряжение, сила тока и так далее. Актуальная версия файла всегда доступна на [https://github.com/u236/homed-service-common/blob/master/deploy/data/usr/share/homed-common/expose.json GitHub].


Опции указанные непосредственно в описании устройств имеют приоритет над опциями из файла <code>expose.json</code> и позволяют переопределять необходимые параметры, например, единицы измерения.
Опции указанные непосредственно в описании устройств имеют приоритет над опциями из файла <code>expose.json</code> и позволяют переопределять необходимые параметры, например, единицы измерения.


Опции для каждой возможности это вложенный JSON-объект, имя которого должно полностью совпадать с именем возможности (expose), например:
Набор опций для каждой способности это вложенный JSON-объект, имя которого должно ''полностью'' совпадать с именем способности, например:


<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
Строка 25: Строка 25:
</syntaxhighlight>
</syntaxhighlight>


Приведенный выше пример показывает вариант переопределение опций из файла <code>expose.json</code> для возможности <code>pressure</code>. Исходные опции:
Приведенный выше пример демонстрирует способ переопределения опции <code>unit</code> для способности <code>pressure</code>. Исходные опции:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{
Строка 36: Строка 36:
</syntaxhighlight>
</syntaxhighlight>


Итоговое описание возможности:
Итоговое описание способности:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{

Текущая версия от 12:31, 5 сентября 2024

HOMEd > Опции устройств

Общие сведения

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

Опции способностей (exposes)

Опции для большинства часто используемых способностей описаны в файле /usr/share/homed-common/expose.json. Это сделано для того, чтобы не дублировать одни и те же опции для каждого типового случая описания таких способностей, как температура, влажность, напряжение, сила тока и так далее. Актуальная версия файла всегда доступна на GitHub.

Опции указанные непосредственно в описании устройств имеют приоритет над опциями из файла expose.json и позволяют переопределять необходимые параметры, например, единицы измерения.

Набор опций для каждой способности это вложенный JSON-объект, имя которого должно полностью совпадать с именем способности, например:

{
  ...
  "exposes": ["pressure", "temperature", "myCustomExpose"],
  "options":
  {
    "pressure": {"unit": "mmHg"},
    "myCustomExpose": {"type": "sensor", "other": "option"}
  }
  ...
}

Приведенный выше пример демонстрирует способ переопределения опции unit для способности pressure. Исходные опции:

{
  "type": "sensor",
  "class": "pressure",
  "state": "measurement",
  "unit": "kPa",
  "round": 1
}

Итоговое описание способности:

{
  "type": "sensor",
  "class": "pressure",
  "state": "measurement",
  "unit": "mmHg",
  "round": 1
}