오류 및 예외

이 문서에서는 스마트 기능 관련 공식적으로 지원되는 오류 및 예외사항을 홈 기기. 인텐트에 주어진 오류 및 예외 코드를 사용하세요. 응답 또는 알림에서 Google 어시스턴트가 최종 사용자에게 상태 정보를 전송합니다. 응답에 잘못된 형식이 포함되어 있거나 errorCode, Google 어시스턴트가 사용자에게 일반적인 오류 메시지를 제공합니다. 예를 들면 다음과 같습니다. '죄송합니다. 현재 기기를 사용할 수 없습니다.'

오류

문제로 인해 실행 또는 오류가 발생하면 쿼리 요청이 실패합니다 예를 들어 도어락이 걸려서 문을 열 수 없는 경우 잠금 또는 잠금 해제되어 있으면 이 상태에 대한 오류가 사용자에게 반환되어야 합니다.

오류 코드는 기기 수준 또는 전역 수준에서 첨부할 수 있습니다. 예를 들어 사용자가 한 제공업체의 조명이 여러 개 있고 허브에서 제어하는 경우 사용자가 조명을 모두 끄도록 요청하는 경우 제공업체는 조명 1개가 오프라인 상태인 경우 기기 수준의 오류, 또는 조명 1개가 오프라인 상태인 경우 전체 수준의 오류 전체 허브가 오프라인 상태이고 조명을 제어할 수 없습니다. 모든 기기가 오프라인 상태이므로 전역 수준 또는 기기 수준 사용 간에 차이가 없음 오류가 발생했습니다. 기기가 오프라인 상태이면 다음 위치에서 {"online": false} 상태를 보고해야 합니다. reportState를 반환하여 deviceOffline 오류 코드입니다.

요약:

• 전역 수준 오류: 응답의 모든 기기에 동일한 오류가 있습니다.
• 로컬 수준 오류: 오류 및 성공 사례와 혼합된 응답

를 통해 개인정보처리방침을 정의할 수 있습니다.

전역 수준 오류

다음 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 트레잇 사용 (타겟 외 기기의 경우) 또는 적절한 exceptionCode (대상 기기)를 반환함

예를 들어 건조기 보풀 화면이 가득 차도 이 상태에 대해 경고하는 것이 좋습니다. 마찬가지로 기기의 배터리가 부족합니다. 기기 배터리가 부족하다고 알려야 합니다.

예외로 인해 명령어가 실패하면 상태는 "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가 생성됩니다.