หน้านี้ได้รับการแปลโดย Cloud Translation API

ลักษณะเฉพาะ

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

การเรียก SDM API ทั้งหมดควรใช้ ปลายทางต่อไปนี้
https://smartdevicemanagement.googleapis.com/v1

ช่อง

ฟิลด์คือค่าที่มีประเภทข้อมูลทั่วไป เช่น ตัวเลขหรือสตริง เช่น ฟิลด์ อาจมีโหมดปัจจุบันหรือความชื้นแวดล้อมของตัวควบคุมอุณหภูมิ 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

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