action.devices.EXECUTE

此 intent 会发送命令,以便在智能家居设备上执行。

你的执行方式应处理每条命令,将其传输到相应的设备,并在 EXECUTE 响应中返回新状态。

单个 EXECUTE intent 可以使用多个命令定位多个设备。例如,一个被触发的 intent 可能会为一组灯设置亮度和颜色,也可能将多个灯设置为不同的颜色。

如需了解详情,请参阅查询和执行

请求格式

字段 类型 说明
requestId String

必填。

请求的 ID。

inputs 数组

必填。

与 intent 请求匹配的输入列表。

[item, ...] 对象

与 intent 请求相关联的类型和载荷。

intent

必填。

(常量值:"action.devices.EXECUTE"

intent 请求类型。

payload 对象

必填。

EXECUTE 请求载荷。

commands 数组

必填。

设备目标和命令对的列表。

[item, ...] 对象

针对连接的设备目标执行的命令集。

devices 数组

必填。

目标设备列表。

[item, ...] 对象

要执行的设备目标。

id String

必填。

设备 ID,与 SYNC 中提供的 ID 一致。

customData 对象

如果在 SYNC 中提供不透明 customData 对象,则会将其发送到此处。

execution 数组

必填。

要在目标设备上执行的命令列表。

[item, ...] 对象

设备命令。

command String

必填。

要执行的命令,通常附带参数。

params 对象

与每个命令的参数一致。

示例

执行 intent 请求

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123",
                "customData": {
                  "fooValue": 74,
                  "barValue": true,
                  "bazValue": "sheepdip"
                }
              },
              {
                "id": "456",
                "customData": {
                  "fooValue": 36,
                  "barValue": false,
                  "bazValue": "moarsheep"
                }
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OnOff",
                "params": {
                  "on": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

响应格式

字段 类型 说明
requestId String

必填。

相应请求的 ID。

payload 对象

必填。

intent 响应载荷。

errorCode String

身份验证失败和开发者系统不可用的整个事务的错误代码。对于个别设备错误,请在设备对象中使用 errorCode。

debugString String

详细的错误信息,不会向用户显示,但在开发过程中可能会被记录或使用。

commands 数组

每个对象包含一个或多个具有响应详细信息的设备。注意:这些分组可能与请求中的分组方式不同。例如,该请求可能会打开 7 盏灯(其中 3 盏灯成功,4 盏灯失败),因此响应中包含两个组。

[item, ...] 对象

设备执行结果。

ids 数组

必填。

与此状态对应的设备 ID 列表。

[item, ...] String

设备 ID。

status String

必填。

执行操作的结果。

支持的值:

SUCCESS
确认命令成功。
PENDING
命令已加入队列,但预计会成功。
OFFLINE
目标设备处于离线状态或无法访问。
EXCEPTIONS
与命令有关的问题或提醒。该命令可能会成功或失败。当您想发送其他已连接设备的其他信息时,通常会设置此状态类型。
ERROR
目标设备无法执行该命令。
states 对象

与每个特征架构参考中所述的每个特征的状态一致。这些是执行后的状态(如果有)。

online Boolean

指示设备是否在线(即可连接)。

errorCode String

根据预设的错误代码扩展 ERROR 状态,此代码将映射到向用户显示的错误。

示例

执行 intent 响应

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "on": true,
          "online": true
        }
      },
      {
        "ids": [
          "456"
        ],
        "status": "ERROR",
        "errorCode": "deviceTurnedOff"
      }
    ]
  }
}