สคีมา CameraEventImage

Nest Cam (รุ่นเดิม) Nest Hub Max Nest Doorbell (รุ่นเดิม) 

sdm.devices.traits.CameraEventImage

ลักษณะนี้เป็นของอุปกรณ์ที่รองรับการสร้างรูปภาพจากเหตุการณ์

ช่อง

ไม่มีช่องสำหรับลักษณะนี้

คำสั่ง

GenerateImage

ระบุ URL สำหรับดาวน์โหลดรูปภาพจากกล้อง

คำสั่งนี้รองรับเหตุการณ์ต่อไปนี้

ประเภท องค์ประกอบ คำอธิบาย
กิจกรรม เหตุการณ์การเคลื่อนไหวของลักษณะ CameraMotion กล้องตรวจพบการเคลื่อนไหว
กิจกรรม เหตุการณ์บุคคลของลักษณะ CameraPerson กล้องตรวจพบบุคคล
กิจกรรม เหตุการณ์เสียงของลักษณะ CameraSound กล้องตรวจพบเสียง
กิจกรรม เหตุการณ์กริ่งของลักษณะ DoorbellChime มีคนกดกริ่งประตู
ใช้ eventId จากเหตุการณ์ที่รองรับในคําขอคําสั่งเพื่อรับ URL การดาวน์โหลดสําหรับรูปภาพจากกล้องที่เกี่ยวข้องกับเหตุการณ์นั้น

คำขอและคำตอบของ GenerateImage

ส่งคำขอการตอบกลับ
POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraEventImage.GenerateImage",
  "params" : {
    "eventId" : "W5ee-_6HEyr8JQUP_rp8NWz1SI..."
  }
}

{
  "results" : {
    "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "token" : "g.0.eventToken"
  }
}

ฟิลด์คำขอ GenerateImage

ช่อง คำอธิบาย ประเภทข้อมูล
eventId รหัสของเหตุการณ์ที่จะขอรูปภาพจากกล้องที่เกี่ยวข้อง string
ตัวอย่าง: "W5ee-_6HEyr8JQUP_rp8NWz1SI..."

ฟิลด์คำตอบของ GenerateImage

ช่อง คำอธิบาย ประเภทข้อมูล
url URL สำหรับดาวน์โหลดรูปภาพจากกล้อง string
ตัวอย่าง: "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1..."
token โทเค็นที่จะใช้ในส่วนหัวการให้สิทธิ์ HTTP เมื่อดาวน์โหลดรูปภาพ string
ตัวอย่าง: "g.0.eventToken"

ดาวน์โหลดรูปภาพจากกล้อง

เรียกใช้ GET กับ url จากคําตอบของคําสั่ง GenerateImage โดยใช้ token ในส่วนหัวการให้สิทธิ์ HTTP ที่มีการให้สิทธิ์พื้นฐาน เพื่อดาวน์โหลดรูปภาพจากกล้อง

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...

ใช้พารามิเตอร์การค้นหา width หรือ height เพื่อปรับแต่งความละเอียดของรูปภาพที่ดาวน์โหลด คุณต้องระบุเพียงพารามิเตอร์รายการใดรายการหนึ่งเท่านั้น ระบบจะปรับขนาดพารามิเตอร์อื่นๆ โดยอัตโนมัติตามสัดส่วนภาพของกล้อง

ตัวอย่างเช่น หากสัดส่วนภาพของกล้องคือ 4:3 หากต้องการดาวน์โหลดรูปภาพจากกล้องที่มีความละเอียด 480 x 360 ให้ระบุความกว้างหรือความสูงดังนี้

ความกว้างส่วนสูง
curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?width=480
 
curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?height=360

ข้อจำกัดอื่นๆ สำหรับ URL การดาวน์โหลดมีดังนี้

  • หากระบุทั้ง 2 พารามิเตอร์ใน URL ระบบจะใช้ width และละเว้น height
  • หากไม่ได้ระบุพารามิเตอร์ใดเลยใน URL ระบบจะเลือกค่าเริ่มต้น 480 สำหรับ width

ดูข้อมูลเกี่ยวกับพร็อพเพอร์ตี้รูปภาพได้ที่แอตทริบิวต์ CameraImage

ข้อผิดพลาด

ระบบอาจแสดงรหัสข้อผิดพลาดต่อไปนี้ที่เกี่ยวข้องกับลักษณะนี้

ข้อความแสดงข้อผิดพลาด RPC การแก้ปัญหา
รูปภาพจากกล้องจะดาวน์โหลดไม่ได้อีกต่อไป DEADLINE_EXCEEDED รูปภาพกิจกรรมจะหมดอายุใน 30 วินาทีหลังจากที่เผยแพร่กิจกรรม โปรดดาวน์โหลดรูปภาพก่อนหมดอายุ
รหัสเหตุการณ์ไม่ได้เป็นของกล้อง FAILED_PRECONDITION ใช้ eventID ที่ถูกต้องซึ่งแสดงผลโดยเหตุการณ์กล้อง

ดูรายการรหัสข้อผิดพลาดทั้งหมดของ API ได้ที่ข้อมูลอ้างอิงรหัสข้อผิดพลาดของ API