Smart Device Management API

SDM API คือ REST API ที่มีวิธีการต่างๆ ในการแสดงลักษณะและดำเนินการตามคำสั่งลักษณะเพื่อจัดการอุปกรณ์ Google Nest ใช้โทเค็นเพื่อการเข้าถึงที่ได้รับในระหว่าง กับการเรียก API แต่ละครั้ง

ลักษณะ

SDM API ใช้โมเดลที่อิงตามลักษณะสำหรับข้อมูลอุปกรณ์ และฟังก์ชันการทำงาน ดูคำแนะนำอุปกรณ์แต่ละเครื่องเพื่อดูว่าลักษณะเฉพาะอะไรบ้าง พร้อมใช้งานสำหรับอุปกรณ์:

เมธอด

ดูรายละเอียดทั้งหมดเกี่ยวกับเมธอดทั้งหมดที่ใช้ได้กับ SDM API ได้ในเอกสารอ้างอิง API

executeCommand

เรียกใช้คำสั่งกับอุปกรณ์ที่ได้รับอนุญาต

ใช้การเรียก POST เพื่อดำเนินการตามคำสั่ง เช่น หากต้องการเปลี่ยนตัวควบคุมอุณหภูมิ โหมด:

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

ดูตัวอย่างคำสั่งเพิ่มเติมได้ในการอ้างอิงลักษณะเฉพาะแต่ละรายการ ดูรายการลักษณะทั้งหมด เพื่อดูข้อมูลเพิ่มเติม

รับ

รับข้อมูลเกี่ยวกับโครงสร้างหรืออุปกรณ์ที่ได้รับอนุญาต

การเรียกใช้ GET จะแสดงผลลัพธ์เดียวที่มีฟิลด์และค่าปัจจุบันสำหรับลักษณะทั้งหมดที่ใช้ได้กับโครงสร้างหรืออุปกรณ์ที่ผู้ใช้ user ให้สิทธิ์ และออบเจ็กต์ "parentRelations" ซึ่งแสดงถึงทรัพยากรหลักของทรัพยากรปัจจุบัน ไม่ว่าจะเป็นโครงสร้างหรือห้อง

ตัวอย่างเช่น Nest Thermostat อาจส่งคืน ดังต่อไปนี้:

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

แสดงรายการโครงสร้าง ห้อง หรืออุปกรณ์ที่ได้รับอนุญาต

หากต้องการแสดงรายการโครงสร้าง ห้อง หรืออุปกรณ์ทั้งหมดที่ได้รับสิทธิ์ภายใต้โทเค็นการเข้าถึงรายการเดียว ให้เรียกใช้ GET กับปลายทางทรัพยากรที่เหมาะสม ดังนี้

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

การผสานรวมกับ Google Assistant

เมื่ออุปกรณ์ได้รับอนุญาตให้ใช้ SDM แล้ว Google จะรับรู้ถึงอุปกรณ์ในหน้าแรก สร้างกราฟและจัดการสถานะโดยตรง หากมีการผสานรวม Google Assistant โดยเป็นส่วนหนึ่งของข้อเสนอเชิงพาณิชย์ของคุณ

ข้อผิดพลาด

ดูรายการรหัสข้อผิดพลาด API ทั้งหมดได้ที่ข้อมูลอ้างอิงรหัสข้อผิดพลาด API