Smart Device Management API

SDM API 是一種 REST API,可提供各種方法來查看特徵,並執行 Google Nest 裝置管理專用的特徵指令。請搭配每項 API 呼叫,使用授權程序期間授予的存取權杖。

性狀

SDM API 會使用以特徵為基礎的裝置資訊和功能。請查看個別裝置指南,瞭解裝置適用的 traits:

方法

如需 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 就會知道該裝置在 Home Graph 中,並直接管理裝置狀態。如果您的商業產品中包含 Google 助理

錯誤

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