API SDM — это REST API, предоставляющий различные методы для просмотра характеристик и выполнения команд, связанных с ними, для управления устройствами Google Nest. Используйте токен доступа, предоставленный в процессе авторизации, при каждом вызове API.
Черты
API SDM использует модель, основанную на характеристиках, для информации об устройстве и его функциональности. Ознакомьтесь с руководствами по каждому устройству, чтобы узнать, какие характеристики доступны для него:
- Камера
- Камера (аккумулятор)
- Камера с прожектором
- Камера (проводная)
- Отображать
- Дверной звонок
- Дверной звонок (батарейный)
- Дверной звонок (проводной)
- Термостат
Методы
Полную информацию обо всех методах, доступных для API SDM, см. в Справочнике API .
выполнитьКоманду
Выполняет команду авторизованному устройству.
Используйте POST
-вызов для выполнения команды. Например, чтобы изменить режим термостата:
POST /enterprises/project-id/devices/device-id:executeCommand { "command" : "sdm.devices.commands.ThermostatMode.SetMode", "params" : { "mode" : "HEAT" } }
Дополнительные примеры команд можно найти на странице со справочной информацией по каждому отдельному трейту. Подробнее см. в полном списке трейтов .
получать
Получает информацию об авторизованной структуре или устройстве.
Вызов GET
возвращает один ответ с текущими полями и значениями для всех характеристик, доступных для структуры или устройства, которые user имеет авторизованный и объект `parentRelations', который представляет родительский ресурс текущего ресурса, будь то структура или комната.
Например, термостат Nest может вернуть следующее:
GET /enterprises/project-id/devices/device-id { "name" : "enterprises/project-id/devices/device-id", "type" : "sdm.devices.types.THERMOSTAT", "assignee" : "enterprises/project-id/structures/structure-id/rooms/room-id", "traits" : { "sdm.devices.traits.Connectivity" : { "status" : "ONLINE" }, "sdm.devices.traits.Fan" : { "timerMode" : "ON", "timerTimeout" : "2019-05-10T03:22:54Z" }, "sdm.devices.traits.Humidity" : { "ambientHumidityPercent" : 35.0 }, "sdm.devices.traits.Info" : { "customName" : "My device" }, "sdm.devices.traits.Settings" : { "temperatureScale" : "CELSIUS" }, "sdm.devices.traits.Temperature" : { "ambientTemperatureCelsius" : 23.0 }, "sdm.devices.traits.ThermostatEco" : { "availableModes" : ["MANUAL_ECO", "OFF"], "mode" : "MANUAL_ECO", "heatCelsius" : 20.0, "coolCelsius" : 22.0 }, "sdm.devices.traits.ThermostatHvac" : { "status" : "HEATING" }, "sdm.devices.traits.ThermostatMode" : { "availableModes" : ["HEAT", "COOL", "HEATCOOL", "OFF"], "mode" : "COOL" }, "sdm.devices.traits.ThermostatTemperatureSetpoint" : { "heatCelsius" : 20.0, "coolCelsius" : 22.0 } }, "parentRelations" : [ { "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id", "displayName" : "Lobby" } ] }
список
Перечисляет разрешенные конструкции, помещения или устройства.
Чтобы составить список всех структур, помещений или устройств, авторизованных с помощью одного токена доступа, выполните вызов GET
к соответствующей конечной точке ресурса:
GET /enterprises/project-id/structures
GET /enterprises/project-id/structures/structure-id/rooms
GET /enterprises/project-id/devices
Интеграция с Google Ассистентом
После авторизации устройства в SDM Google получает информацию об устройстве в Home Graph и напрямую управляет его состоянием. Если в вашем коммерческом предложении включена интеграция с Google Ассистентом:
- Не отправлять запросы Request Sync для устройств SDM
- Исключить устройства SDM из любых ответов на намерение SYNC
Ошибки
Полный список кодов ошибок API см. в Справочнике кодов ошибок API.