Esquema de características de SmartLock LockUnlock

action.devices.traits.LockUnlock: essa característica pertence a qualquer dispositivo compatível com bloqueio e desbloqueio e/ou geração de relatórios de estado bloqueado.

ATRIBUTOS DO DISPOSITIVO

Nenhuma.

STATES do dispositivo

Dispositivos com essa característica podem informar os estados a seguir como parte da operação QUERY. Para saber mais sobre como processar intents QUERY, consulte fulfillment de intent.

Estados	Tipo	Descrição
isLocked	Booleano	Indica se o dispositivo está bloqueado.
isJammed	Booleano	Se o dispositivo está emperrado e, portanto, o estado bloqueado não pode ser determinado.

Exemplos

Dispositivo bloqueado

{
  "isLocked": true
}

Dispositivo emperrado

{
  "isJammed": true
}

Comandos do dispositivo

Dispositivos com essa característica podem responder aos seguintes comandos como parte da operação EXECUTE. Para saber mais sobre como processar intents EXECUTE, consulte fulfillment de intent.

action.devices.commands.LockUnlock

Bloqueie ou desbloqueie o dispositivo.

Parâmetros

Parâmetros	Tipo	Descrição
lock	Booleano	Obrigatório. Verdadeiro quando o comando é bloquear, falso para desbloquear.
followUpToken	String	Token fornecido pelo Google para resposta de acompanhamento.

Exemplos

Tranque a porta da frente.

{
  "command": "action.devices.commands.LockUnlock",
  "params": {
    "lock": true,
    "followUpToken": "123"
  }
}

Destranque a porta da frente.

{
  "command": "action.devices.commands.LockUnlock",
  "params": {
    "lock": false,
    "followUpToken": "567"
  }
}

Erros relacionados

Ocorreu um erro ao bloquear ou desbloquear o dispositivo.

Os valores suportados são:

remoteSetDisabled

deviceJammingDetected

notSupported

alreadyLocked

alreadyUnlocked

Respostas de acompanhamento

Dispositivos com essa característica podem retornar o seguinte payload de resposta de acompanhamento como parte da operação EXECUTE. Para saber mais sobre como implementar respostas de acompanhamento, consulte Notificações de ações de casa inteligente.

O payload contém um dos seguintes itens:

Sucesso: bloqueado

Campos	Tipo	Descrição
followUpToken	String	Obrigatório. Token fornecido na solicitação EXECUTE original.
status	String	Obrigatório. Resultado da solicitação. Os valores suportados são: SUCCESS
isLocked	Booleano	Obrigatório. Indica se o dispositivo está bloqueado.

Falha

Campos	Tipo	Descrição
followUpToken	String	Obrigatório. Token fornecido na solicitação EXECUTE original.
status	String	Obrigatório. Resultado da solicitação. Os valores suportados são: FAILURE
errorCode	String	Obrigatório. O valor pode ser qualquer código de erro dessa característica, por exemplo, deviceJammingDetected.

Exemplos

Trancar a porta da frente. (resposta de acompanhamento do caso de sucesso)

{
  "LockUnlock": {
    "priority": 0,
    "followUpResponse": {
      "status": "SUCCESS",
      "isLocked": true,
      "followUpToken": "1234"
    }
  }
}

Destranque a porta da frente. (resposta de acompanhamento do caso de sucesso)

{
  "LockUnlock": {
    "priority": 0,
    "followUpResponse": {
      "status": "SUCCESS",
      "isLocked": false,
      "followUpToken": "1234"
    }
  }
}

Trancar a porta da frente. (resposta de acompanhamento do caso de falha)

{
  "LockUnlock": {
    "priority": 0,
    "followUpResponse": {
      "status": "FAILURE",
      "errorCode": "deviceJammingDetected",
      "followUpToken": "1234"
    }
  }
}

Exemplos de declarações

de-DE

• Mordida Eingangstür abschließen
• Bitte schließ die Eingangstür auf

en-US

• cadeado minhas portas
• desbloquear sala de estudo

es-ES

• cierra la puerta con llave
• quitar El Cercerjo de la Puerta de Participante a

fr-FR

• déverrouille la porte d'entrée
• verrouille la porte d'entrée

Dispositivo ERRORS

Veja a lista completa de erros e exceções.