ลักษณะใน 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 สำหรับอุปกรณ์ที่มี
ผู้ปกครองของห้องแชท
คำสั่ง
คำสั่งคือคำขอที่เชื่อมโยงกับลักษณะหนึ่งๆ ตัวอย่างเช่น การเปลี่ยนโหมดปัจจุบัน หรือ
อุณหภูมิที่กำหนดบน 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 |
ลักษณะนี้เป็นของประเภทอุปกรณ์ตัวควบคุมอุณหภูมิ ที่สามารถรายงานรายละเอียดระบบปรับอากาศ (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 |
ลักษณะนี้เป็นของอุปกรณ์ที่รองรับกริ่งประตูกริ่งและกิจกรรมการกดที่เกี่ยวข้อง |
|