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

Текущая версия от 16:22, 16 октября 2024

HOMEd > Custom > База данных

Файл базы данных

База данных это файл, в котором хранится описание устройств. По умолчанию это /opt/homed-custom/database.json. Путь к файлу базы данных может быть изменен в конфигурации. Не обязательно редактировать базу данных автоматизаций вручную, намного проще настраивать устройства через веб-интерфейс.

Структура базы данных

База данных HOMEd Сustom это JSON-объект. Общая структура базы данных выглядит так:

{
  "devices":
  [
    {
      "active": true,
      "id": "myCustomDevice1",
      "name": "My Custom Device",
      "real": false,
      "cloud": true,
      "discovery": true,
      "exposes":
      [
        ...
      ],
      "options":
      {
        ...
      }
    },
    {
      "active": true,
      "id": "myCustomDevice2",
      "name": "Other Custom Device",
      "real": true,
      "cloud": true,
      "discovery": true,
      "exposes":
      [
        ...
      ]
    }
  ]
}

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

`active`

Включение/выключение устройства.

`id`

Уникальный идентификатор устройства.

`name`

Уникальное читаемое имя устройства.

`real`

Если значение этого поля установлено как false, устройство будет считаться виртуальным и данные из топика homed/td/custom/... будут автоматически дублироваться в топик homed/fd/custom/..., в противном случае сервис будет ожидать данных от реального устройства или другого сервиса. Подробнее о топиках можно почитать здесь.

`cloud`

Включение/выключение проброса устройств в Умный Дом Яндкса при помощи HOMEd Cloud.

`discovery`

Включение/выключение функуии Home Assistant MQTT Discovery для устройства.

`exposes`

Массив способностей устройства.

`options`

Объект с опциями устройства.

@@ Строка 1: / Строка 1: @@
 {{DISPLAYTITLE:Custom: База данных}}
 {{Breadcrumbs|[[Custom]] > База данных}}
 == Файл базы данных ==
-База данных это файл, в котором хранится описание устройств, по умолчанию это <code>/opt/homed-custom/database.json</code>. Путь к файлу базы данных может быть изменен в [[Custom/Configuration|конфигурации]]. Не обязательно редактировать базу данных автоматизаций вручную, намного проще настраивать устройства через [[Web|веб-интерфейс]].
+База данных это файл, в котором хранится описание устройств. По умолчанию это <code>/opt/homed-custom/database.json</code>. Путь к файлу базы данных может быть изменен в [[Custom/Configuration|конфигурации]]. Не обязательно редактировать базу данных автоматизаций вручную, намного проще настраивать устройства через [[Web|веб-интерфейс]].
 == Структура базы данных ==
-База данных {{Service|Automation}} это JSON-объект. Общая структура базы данных выглядит так:
+База данных {{Service|Сustom}} это JSON-объект. Общая структура базы данных выглядит так:
 <syntaxhighlight lang="json">
 {
-   "automations":
+   "devices":
    [
      {
        "active": true,
-       "name": "my automation 1",
+      "id": "myCustomDevice1",
-       "triggers":
+       "name": "My Custom Device",
-       [
+       "real": false,
-        ...
+       "cloud": true,
-       ],
+       "discovery": true,
-       "conditions":
+       "exposes":
        [
          ...
        ],
-       "actions":
+       "options":
-       [
+       {
          ...
-       ]
+       }
      },
      {
        "active": true,
-       "name": "my automation 2",
+       "id": "myCustomDevice2",
-       "debounce": 10,
+       "name": "Other Custom Device",
-       "restart": true,
+       "real": true,
-       "triggers":
+       "cloud": true,
-       [
+       "discovery": true,
-        ...
+       "exposes":
-      ],
-       "actions":
        [
          ...
        ]
      }
-   ],
+   ]
-  "states":
-  {
-    ...
-  }
 }
 </syntaxhighlight>
-== Параметры автоматизаций ==
+== Параметры устройств ==
 === <code>active</code> ===
-Включение/выключение автоматизации.
+Включение/выключение устройства.
+=== <code>id</code> ===
+Уникальный идентификатор устройства.
 === <code>name</code> ===
-Название автоматизации, чтобы было проще отличать автоматизации друг от друга.
+Уникальное читаемое имя устройства.
-=== <code>debounce</code> ===
-Минимальный допустимый интервал между срабатываниями автоматизации в секундах.
-=== <code>restart</code> ===
-В случае, когда автоматизация содержит действия [[Automation/Database/Actions#Действие "delay"|задержки]] выполения, автоматизация будет "перезапущена", если значение этого поля установлено как <code class="value">true</code>. В противном случае повторное срабатывание триггеров будет проигнорировано до истечения времени задержки.
-=== <code>triggers</code> ===
-Массив [[Automation/Database/Triggers|триггеров]] автоматизации. Триггеры это события, которые вызывают срабатывание автоматизации, такие как изменение состояния устройства или выход какого-то параметра за заданный предел.
-=== <code>conditions</code> ===
-Массив [[Automation/Database/Conditions|условий]] автоматизации. Автоматизация сработает только в случае, если заданные условия выполнены. Данное поле не является обязательным.
-=== <code>actions</code> ===
+=== <code>real</code> ===
-Массив [[Automation/Database/Actions|действий]] автоматизации. Действия это итоговый результат автоматизации, например, действие может изменить состояние устройства или отправить сообщение в Telegram.
+Если значение этого поля установлено как <code class="value">false</code>, устройство будет считаться виртуальным и данные из топика <code class="value">homed/td/custom/...</code> будут автоматически дублироваться в топик <code class="value">homed/fd/custom/...</code>, в противном случае сервис будет ожидать данных от реального устройства или другого сервиса. Подробнее о топиках можно почитать [[Custom/Topics|здесь]].
-== Состояния ==
+=== <code>cloud</code> ===
-Состояния это способ обмена данными между автоматизациями. У каждого состояния есть название. Состояния могут быть установлены или удалены соответсующими [[Automation/Database/Actions#Действие "state"|действиями]] и могут использоваться в [[Automation/Database/Conditions#Условие "state"|условиях]]. В базе данных состояния сохраняются во вложенном объекте <code>"states"</code>:
+Включение/выключение проброса устройств в [https://alice.yandex.ru/smart-home Умный Дом Яндкса] при помощи [[Cloud|HOMEd Cloud]].
-<syntaxhighlight lang="json">
-{
-  "states":
-  {
-    "windowIsOpen": true,
-    "mySpecialState": "hello",
-    "numericData": 24.2,
-    ...
-  }
-}
-</syntaxhighlight>
-== Примеры ==
+=== <code>discovery</code> ===
-<syntaxhighlight lang="json">
+Включение/выключение функуии [https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery Home Assistant MQTT Discovery] для устройства.
-{
-  "automations":
-  [
-    {
-      "active": true,
-      "name": "управление лампой на столе",
-      "triggers":
-      [
-        {
-          "type": "property",
-          "endpoint": "zigbee/freePad/1",
-          "property": "action",
-          "equals": "singleClick"
-        }
-      ],
-      "conditions":
-      [
-        {
-          "type": "property",
-          "endpoint": "zigbee/roomLight/2",
-          "property": "status",
-          "equals": "off"
-        }
-      ],
-      "actions":
-      [
-        {
-          "type": "property",
-          "endpoint": "zigbee/tableLight",
-          "property": "status",
-          "value": "toggle"
-        }
-      ]
-    },
-    {
+=== <code>exposes</code> ===
-      "active": true,
+Массив [[Common/Exposes|способностей]] устройства.
-      "name": "управление светом в комнате",
-      "triggers":
-      [
-        {
-          "type": "property",
-          "endpoint": "zigbee/freePad/2",
-          "property": "action",
-          "equals": "singleClick"
-        },
-        {
-          "type": "telegram",
-          "message": "включи свет в комнате"
-        }
-      ],
-      "actions":
-      [
-        {
-          "type": "property",
-          "endpoint": "zigbee/roomLight/2",
-          "property": "status",
-          "value": "on"
-        }
-      ]
-    },
-    {
+=== <code>options</code> ===
-      "active": true,
+Объект с [[Common/Options|опциями]] устройства.
-      "name": "уведомление о похолодании",
-      "triggers":
-      [
-        {
-          "type": "property",
-          "endpoint": "zigbee/outdoorTemperature",
-          "property": "temperature",
-          "below": 10
-        }
-      ],
-      "actions":
-      [
-        {
-          "type": "telegram",
-          "message": "на улице холодно"
-        }
-      ]
-    }
-  ]
-}
-</syntaxhighlight>
 [[Category:Custom]]