Smart Device Management API

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

ลักษณะเฉพาะ

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

วิธีการ

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

คําสั่งดําเนินการ

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

ใช้การเรียก 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"
    }
  ]
}

ลิสต์

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

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

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

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

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

ข้อผิดพลาด

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