Guia de garagem inteligente

action.devices.types.GARAGE: os portões da garagem podem abrir, fechar e detectar um estado aberto. Eles também podem indicar se um objeto obstruiu o caminho da porta ao fechar ou se ela está trancada e, portanto, não pode ser controlada.

Esse tipo indica que o dispositivo recebe o ícone da garagem e alguns sinônimos e aliases relacionados.

Recursos do dispositivo

Consulte a documentação da característica correspondente para detalhes da implementação, como atributos e estados que seu serviço precisa oferecer suporte, e como criar respostas EXECUTE e QUERY.

Características obrigatórias

Essas características e comandos são obrigatórios, se aplicáveis ao seu dispositivo. Se o dispositivo não for compatível com esses recursos, insira o código de erro de functionNotSupported em uma resposta QUERY ou EXECUTE. Consulte Erros e exceções para mais informações.

Esses traços são recomendados, se aplicáveis ao seu dispositivo. No entanto, você pode misturar e combinar todos os traços disponíveis para corresponder melhor à funcionalidade do produto.

Dispositivo de exemplo: garagem simples

Esta seção contém exemplos de payloads de intent que representam uma "Garagem" comum com base no tipo de dispositivo e nas características acima. Se você adicionar ou remover características na sua implementação, modifique as respostas de acordo para refletir essas mudanças.

Exemplo de resposta de sincronização

Solicitação
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.GARAGE",
        "traits": [
          "action.devices.traits.OpenClose",
          "action.devices.traits.LockUnlock"
        ],
        "name": {
          "name": "Simple garage"
        },
        "willReportState": true,
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Exemplo de resposta de QUERY

Solicitação
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "openPercent": 50,
        "isLocked": false,
        "isJammed": false
      }
    }
  }
}

Exemplos de comandos EXECUTE

OpenClose

Para mais detalhes sobre os parâmetros de comando, consulte a referência action.devices.traits.OpenClose.

Solicitação
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OpenClose",
                "params": {
                  "openPercent": 100
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "openPercent": 100
        }
      }
    ]
  }
}

LockUnlock

Para mais detalhes sobre os parâmetros de comando, consulte a referência action.devices.traits.LockUnlock.

Solicitação
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.LockUnlock",
                "params": {
                  "lock": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isLocked": true,
          "isJammed": false
        }
      }
    ]
  }
}

ERROS do dispositivo

Confira a lista completa de erros e exceções.
  • obstructionDetected: o usuário tentou fechar o portão da garagem, mas havia um objeto obstruindo a porta.
  • lockedState: o usuário tentou controlar o portão da garagem, mas ele está travado e não pode ser movido.