Błędy i wyjątki

Ten dokument zawiera oficjalnie obsługiwane błędy i wyjątki dla inteligentnych urządzeniach domowych. Użyj w intencji tych kodów błędów i wyjątków lub w powiadomieniach jeśli korzystasz z usługi, Asystent Google ostrzega użytkowników o problemach związanych z podane polecenie lub stan 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 urządzenie jest teraz niedostępne”.

Błędy

Kod błędu powinien być zwracany, gdy problem powoduje wykonanie lub . Jeśli na przykład zamek w drzwiach się zaciął i nie można go zablokowany lub odblokowany, użytkownik powinien otrzymać komunikat o błędzie dotyczący tego stanu.

Kody błędów można dołączać na poziomie urządzenia lub na poziomie globalnym. Przykład: jeśli użytkownik ma wiele źródeł światła od jednego dostawcy i jest sterowane przez centrum, użytkownik prosi o wyłączenie wszystkich świateł, usługodawca może zwrócić na poziomie urządzenia, jeśli pojedynczy punkt oświetlenia jest offline, lub błąd na poziomie globalnym, jeśli jego urządzenia są w trybie offline i nie można sterować oświetleniem. Jeśli wszystkie urządzenia są offline, nie ma różnicy między używaniem na poziomie urządzenia czy na poziomie globalnym . Gdy urządzenie jest offline, stan {"online": false} należy zgłosić jako reportState, nawet jeśli zwrócisz deviceOffline – kod błędu.

W skrócie:

• 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 przypadkami powodzenia

.

Błędy na poziomie globalnym

Ten fragment kodu JSON pokazuje, jak zwracać błędy na poziomie globalnym w Odpowiedź QUERY lub EXECUTE.

Przykład błędu na poziomie globalnym deviceOffline spowodowany przez centrum: offline:

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

Przykład błędu na poziomie globalnym inSoftwareUpdate spowodowany przez centrum: aktualizowanie:

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

Błędy na poziomie urządzenia

Odpowiedź QUERY

Poniższy fragment kodu JSON pokazuje, jak zwrócić błędy na poziomie urządzenia w Odpowiedź QUERY.

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

EXECUTE odpowiedź

Poniższy fragment kodu JSON pokazuje, jak zwrócić błędy na poziomie urządzenia w EXECUTE Odpowiedź.

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

Poniższy fragment kodu JSON pokazuje, jak zgłaszać błędy na poziomie urządzenia w aktywne powiadomienie.

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

Dalsza odpowiedź

Poniższy fragment kodu JSON pokazuje, jak zgłaszać błędy na poziomie urządzenia w kolejną odpowiedź.

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

Wymienione niżej błędy powodują wygenerowanie powiązanej funkcji zamiany tekstu na mowę na urządzeniu.

Wyjątki

Należy zwrócić wyjątek, gdy występuje problem lub alert związany z . Polecenie może się powieść lub zakończyć niepowodzeniem.

Jeśli polecenie zostało wykonane pomyślnie (stan = „UDAŁO SIĘ”), zgłoś wyjątki z cechą StatusReport (w przypadku urządzeń innych niż docelowe), lub zwrócenie odpowiedniej wartości exceptionCode (dla urządzenia docelowego).

Jeśli na przykład ekran suszarki jest pełny, użytkownik może na suszarce, możesz jednak ostrzegać ich o tym stanie. Podobnie, gdy urządzenie ma słabą baterię, która nie jest pusta, nadal możesz wykonać polecenie ale należy powiadomić ich, że bateria urządzenia jest słaba.

Jeśli polecenie nie powiedzie się z powodu wyjątków, powinien mieć stan „EXCEPTIONS”, a wyjątki należy zgłaszać, używając właściwości StatusReport.

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

Ten przykład dotyczy zamykania drzwi:

Zamek przy drzwiach wejściowych ma słabą baterię. Zamykam zamek w drzwiach wejściowych.

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

Nieblokujący wyjątek (SUKCES) dotyczący innego urządzenia za pomocą raportu StatusReport

Ten przykład dotyczy włączania systemu alarmowego: OK, włączam system alarmowy. Frontowe 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"
        }]
      }
    }]
  }
}

Wyjątek blokujący inne urządzenie za pomocą raportu 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 powodują utworzenie powiązanej funkcji zamiany tekstu na mowę na urządzeniu.