Черты

Черта в 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"
    }
  ]
}

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

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

parentRelations

Объект parentRelations представляет родительский ресурс текущего ресурса, будь то здание или комната. Отображаемое имя соответствует полю customName объектаИнформационная черта для устройств с родительской структурой илиЧерта 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
Эта черта присуща любой структуре для структурно-связанной информации.
RoomInfo
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
Данная характеристика свойственна типам устройств ТЕРМОСТАТ, поддерживающим ЭКО-режимы.
ТермостатHVAC
sdm.devices.traits.ThermostatHvac
Эта характеристика относится к типу устройств ТЕРМОСТАТ, которые могут предоставлять данные о системах отопления, вентиляции и кондиционирования воздуха.
Режим термостата
sdm.devices.traits.ThermostatMode
Эта характеристика свойственна типам устройств ТЕРМОСТАТ, которые поддерживают различные режимы термостата.
Заданная температура термостата
sdm.devices.traits.ThermostatTemperatureSetpoint
Эта характеристика относится к типу устройств ТЕРМОСТАТ, которые поддерживают установку целевой температуры и диапазона температур.

Камера

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

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

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