Usar a API

Com um token de acesso em mãos e a chamada de lista de dispositivos inicial 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 para o 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 projetoDevice Access :

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

Se você ainda não fez isso, faça uma chamada GET para o endpoint devices para receber 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 projeto Device Access. Cada dispositivo tem a própria lista única 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 para cada dispositivo. Você precisará dele para outras chamadas de API.

Receber informações de um dispositivo

Para receber informações de 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:

TERMOSTATO

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

CÂMERA

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 serão exibidos:

TERMOSTATO

Você recebe uma resposta vazia e o termostato físico altera o modo atual para o especificado nos parâmetros de comando.

{}

CÂMERA

Você recebe um URL de transmissão ao vivo e tokens relacionados.

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

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

Outros erros

Consulte a Referência do código de erros para ver a lista completa de Device Access códigos de erro.