סכימה של CameraEventImage

Nest Cam (מדור קודם) Nest Hub Max Nest Doorbell (מדור קודם) 

sdm.devices.traits.CameraEventImage

התכונה הזו שייכת לכל מכשיר שתומך ביצירת תמונות מאירועים.

שדות

אין שדות זמינים לתכונה הזו.

פקודות

GenerateImage

מספק כתובת URL שממנה מורידים תמונת מצלמה.

הפקודה הזו תומכת באירועים הבאים:

סוג רכיב תיאור
אירוע אירוע תנועה של תכונת CameraMotion המצלמה זיהתה תנועה.
אירוע אירוע Person (אדם) של תכונת CameraPerson המצלמה זיהתה אדם.
אירוע אירוע צליל של תכונת CameraSound המצלמה זיהתה צליל.
אירוע אירוע Chime (Chime) במאפיין Doorbell של Doorbell פעמון הדלת נלחץ.
כדי לקבל כתובת URL להורדה של תמונת המצלמה שקשורה לאירוע הזה, צריך להשתמש בפונקציה eventId של אירוע נתמך בבקשת הפקודה.

בקשה ותשובה ל-GenerateImage

בקשה

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

תשובה

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

שדות הבקשה ל-GenerateImage

שדה תיאור סוג הנתונים
eventId מזהה האירוע שעבורו רוצים לבקש תמונת מצלמה קשורה. string
דוגמה: "8NYaH5PZ6kftObq1UK3k6qfOcC..."

שדות התגובה של 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 להורדה:

  • אם שני הפרמטרים צוינו בכתובת ה-URL, המערכת תשתמש ב-width והמערכת תתעלם מ-height.
  • אם לא צוין אף פרמטר בכתובת ה-URL, נבחר ערך ברירת מחדל של 480 עבור width.

כדי לקבל מידע על מאפייני התמונה, אפשר לעיין במאפיין מצלמהתמונה .

שגיאות

ניתן להחזיר את קודי השגיאה הבאים ביחס לתכונה הזו:

הודעת שגיאה הכנסה לקליק פתרון בעיות
תמונת המצלמה כבר לא זמינה להורדה. DEADLINE_EXCEEDED התוקף של תמונות אירוע פג 30 שניות לאחר פרסום האירוע. חשוב להקפיד להוריד את התמונה לפני תאריך התפוגה.
מזהה האירוע לא שייך למצלמה. FAILED_PRECONDITION צריך להשתמש בערך eventID הנכון שהוחזר על ידי אירוע המצלמה.

הרשימה המלאה של קודי השגיאות ב-API זמינה בחומר העזר בנושא קוד שגיאה ב-API.