ลักษณะใน SDM API จะประกอบด้วยช่อง คำสั่ง และเหตุการณ์
ช่อง
ฟิลด์คือค่าที่มีประเภทข้อมูลทั่วไป เช่น ตัวเลขหรือสตริง เช่น ช่องอาจมีโหมดปัจจุบันหรือความชื้นแวดล้อมของ Google Nest Thermostat
คุณดูลักษณะและช่องได้ด้วยการเรียก GET
ไปยังปลายทาง API ที่ต้องการ
GET /enterprises/project-id/devices/device-id
{
"name" : "enterprises/project-id/devices/device-id",
"type" : "sdm.devices.types.device-type",
"traits" : { ... },
"parentRelations" : [
{
"parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
"displayName" : "Lobby"
}
]
}
ประเภทอุปกรณ์
คุณไม่ควรใช้ sdm.devices.types.device-type
ที่แสดงผลโดย SDM API เพื่ออนุมานหรือสรุปฟังก์ชันการทำงานของอุปกรณ์จริงที่มอบหมาย โดยไม่รับประกันว่าประเภทอุปกรณ์จะมีความเสถียรในอุปกรณ์หนึ่งๆ เนื่องจากมีการเพิ่มฟีเจอร์ไปยัง SDM API มากขึ้น ให้ใช้ลักษณะที่ส่งคืนสำหรับอุปกรณ์แทน
parentRelations
ออบเจ็กต์
parentRelations
แสดงถึงทรัพยากรหลักของทรัพยากรปัจจุบัน ไม่ว่าจะเป็นโครงสร้างหรือห้อง ชื่อที่แสดงตรงกับช่อง
customName
ของ
ลักษณะของข้อมูล
สำหรับอุปกรณ์ที่มีโครงสร้างระดับบนสุดหรือ
แอตทริบิวต์RoomInfo}{18/parent/}
คำสั่ง
คำสั่งคือคำขอที่เชื่อมโยงกับลักษณะ เช่น การเปลี่ยนโหมดปัจจุบันหรืออุณหภูมิที่กำหนดใน Google Nest Thermostat
ระบบจะส่งคำสั่งโดยการเรียก API executeCommand
:
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "command-name",
"params" : {
"field" : "value"
}
}
การตอบสนองต่อคำสั่งส่วนใหญ่มักประสบความสำเร็จหรือล้มเหลวได้ง่ายๆ ดูตัวอย่างการใช้คำสั่งที่เฉพาะเจาะจงได้ในคำแนะนำลักษณะเฉพาะแต่ละรายการ
กิจกรรม
เหตุการณ์เป็นแบบไม่พร้อมกันและจัดการโดย Google Cloud Pub/Sub ในหัวข้อเดียวต่อรหัส Project
โดยค่าเริ่มต้น ระบบจะส่งเหตุการณ์สำหรับการเปลี่ยนแปลงค่าของช่องลักษณะ นอกจากนี้ยังสามารถส่งเพื่อตอบสนองต่อการทำงานของอุปกรณ์ที่เจาะจงหรือการเปลี่ยนแปลงการกำหนดทรัพยากรได้ด้วย ดูเหตุการณ์สำหรับข้อมูลเพิ่มเติม
หมวดหมู่ลักษณะ
โครงสร้าง
ลักษณะเฉพาะ |
ข้อมูล |
sdm.structures.traits.Info |
ลักษณะนี้เป็นของโครงสร้างใดก็ได้สำหรับข้อมูลที่เกี่ยวข้องกับโครงสร้าง |
|
RoomInfo |
sdm.structures.traits.RoomInfo |
ลักษณะนี้เป็นของห้องใดๆ สำหรับข้อมูลที่เกี่ยวข้องกับห้อง |
|
อุปกรณ์
ลักษณะเฉพาะ |
การเชื่อมต่อ |
sdm.devices.traits.Connectivity |
โดยลักษณะนี้เป็นของอุปกรณ์ทุกเครื่องที่มีข้อมูลการเชื่อมต่อ |
|
แฟนคลับ |
sdm.devices.traits.Fan |
ลักษณะนี้เป็นของอุปกรณ์ใดก็ตามที่ระบบควบคุมพัดลมได้ |
|
ความชื้น |
sdm.devices.traits.Humidity |
ลักษณะนี้เป็นของอุปกรณ์ที่มีเซ็นเซอร์วัดความชื้น |
|
ข้อมูล |
sdm.devices.traits.Info |
ลักษณะนี้เป็นของอุปกรณ์ใดๆ สำหรับข้อมูลที่เกี่ยวข้องกับอุปกรณ์ |
|
การตั้งค่า |
sdm.devices.traits.Settings |
ลักษณะนี้เป็นของอุปกรณ์ใดก็ได้สำหรับข้อมูลการตั้งค่าที่เกี่ยวข้องกับอุปกรณ์ |
|
อุณหภูมิ |
sdm.devices.traits.Temperature |
ลักษณะนี้เป็นของอุปกรณ์ที่มีเซ็นเซอร์สำหรับวัดอุณหภูมิ |
|
ตัวคุมอุณหภูมิ
ลักษณะเฉพาะ |
ThermostatEco |
sdm.devices.traits.ThermostatEco |
ลักษณะนี้เป็นของอุปกรณ์ประเภทตัวควบคุมอุณหภูมิที่รองรับโหมดอีโค |
|
ThermostatHvac |
sdm.devices.traits.ThermostatHvac |
โดยลักษณะนี้เป็นของอุปกรณ์ประเภท THERMOSTAT ที่สามารถรายงานรายละเอียดระบบปรับอากาศ (HVAC) ได้ |
|
ThermostatMode |
sdm.devices.traits.ThermostatMode |
ลักษณะนี้เป็นของอุปกรณ์ประเภทตัวควบคุมอุณหภูมิที่รองรับโหมดตัวควบคุมอุณหภูมิต่างๆ |
|
ThermostatTemperatureSetpoint |
sdm.devices.traits.ThermostatTemperatureSetpoint |
ลักษณะนี้เป็นของอุปกรณ์ประเภทตัวควบคุมอุณหภูมิที่รองรับการตั้งค่าอุณหภูมิและช่วงอุณหภูมิเป้าหมาย |
|
กล้อง
ลักษณะเฉพาะ |
CameraClipPreview |
sdm.devices.traits.CameraClipPreview |
ลักษณะนี้เป็นของอุปกรณ์ทั้งหมดที่รองรับการดาวน์โหลดตัวอย่างคลิป |
|
CameraEventImage |
sdm.devices.traits.CameraEventImage |
ลักษณะนี้เป็นของอุปกรณ์ทั้งหมดที่รองรับการสร้างรูปภาพจากเหตุการณ์ |
|
CameraImage |
sdm.devices.traits.CameraImage |
ลักษณะนี้เป็นของทุกอุปกรณ์ที่รองรับการถ่ายภาพ |
|
CameraLiveStream |
sdm.devices.traits.CameraLiveStream |
ลักษณะนี้เป็นของอุปกรณ์ที่รองรับสตรีมมิงแบบสด |
|
CameraMotion |
sdm.devices.traits.CameraMotion |
ลักษณะนี้เป็นของทุกอุปกรณ์ที่รองรับเหตุการณ์การตรวจจับการเคลื่อนไหว |
|
CameraPerson |
sdm.devices.traits.CameraPerson |
ลักษณะนี้เป็นของทุกอุปกรณ์ที่รองรับเหตุการณ์การตรวจจับคน |
|
CameraSound |
sdm.devices.traits.CameraSound |
ลักษณะนี้เป็นของอุปกรณ์ทั้งหมดที่รองรับเหตุการณ์การตรวจจับเสียง |
|
กริ่งประตู
ลักษณะเฉพาะ |
DoorbellChime |
sdm.devices.traits.DoorbellChime |
ลักษณะนี้เป็นของอุปกรณ์ทั้งหมดที่รองรับกริ่งประตูแบบมีกริ่งและเหตุการณ์สื่อที่เกี่ยวข้อง |
|