錯誤和例外狀況

本文件列出了智慧住宅裝置的官方支援錯誤和例外狀況。請在意圖回應中使用這些指定錯誤和例外狀況代碼；如果您導入了通知，即可使用這些錯誤，因此 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"
      }
    }
  }
}

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。

例外狀況

指令或問題發生關聯時應傳回例外狀況。指令可能會成功或失敗。

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

本範例是啟動保全系統的「是，正在啟動保全系統」車窗打開了。

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