Smart Device Management API

SDM API 是一種 REST API，可以提供 查看特徵並執行特徵指令，即可管理 Google Nest 裝置。在每次 API 呼叫中使用授權程序中授予的存取權杖。

特徵

SDM API 使用以特徵為基礎的模型處理裝置資訊 新產品及功能請查看個別裝置指南，瞭解裝置可用的特徵：

方法

如需 SDM API 可用的所有方法的完整詳細資料，請參閱 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 助理整合 做為商業用途的一部分：

錯誤

請參閱 API 錯誤代碼參考資料： API 錯誤代碼的完整清單