Черты

В API SDM трейт включает поля , команды и события .

Поля

Поля — это значения с распространёнными типами данных, такими как число или строка. Например, поле может содержать текущий режим работы или уровень влажности окружающей среды термостата Google Nest.

Характеристики и поля можно просмотреть с помощью GET запроса к нужной конечной точке API:

GET /enterprises/project-id/devices/device-id
{
  "name" : "enterprises/project-id/devices/device-id",
  "type" : "sdm.devices.types.device-type",
  "traits" : { ... },
  "parentRelations" : [
    {
      "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName" : "Lobby"
    }
  ]
}

Типы устройств

Возвращаемый API SDM sdm.devices.types. device-type не следует использовать для определения или вывода функциональности фактического устройства, к которому он назначен. Нет гарантии, что тип устройства останется стабильным для конкретного устройства по мере добавления новых функций в API SDM. Вместо этого используйте возвращаемые характеристики устройства.

родительские отношения

Объект parentRelations представляет собой родительский ресурс для текущего ресурса, будь то структура или комната. Отображаемое имя соответствует полю customName объекта parentRelations.Информационная характеристика для устройств со структурным родительским элементом илиХарактеристика RoomInfo для устройств с родительским помещением.

Команды

Команды — это запросы, связанные с определённой характеристикой. Например, изменение текущего режима или заданной температуры на термостате Google Nest.

Команда отправляется посредством вызова API executeCommand :

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "command-name",
  "params" : {
    "field" : "value"
  }
}

В большинстве случаев ответ на команду сводится к простому успеху или неудаче. Примеры использования конкретных команд см. в руководствах по отдельным характеристикам.

События

События происходят асинхронно и управляются системой Google Cloud Pub/Sub в рамках одной темы для каждого события. Project ИДЕНТИФИКАТОР.

События отправляются по умолчанию при любом изменении значения поля характеристики. Они также могут отправляться в ответ на конкретные действия устройства или изменения в назначении ресурсов. Дополнительную информацию см. в разделе «События» .

Категории признаков

Структура

Черты
Информация
sdm.structures.traits.Info
Эта особенность присуща любой структуре, содержащей информацию, связанную со структурой.
Информация о номере
sdm.structures.traits.RoomInfo
Эта функция присуща любому помещению и предназначена для отображения информации, относящейся к помещению.

Устройство

Черты
Подключение
sdm.devices.traits.Connectivity
Эта характеристика присуща любому устройству, обладающему информацией о подключении.
Вентилятор
sdm.devices.traits.Fan
Эта особенность присуща любому устройству, обладающему возможностью управления вентилятором.
Влажность
sdm.devices.traits.Humidity
Эта особенность присуща любому устройству, оснащенному датчиком для измерения влажности.
Информация
sdm.devices.traits.Info
Эта характеристика присуща любому устройству, предоставляющему информацию, связанную с устройством.
Настройки
sdm.devices.traits.Settings
Эта функция доступна для любого устройства и содержит информацию о настройках, связанных с устройством.
Температура
sdm.devices.traits.Temperature
Эта особенность присуща любому устройству, оснащенному датчиком для измерения температуры.

Термостат

Черты
ТермостатЭко
sdm.devices.traits.ThermostatEco
Эта особенность характерна для термостатов, поддерживающих режим ECO.
Термостат системы отопления, вентиляции и кондиционирования
sdm.devices.traits.ThermostatHvac
Эта характеристика присуща термостатам, способным передавать подробные сведения о системе отопления, вентиляции и кондиционирования воздуха (ОВК).
Режим термостата
sdm.devices.traits.ThermostatMode
Эта особенность характерна для типов термостатов, поддерживающих различные режимы работы.
ТермостатУстановленная температура
sdm.devices.traits.ThermostatTemperatureSetpoint
Эта функция характерна для термостатов, поддерживающих установку целевой температуры и температурного диапазона.

Камера

Черты
Предварительный просмотр клипа камеры
sdm.devices.traits.CameraClipPreview
Эта функция присуща любому устройству, поддерживающему загрузку предварительного просмотра видеоролика.
CameraEventImage
sdm.devices.traits.CameraEventImage
Эта особенность присуща любому устройству, поддерживающему генерацию изображений на основе событий.
CameraImage
sdm.devices.traits.CameraImage
Эта функция присуща любому устройству, поддерживающему фотосъемку.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
Эта функция присуща любому устройству, поддерживающему прямую трансляцию.
CameraMotion
sdm.devices.traits.CameraMotion
Эта функция присуща любому устройству, поддерживающему обнаружение движения.
Оператор
sdm.devices.traits.CameraPerson
Эта функция присуща любому устройству, поддерживающему события обнаружения людей.
CameraSound
sdm.devices.traits.CameraSound
Эта функция присуща любому устройству, поддерживающему события обнаружения звука.

Дверной звонок

Черты
Дверной звонок
sdm.devices.traits.DoorbellChime
Эта функция присуща любому устройству, поддерживающему дверной звонок и связанные с ним события нажатия кнопок.