SDM API คือ REST API ที่ให้วิธีต่างๆ ในการดูลักษณะและเรียกใช้คำสั่งลักษณะเพื่อการจัดการอุปกรณ์ Google Nest ใช้โทเค็นเพื่อการเข้าถึงที่ได้รับในระหว่างกระบวนการให้สิทธิ์กับการเรียก API แต่ละครั้ง
ลักษณะเฉพาะ
SDM API ใช้โมเดลแบบอิงตามลักษณะสำหรับข้อมูลและฟังก์ชันการทำงานของอุปกรณ์ อ่านคู่มืออุปกรณ์แต่ละรายการเพื่อดูว่าอุปกรณ์มีลักษณะใดบ้าง
- กล้อง
- กล้อง (แบตเตอรี่)
- กล้องที่มี Floodlight
- กล้อง (แบบใช้สาย)
- Display
- กริ่งประตู
- กริ่งประตู (แบตเตอรี่)
- กริ่งประตู (แบบใช้สาย)
- ตัวควบคุมอุณหภูมิ
วิธีการ
ดูรายละเอียดทั้งหมดเกี่ยวกับวิธีการทั้งหมดที่ใช้กับ 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" } ] }
ลิสต์
แสดงรายการโครงสร้าง ห้อง หรืออุปกรณ์ที่ได้รับอนุญาต
หากต้องการแสดงรายการโครงสร้าง ห้อง หรืออุปกรณ์ทั้งหมดที่ได้รับสิทธิ์ภายใต้โทเค็นเพื่อการเข้าถึงรายการเดียว ให้เรียก 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 เป็นส่วนหนึ่งของข้อเสนอเชิงพาณิชย์ ให้ทำดังนี้
- อย่าส่งคำขอซิงค์สำหรับอุปกรณ์ SDM
- ละเว้นอุปกรณ์ SDM จากการตอบสนองต่อจุดประสงค์ของการซิงค์
ข้อผิดพลาด
ดูรายการรหัสข้อผิดพลาด API ทั้งหมดได้ที่ข้อมูลอ้างอิงรหัสข้อผิดพลาดของ API