錯誤和例外狀況

本文件列出官方支援的智慧住宅裝置錯誤和例外狀況。請在意圖回應或通知中使用這些指定的錯誤和例外狀況代碼 (如果您已實作此代碼)，這樣 Google 助理就能通知使用者特定指令或裝置狀態相關問題。如果回應包含不正確的格式或 errorCode，Google 助理會為使用者提供一般錯誤訊息，例如「很抱歉，目前尚無法使用 device」。

錯誤

如果問題導致執行或查詢要求失敗，您應傳回錯誤代碼。舉例來說，如果門鎖卡住，無法鎖定或解鎖，則應向使用者傳回有關這個狀態的錯誤訊息。

您可以將錯誤代碼附加至裝置層級或全域層級。舉例來說，如果使用者有多個來自某個供應商的燈具，且這些燈具是由一個供應商控制，當使用者要求關掉所有燈具時，供應器可能會在單燈離線時傳回裝置層級錯誤；如果整個中樞裝置離線且無法控制任何燈具，則可能會傳回全域層級錯誤。如果所有裝置都處於離線狀態，使用全域層級或裝置層級錯誤並無差異。在裝置離線時，即使傳回 deviceOffline 錯誤代碼，仍應在 reportState 中回報 {"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"
      }
    }
  }
}

執行回應

下列 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。

例外狀況

當指令發生問題或快訊時，您應傳回例外狀況。指令可能會成功或失敗。

如果指令執行成功 (status = "SUCCESS")，請使用 StatusReport 特徵 (針對目標以外的裝置) 回報例外狀況，或傳回適當的 exceptionCode (適用於目標裝置)。

舉例來說，如果烘衣機 Lint 畫面滿格，使用者仍可啟動烘衣機，但您可能需要警告使用者此狀態。同樣地，如果裝置的電量較低，且使用的電量偏低，您還是可以執行指令，但應告知對方裝置電量過低。

如果指令因例外狀況而失敗，狀態應為「EXCEPTIONS」，且應使用 StatusReport 特徵回報例外狀況。

符合目標裝置的非封鎖例外狀況 (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)

以下示範如何啟動保全系統：Ok，正在啟動保全系統。前窗打開了。

{
  "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。