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