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

Материал из HOMEd Wiki
Строка 77: Строка 77:


=== <code>availabilityTopic</code> ===
=== <code>availabilityTopic</code> ===
Топик для определения доступности устройства. Если этот параметр отсутствует, устройство всегда будет считаться доступным.
Топик для определения доступности устройства. Если этот параметр отсутствует, устройство всегда будет считаться доступным. Актуально только для устройств с включенным параметром <code>real</code>.


=== <code>availabilityTopic</code> ===
=== <code>availabilityTopic</code> ===

Версия от 14:16, 17 февраля 2025

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":
      [
        ...
      ],
      "bindings":
      {
        ...
      }
    }
  ]
}

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

active

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

id

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

name

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

real

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

cloud

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

discovery

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

exposes

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

options

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

bindings

Объект с биндингами устройства.

availabilityTopic

Топик для определения доступности устройства. Если этот параметр отсутствует, устройство всегда будет считаться доступным. Актуально только для устройств с включенным параметром real.

availabilityTopic

Шаблон для определения доступности устройства. Шаблон должен возвращать строку "online" в случае, если устройство доступно, иначе устройство будет считаться недоступным. Подробнее о шаблонах здесь.