Черты

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

Поля

Поля — это значения с общими типами данных, такими как число или строка. Например, поле может содержать текущий режим или влажность окружающей среды термостата 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 представляет родительский ресурс текущего ресурса: структуру или комнату. Отображаемое имя соответствует полю 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
Эта черта принадлежит любой структуре информации, связанной со структурой.
Информация о номере
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
Эта особенность относится к типам устройств ТЕРМОСТАТЫ, которые могут сообщать подробности HVAC.
Режим термостата
sdm.devices.traits.ThermostatMode
Эта особенность относится к типам устройств ТЕРМОСТАТ, поддерживающим различные режимы термостата.
ТермостатУставка температуры
sdm.devices.traits.ThermostatTemperatureSetpoint
Эта особенность относится к типам устройств ТЕРМОСТАТ, которые поддерживают установку целевой температуры и диапазона температур.

Камера

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

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

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