Usar a API

Com um token de acesso em mãos e a chamada inicial da lista de dispositivos feita, você está pronto para usar a API SDM para acessar e controlar seu dispositivo.

Listar estruturas e dispositivos

Use curl para fazer uma chamada GET simples ao endpoint structures:

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/structures' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

Uma chamada bem-sucedida retorna uma lista de estruturas para contas vinculadas ao seu projeto do Device Access :

{
  "structures": [
    {
      "name": "enterprises/project-id/structures/structure-id",
      "traits": {
        "sdm.structures.traits.Info": {
          "customName": "structure-name"
        }
      }
    }
  ]
}

Se ainda não tiver feito isso, faça uma chamada GET para o endpoint devices e receba uma lista de dispositivos:

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

Uma chamada bem-sucedida retorna uma lista de dispositivos vinculados ao seu projeto do Device Access. Cada dispositivo tem uma lista exclusiva de características disponíveis:

{
  "devices": [
    {
      "name": "enterprises/project-id/devices/device-id",
      "type": "sdm.devices.types.device-type",
      "traits": { ... },
      "parentRelations": [
        {
          "parent": "enterprises/project-id/structures/structure-id/rooms/room-id",
          "displayName": "device-room-name"
        }
      ]
    }
  ]
}

Copie o device-id de cada dispositivo. Você vai precisar dele para outras chamadas de API.

Acessar informações de um dispositivo

Para receber informações sobre um dispositivo específico, faça uma chamada GET para o endpoint device-id:

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

A resposta será semelhante à anterior, mas apenas para o dispositivo específico:

{
  "name": "enterprises/project-id/devices/device-id",
  "type": "sdm.devices.types.device-type",
  "traits": { ... },
  "parentRelations": [
    {
      "parent": "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName": "device-room-name"
    }
  ]
}

Executar um comando

Depois de validar seu acesso com uma chamada GET bem-sucedida, tente executar um comando dependendo do tipo de dispositivo autorizado:

curl -X POST \
  'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id:executeCommand' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer access-token' \
  --data-raw '{
    "command" : "sdm.devices.commands.ThermostatMode.SetMode",
    "params" : {
      "mode" : "HEAT"
    }
  }'

curl -X POST \
  'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id:executeCommand' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer access-token' \
  --data-raw '{
    "command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
    "params" : {}
  }'

Se a chamada for bem-sucedida, os seguintes resultados vão ocorrer:

{}

{
  "results" : {
    "streamUrls" : {
      "rtspUrl" : "rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken"
    },
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
    "streamToken" : "g.0.streamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

Solução de problemas

Não autenticadas

Os tokens de acesso à API SDM são válidos por apenas uma hora. Se você receber uma resposta UNAUTHENTICATED, provavelmente o token expirou. Use seu token de atualização para receber um novo token de acesso.

Outros erros

Consulte a referência de código de erro para conferir a lista completa de códigos de erro Device Access .