ลักษณะเฉพาะ

ลักษณะใน SDM API ประกอบด้วยฟิลด์ คำสั่ง และเหตุการณ์

ช่อง

ฟิลด์คือค่าที่มีประเภทข้อมูลทั่วไป เช่น ตัวเลขหรือสตริง เช่น ฟิลด์ อาจมีโหมดปัจจุบันหรือความชื้นแวดล้อมของตัวควบคุมอุณหภูมิ Google Nest

ดูลักษณะและฟิลด์ได้โดย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

ระบบจะส่งคำสั่งโดยการเรียก executeCommand API ดังนี้

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "command-name",
  "params" : {
    "field" : "value"
  }
}

การตอบกลับคำสั่งส่วนใหญ่จะเป็นเพียงการระบุว่าสำเร็จหรือล้มเหลว ดูคู่มือลักษณะเฉพาะแต่ละรายการเพื่อดู ตัวอย่างการใช้คำสั่งที่เฉพาะเจาะจง

กิจกรรม

เหตุการณ์เป็นแบบไม่พร้อมกันและจัดการโดย Google Cloud Pub/Sub ในหัวข้อเดียวต่อ Project ID

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

หมวดหมู่ลักษณะ

โครงสร้าง

ลักษณะ
ข้อมูล	sdm.structures.traits.Info ลักษณะนี้เป็นของโครงสร้างใดก็ตามสำหรับข้อมูลที่เกี่ยวข้องกับโครงสร้าง
RoomInfo	sdm.structures.traits.RoomInfo ลักษณะนี้เป็นของห้องพักใดก็ได้สำหรับข้อมูลที่เกี่ยวข้องกับห้องพัก

อุปกรณ์

ลักษณะ
การเชื่อมต่อ	sdm.devices.traits.Connectivity ลักษณะนี้เป็นของอุปกรณ์ที่มีข้อมูลการเชื่อมต่อ
Fan	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 ลักษณะนี้เป็นของประเภทอุปกรณ์ THERMOSTAT ที่รองรับโหมดตัวควบคุมอุณหภูมิที่แตกต่างกัน
ThermostatTemperatureSetpoint	sdm.devices.traits.ThermostatTemperatureSetpoint ลักษณะนี้เป็นของอุปกรณ์ประเภท THERMOSTAT ที่รองรับการตั้งค่าอุณหภูมิเป้าหมายและช่วงอุณหภูมิ

กล้อง

ลักษณะ
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 ลักษณะนี้เป็นของอุปกรณ์ที่รองรับเสียงกริ่งประตูและเหตุการณ์กดที่เกี่ยวข้อง