Smart Device Management API

SDM API adalah REST API yang menyediakan berbagai metode untuk melihat ciri dan mengeksekusi perintah trait untuk pengelolaan Perangkat Google Nest. Gunakan token akses yang diberikan selama proses otorisasi dengan setiap panggilan API.

Sifat

SDM API menggunakan model berbasis karakteristik untuk informasi perangkat dan fungsionalitasnya. Periksa masing-masing panduan perangkat untuk melihat karakteristiknya yang tersedia untuk perangkat:

Metode

Lihat Referensi API untuk mengetahui detail selengkapnya tentang semua metode yang tersedia untuk SDM API.

executeCommand

Menjalankan perintah ke perangkat yang diberi otorisasi.

Gunakan panggilan POST untuk menjalankan perintah. Misalnya, untuk mengganti termostat mode:

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.ThermostatMode.SetMode",
  "params" : {
    "mode" : "HEAT"
  }
}

Contoh perintah lebih lanjut dapat ditemukan di setiap referensi ciri masing-masing kami. Lihat listingan ciri lengkap untuk informasi selengkapnya.

get

Mendapatkan informasi tentang struktur atau perangkat yang diizinkan.

Panggilan GET menampilkan satu respons dengan kolom saat ini dan nilai untuk semua yang tersedia untuk struktur atau perangkat yang user dimiliki dan `parentRelations' , yang merepresentasikan resource induk dari sumber daya saat ini, baik struktur atau ruangan.

Misalnya, Nest Thermostat mungkin menampilkan berikut ini:

GET /enterprises/project-id/devices/device-id
{
  "name" : "enterprises/project-id/devices/device-id",
  "type" : "sdm.devices.types.THERMOSTAT",
  "assignee" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "traits" : {
    "sdm.devices.traits.Connectivity" : {
      "status" : "ONLINE"
    },
    "sdm.devices.traits.Fan" : {
      "timerMode" : "ON",
      "timerTimeout" : "2019-05-10T03:22:54Z"
    },
    "sdm.devices.traits.Humidity" : {
      "ambientHumidityPercent" : 35.0
    },
    "sdm.devices.traits.Info" : {
      "customName" : "My device"
    },
    "sdm.devices.traits.Settings" : {
      "temperatureScale" : "CELSIUS"
    },
    "sdm.devices.traits.Temperature" : {
      "ambientTemperatureCelsius" : 23.0
    },
    "sdm.devices.traits.ThermostatEco" : {
      "availableModes" : ["MANUAL_ECO", "OFF"],
      "mode" : "MANUAL_ECO",
      "heatCelsius" : 20.0,
      "coolCelsius" : 22.0
    },
    "sdm.devices.traits.ThermostatHvac" : {
      "status" : "HEATING"
    },
    "sdm.devices.traits.ThermostatMode" : {
      "availableModes" : ["HEAT", "COOL", "HEATCOOL", "OFF"],
      "mode" : "COOL"
    },
    "sdm.devices.traits.ThermostatTemperatureSetpoint" : {
      "heatCelsius" : 20.0,
      "coolCelsius" : 22.0
    }
  },
  "parentRelations" : [
    {
      "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName" : "Lobby"
    }
  ]
}

list

Mencantumkan struktur, ruangan, atau perangkat yang diizinkan.

Untuk mencantumkan semua struktur, ruangan, atau perangkat yang diotorisasi dengan satu akses token, lakukan panggilan GET terhadap endpoint resource yang sesuai:

GET /enterprises/project-id/structures
GET /enterprises/project-id/structures/structure-id/rooms
GET /enterprises/project-id/devices

Integrasi Asisten Google

Setelah perangkat diberi otorisasi untuk SDM, Google akan mengetahui perangkat tersebut di Home Membuat grafik dan mengelola statusnya secara langsung. Jika Anda memiliki integrasi Asisten Google sebagai bagian dari penawaran Komersial:

Error

Lihat Referensi Kode Error API untuk daftar lengkap kode error API.