错误和异常

本文档列出了智能家居设备的官方支持错误和异常。请在 intent 响应中或通知（如果您已实现）中使用这些给定错误和异常代码，以便 Google 助理提醒最终用户与给定命令或设备状态相关的问题。如果响应包含格式错误或 errorCode，Google 助理会向用户显示通用错误消息，例如“抱歉，设备目前不可用”。

错误

如果问题导致执行或查询请求失败，您应返回错误代码。例如，如果门锁卡住了，无法锁定或解锁，则应向用户返回与此状态相关的错误。

错误代码可在设备级或全局级附加。 例如，如果用户有来自同一提供商的多个灯具，并且这些灯具由一个集线器控制，那么当用户要求关闭所有灯具时，如果单个灯具处于离线状态，提供商可能会返回设备级错误；如果整个集线器处于离线状态且无法控制任何灯具，则提供商可能会返回全局级错误。如果所有设备都处于离线状态，则使用全局级错误或设备级错误没有区别。

当设备处于离线状态时，您应在设备出现相应行为后的 5 分钟内向报告状态报告 {"online": false}。

总结：

• 全局级错误：响应中的所有设备都存在相同的错误
• 本地级错误：混合响应，包含错误和成功情况

全局级错误

以下 JSON 代码段展示了如何在 QUERY 或 EXECUTE 响应中返回全局级错误。

由于集线器处于离线状态而导致全局级错误 deviceOffline 的示例：

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "errorCode": "deviceOffline",
    "status" : "ERROR"
  }
}

由于集线器正在更新而导致全局级错误 inSoftwareUpdate 的示例：

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "errorCode": "inSoftwareUpdate",
    "status" : "ERROR"
  }
}

设备级错误

QUERY 响应

以下 JSON 代码段展示了如何在 QUERY 响应中返回设备级错误。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "devices": {
      "device-id-1": {
        "errorCode": "deviceOffline",
        "status" : "ERROR"
      },
      "device-id-2": {
        "errorCode": "deviceOffline",
        "status" : "ERROR"
      }
    }
  }
}

EXECUTE 响应

以下 JSON 代码段展示了如何在 EXECUTE 响应中返回设备级错误。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "device-id-1"
        ],
        "status": "ERROR",
        "errorCode": "deviceOffline"
      },
      {
        "ids": [
          "device-id-2"
        ],
        "status": "SUCCESS",
        "states": {
          "on": true,
          "online": true
        }
      }
    ]
  }
}

包含错误的通知

主动通知

以下 JSON 代码段展示了如何在预先通知中报告设备级错误。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "agentUserId": "agent-user-id-1",
  "eventId": "unique-event-id-1",
  "payload": {
    "devices": {
      "notifications": {
        "device-id-1": {
          "RunCycle": {
            "priority": 0,
            "status": "FAILURE",
            "errorCode": "deviceDoorOpen"
          }
        }
      }
    }
  }
}

后续回复

以下 JSON 代码段展示了如何在后续响应中报告设备级错误。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "agentUserId": "agent-user-id-1",
  "eventId": "unique-event-id-1",
  "payload": {
    "devices": {
      "notifications": {
        "device-id-1": {
          "LockUnlock": {
            "priority": 0,
            "followUpResponse": {
              "status": "FAILURE",
              "errorCode": "deviceJammingDetected",
              "followUpToken": "PLACEHOLDER"
            }
          }
        }
      }
    }
  }
}

错误列表

以下错误会在设备上生成关联的 TTS。

异常

如果与命令相关联的问题或提醒，您应返回异常。该命令可能会成功或失败。

如果命令成功（状态 =“SUCCESS”），请使用 StatusReport trait（对于目标设备以外的设备）或通过返回适当的 exceptionCode（对于目标设备）报告异常。

例如，如果烘干机 lint 过滤器已满，用户仍然可以启动烘干机，但您可能需要提醒他们注意这种状态。同样，当设备电量不足但未耗尽时，您仍然可以执行命令，但应告知用户设备电量不足。

如果命令因异常而失败，状态应为“EXCEPTIONS”，并且应使用 StatusReport trait 报告异常。

与目标设备相关的非阻塞异常 (SUCCESS)

以下示例用于锁门：

前门锁的电池电量偏低。正在锁上前门。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [{
      "ids": ["device-id-1"],
      "status": "SUCCESS",
      "states": {
        "on": true,
        "online": true,
        "isLocked": true,
        "isJammed": false,
        "exceptionCode": "lowBattery"
      }
    }]
  }
}

使用 StatusReport 的另一部设备的非阻塞异常 (SUCCESS)

以下示例展示了如何开启安防系统报警器：好的，正在开启安防系统报警器。前窗是开着的。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [{
      "ids": ["device-id-1"],
      "status": "SUCCESS",
      "states": {
        "on": true,
        "online": true,
        "isArmed": true,
        "currentArmLevel": "L2",
        "currentStatusReport": [{
          "blocking": false,
          "deviceTarget": "sensor_id1",
          "priority": 0,
          "statusCode": "deviceOpen"
        }]
      }
    }]
  }
}

使用 StatusReport 阻止有关其他设备的异常

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "devices": {
      "device-id-1": {
        "on": true,
        "online": true,
        "status": "EXCEPTIONS",
        "currentStatusReport": [{
            "blocking": true,
            "deviceTarget": "device-id-1",
            "priority": 0,
            "statusCode": "lowBattery"
          },
          {
            "blocking": true,
            "deviceTarget": "front_window_id",
            "priority": 1,
            "statusCode": "deviceOpen"
          },
          {
            "blocking": true,
            "deviceTarget": "back_window_id",
            "priority": 1,
            "statusCode": "deviceOpen"
          }
        ]
      }
    }
  }
}

例外列表

以下异常将在设备上生成关联的 TTS。