SDM API 是一種 REST API,可以提供 查看特徵並執行特徵指令,即可管理 Google Nest 裝置。使用 藉此取得每個 API 呼叫的授權程序。
特徵
SDM API 使用以特徵為基礎的模型處理裝置資訊 新產品及功能如要瞭解特性,請查看個別裝置指南 適用於裝置:
方法
如需完整的詳細資料,請參閱 API 參考資料 適用於 SDM API 的所有方法。
executeCommand
這個外掛程式能對授權裝置執行指令。
請使用 POST
呼叫執行指令。例如更換溫度控制器
模式:
POST /enterprises/project-id/devices/device-id:executeCommand { "command" : "sdm.devices.commands.ThermostatMode.SetMode", "params" : { "mode" : "HEAT" } }
如需更多指令範例,請參閱個別特徵參考資料 頁面。查看完整的特徵資訊 瞭解詳情
get
取得授權結構或裝置的相關資訊。
GET
呼叫會傳回單一回應,其中包含所有目前的欄位和值
適用於 user 的結構或裝置
以及經過授權的「parentRelations」物件,代表父項資源
目前資源的一部分,可以是結構或會議室
舉例來說,Nest Thermostat 可能會退回 包括:
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" } ] }
list
列出授權結構、房間或裝置。
列出透過單次存取授權的所有結構、房間或裝置
符記,對適當的資源端點發出 GET
呼叫:
GET /enterprises/project-id/structures
GET /enterprises/project-id/structures/structure-id/rooms
GET /enterprises/project-id/devices
整合 Google 助理
裝置獲得 SDM 授權後,Google 即可在住家中發現該裝置 直接繪製圖表並管理其狀態。如使用 Google 助理整合 做為商業用途的一部分:
- 不要傳送要求同步處理 對 SDM 裝置的要求
- 從任何回應中省略 SDM 裝置同步 意圖
錯誤
請參閱 API 錯誤代碼參考資料: API 錯誤代碼的完整清單