Błędy i wyjątki

W tym dokumencie znajdziesz oficjalne błędy i wyjątki dotyczące inteligentnych urządzeń domowych. Używaj tych kodów błędów i wyjątków w odpowiedzi na zamiar lub w powiadomieniach, jeśli je masz. Aby Asystent Google ostrzegał użytkowników o problemach związanych z danym poleceniem lub stanem urządzenia. Jeśli odpowiedź zawiera nieprawidłowe formatowanie lub errorCode, Asystent Google wyświetla użytkownikom ogólny komunikat o błędzie, na przykład „Urządzenie jest teraz niedostępne”.

Błędy

Jeśli błąd powoduje wykonanie polecenia lub zapytania zapytania, powinien zostać zwrócony kod błędu. Jeśli na przykład zamek w drzwiach się zaciął i nie można go zamknąć ani odblokować, użytkownik powinien zobaczyć błąd o tym stanie.

Kody błędów można dołączać na poziomie urządzenia lub na poziomie globalnym. Jeśli na przykład użytkownik ma wiele lamp u jednego dostawcy i steruje nim centrum, gdy użytkownik poprosi o wyłączenie wszystkich świateł, dostawca może zwrócić błąd na poziomie urządzenia, gdy pojedyncza żarówka jest offline, lub błąd na poziomie globalnym, gdy całe centrum jest offline i nie można sterować oświetleniem. Jeśli wszystkie urządzenia są offline, nie ma różnicy między błędami na poziomie globalnym lub urządzenia. Gdy urządzenie jest offline, musisz zgłosić stan {"online": false} w polu reportState, nawet jeśli zwrócisz kod błędu deviceOffline.

Podsumowanie:

• Błąd na poziomie globalnym: wszystkie urządzenia w odpowiedzi mają ten sam błąd
• Błąd na poziomie lokalnym: odpowiedź mieszana z błędami i sukcesami

Błędy na poziomie globalnym

Ten fragment kodu JSON pokazuje, jak zwrócić błędy na poziomie globalnym w odpowiedzi na zapytanie QUERY lub EXECUTE.

Przykład błędu globalnego poziomu deviceOffline związanego z centrum to tryb offline:

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

Przykład błędu globalnego poziomu inSoftwareUpdate związanego z centrum:

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

Błędy na poziomie urządzenia

Odpowiedź QUERY

Ten fragment kodu JSON pokazuje, jak zwrócić błędy na poziomie urządzenia w odpowiedzi QUERY.

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

WYKONAJ ODPOWIEDŹ

Ten fragment kodu JSON pokazuje, jak zwrócić błędy na poziomie urządzenia w odpowiedzi 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
        }
      }
    ]
  }
}

Powiadomienia z błędami

Aktywne powiadomienie

Ten fragment kodu JSON pokazuje, jak zgłaszać błędy na poziomie urządzenia w ramach aktywnego wyświetlania powiadomień.

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

Odpowiedź uzupełniająca

Ten fragment kodu JSON pokazuje, jak zgłosić błędy na poziomie urządzenia w dalszej odpowiedzi.

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

Lista błędów

Błędy opisane poniżej wygenerują na urządzeniu powiązanym TTS.

Wyjątki

Zwróć wyjątek, jeśli wystąpi problem związany z poleceniem. Polecenie może się udać lub nie udać.

Jeśli polecenie zakończyło się powodzeniem (stan = „SUCCESS”), możesz zgłosić wyjątki za pomocą cechy StatusReport (w przypadku urządzeń innych niż docelowe) albo zwrócić odpowiednią wartość exceptionCode (dla urządzenia docelowego).

Jeśli na przykład ekran suszarki jest pełny, użytkownik może uruchomić suszarkę, ale możesz mu ostrzegać. Analogicznie, jeśli bateria w urządzeniu jest słaba, możesz wykonać polecenie, ale poinformuj nas o tym.

Jeśli polecenie nie powiedzie się z powodu wyjątków, stan powinien mieć wartość „EXEKPTIONS”, a wyjątki powinny być zgłaszane za pomocą cechy StatusReport.

Wyjątek nieblokujący (SUCCESS) dotyczący urządzenia docelowego

Oto przykład zamykania drzwi:

Bateria w drzwiach wejściowych ma niski poziom baterii. Zamykam drzwi frontowe.

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

Wyjątek nieblokujący (SUCCESS) dotyczący innego urządzenia

Oto przykład zbrojenia systemu alarmowego: włączam system alarmowy. Otwarte okno jest otwarte.

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

Blokowanie wyjątku innego urządzenia za pomocą funkcji 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"
          }
        ]
      }
    }
  }
}

Lista wyjątków

Poniższe wyjątki spowodują wygenerowanie tekstu TTS na urządzeniu.