SDM API 是一種 REST API,可透過多種方式查看 Google 裝置,並運用該指令進行管理。針對每個 API 呼叫,請使用在授權程序期間授予的存取權杖。
性狀
SDM API 會使用地面式模型來提供裝置資訊和功能。請查看個別裝置指南,瞭解裝置有哪些特質:
方法
如需 SDM API 所有可用方法的完整詳細資訊,請參閱 API 參考資料。
執行指令
對授權裝置執行指令。
使用 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 就會透過 Home 圖表得知該裝置,並直接管理裝置狀態。如果您已將 Google 助理整合功能整合至商業產品方案:
- 請勿傳送 SDM 裝置的「要求同步處理要求」
- 將 SDM 裝置的任何回應從同步處理意圖中移除
錯誤
如需 API 錯誤代碼的完整清單,請參閱 API 錯誤代碼參考資料。