Smart Device Management API

SDM API 是一个 REST API,可提供用于查看特征和执行特征命令以管理 Google Nest 设备的各种方法。使用在授权过程中授予的每次 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 Graph 中获知相应设备,并直接管理其状态。如果您在商业服务中集成了 Google 助理:

错误

如需查看 API 错误代码的完整列表,请参阅 API 错误代码参考