Korzystanie z interfejsu API

Po uzyskaniu tokena dostępu i wywołaniu początkowego wywołania listy urządzeń możesz używać interfejsu SDM API do uzyskiwania dostępu do urządzenia i jego kontrolowania.

Lista struktur i urządzeń

Aby wykonać proste wywołanie GET do punktu końcowego structures, użyj curl:

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

Pomyślne wywołanie zwraca listę struktur kont połączonych z Twoim projektemDevice Access :

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

Jeśli jeszcze tego nie zrobiono, wykonaj wywołanie GET do punktu końcowego devices, aby uzyskać listę urządzeń:

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

Pomyślne wywołanie zwraca listę urządzeń połączonych z Twoim projektem Device Access. Każde urządzenie ma własną listę dostępnych cech:

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

Skopiuj device-id dla każdego urządzenia, ponieważ będziesz go potrzebować do innych wywołań interfejsu API.

Pobieranie informacji o urządzeniu

Aby uzyskać informacje o konkretnym urządzeniu, wykonaj wywołanie GET do punktu końcowego 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'

Odpowiedź powinna być podobna do poprzedniej, ale tylko dla konkretnego urządzenia:

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

Wykonywanie polecenia

Po potwierdzeniu dostępu za pomocą wywołania GET spróbuj wykonać polecenie w zależności od typu autoryzowanego urządzenia:

TERMOSTAT

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

APARAT

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

Jeśli wywołanie się powiedzie, nastąpi:

TERMOSTAT

Otrzymasz pustą odpowiedź, a termostat fizyczny zmieni bieżący tryb na tryb określony w parametrach polecenia.

{}

APARAT

Otrzymasz adres URL transmisji na żywo i powiązane tokeny.

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

Rozwiązywanie problemów

Nieuwierzytelnione

Tokeny dostępu do interfejsu SDM API są ważne tylko przez 1 godzinę. Jeśli otrzymasz odpowiedź UNAUTHENTICATED, token prawdopodobnie wygasł. Użyj tokena odświeżania, aby uzyskać nowy token dostępu.

Inne błędy

Pełną listę kodów błędów Device Access znajdziesz w dokumentacji dotyczącej kodów błędów.