Erros e exceções

Este documento lista os erros e exceções oficialmente compatíveis para dispositivos de casa inteligente. Use esses códigos de erros e exceções na resposta da intent ou em notificações se você tiver implementado isso. Assim, o Google Assistente alerta os usuários finais sobre problemas relacionados a um determinado comando ou estado do dispositivo. Se a resposta tiver formatação incorreta ou errorCode, o Google Assistente vai mostrar aos usuários uma mensagem de erro genérica, por exemplo, "Desculpe, o dispositivo não está disponível no momento".

Erros

Retorne um código de erro quando um problema causar a falha de uma solicitação de execução ou consulta. Por exemplo, se uma fechadura estiver travada e não puder ser trancada ou destrancada, um erro sobre esse estado deverá ser retornado ao usuário.

Os códigos de erro podem ser anexados no nível do dispositivo ou global. Por exemplo, se um usuário tiver muitas luzes de um provedor controladas por um hub, quando ele pedir para desligar todas as luzes, o provedor poderá retornar um erro no nível do dispositivo se uma única luz estiver off-line ou um erro global se todo o hub estiver off-line e nenhuma luz puder ser controlada. Se todos os dispositivos estiverem off-line, não haverá diferença entre usar erros no nível global ou no nível do dispositivo.

Resumindo:

• Erro global: todos os dispositivos na resposta têm o mesmo erro
• Erro no nível local: resposta mista com casos de erro e sucesso

Erros no nível global

O snippet JSON a seguir mostra como retornar erros globais em uma resposta QUERY ou EXECUTE.

Um exemplo de erro global deviceOffline devido ao hub é offline:

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

Um exemplo de erro global inSoftwareUpdate devido ao hub é a atualização:

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

Erros no nível do dispositivo

Resposta de QUERY

O snippet JSON a seguir mostra como retornar erros no nível do dispositivo na resposta QUERY.

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

Resposta EXECUTE

O snippet JSON a seguir mostra como retornar erros no nível do dispositivo na resposta 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
        }
      }
    ]
  }
}

Notificações com erros

Notificação proativa

O snippet JSON a seguir mostra como informar erros no nível do dispositivo em uma notificação proativa.

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

Resposta de acompanhamento

O snippet JSON a seguir mostra como informar erros no nível do dispositivo em uma resposta de acompanhamento.

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

Os erros a seguir vão produzir a TTS associada no dispositivo.

Relatórios de estado on-line e off-line

"requestId": "test-request-id",
  "agentUserId": "agent-user-1",
    "payload":{
      "devices": {
        "states": {
          "device-id-1": {
            "brightness": 65,
            "on": true,
            "online": true
          }
          "notifications": {},
        }
      }
    }

Exceções

Retorne uma exceção quando houver um problema ou alerta associado a um comando. O comando pode ser concluído ou falhar.

Se o comando for bem-sucedido (status = "SUCCESS"), informe as exceções usando a característica StatusReport (para dispositivos que não são o destino) ou retornando um exceptionCode apropriado (para o dispositivo de destino).

Por exemplo, se o filtro de fiapos da secadora estiver cheio, o usuário ainda poderá iniciar a secadora, mas talvez seja bom avisá-lo sobre isso. Da mesma forma, quando um dispositivo tem uma bateria fraca, mas não está descarregada, você ainda pode executar um comando, mas precisa informar que a bateria está fraca.

Se o comando falhar devido a exceções, o status será "EXCEPTIONS", e as exceções serão informadas usando a característica StatusReport.

Exceção não bloqueadora (SUCCESS) sobre o dispositivo de destino

Este exemplo é para trancar a porta:

A bateria da fechadura da porta da frente está fraca. Trancando a porta da frente.

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

Exceção sem bloqueio (SUCCESS) sobre outro dispositivo usando StatusReport

Este exemplo é para ativar um sistema de segurança: Ok, ativando o sistema de segurança. A janela da frente está aberta.

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

Exceção de bloqueio sobre outro dispositivo usando 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 de exceções

As seguintes exceções vão produzir a TTS associada no dispositivo.