สคีมา CameraEventImage

Nest Cam (เดิม) Nest Hub Max Nest Doorbell (เดิม) 

sdm.devices.traits.CameraEventImage

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

ช่อง

ไม่มีฟิลด์สำหรับลักษณะนี้

คำสั่ง

GenerateImage

ระบุ URL ที่จะใช้ดาวน์โหลดรูปภาพจากกล้อง

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

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

คำขอและการตอบกลับ GenerateImage

ส่งคำขอ

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraEventImage.GenerateImage",
  "params" : {
    "eventId" : "fd-3vZxi0xQGNvbhbrR8BHm1KK..."
  }
}

คำตอบ

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

ช่องคำขอ GenerateImage

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

ช่องคำตอบของ 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

ดูข้อมูลเกี่ยวกับคุณสมบัติของรูปภาพได้ที่ฟีเจอร์ กล้องถ่ายรูป

ข้อผิดพลาด

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

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

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