錯誤和例外狀況

這份文件會列出官方支援的智慧住宅裝置錯誤和例外狀況。請使用意圖回應中的這些指定錯誤和例外狀況代碼；如果您實作過這些通知，請在通知中使用 Google 助理，提醒使用者與特定指令或裝置狀態相關的問題。如果回應的格式不正確或 errorCode，Google 助理會為使用者提供一般錯誤訊息，例如「很抱歉，裝置目前不適用」。

錯誤

如果問題導致執行作業或查詢要求失敗，則應傳回錯誤代碼。例如，如果門鎖變成卡住且無法上鎖或解鎖，則應傳回這個狀態的相關錯誤。

錯誤代碼可附加至裝置層級或全域層級。舉例來說，如果使用者有一個來自特定供應商的燈，並由中樞控制，那麼當使用者要求關閉所有燈具時，供應商可能會傳回裝置層級錯誤；如果單一燈具處於離線狀態，且無法控制任何燈號，供應器就會傳回全域層級錯誤。如果所有裝置都處於離線狀態，則使用全域層級或裝置層級錯誤沒有差異。裝置處於離線狀態時，即使您傳回 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"
            }
          }
        }
      }
    }
  }
}

錯誤清單

下列錯誤將在裝置上產生相關聯的文字轉語音。

例外狀況

如果有與指令相關的問題或快訊，您應傳回例外狀況。指令執行成功或失敗。

如果指令成功 (狀態 =「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)

本範例是針對保全系統操作：好的，啟動保全系統。車窗打開了

{
  "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"
          }
        ]
      }
    }
  }
}

例外清單

以下例外狀況會導致裝置產生相關聯的文字轉語音。