סכימת CameraEventImage

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

sdm.devices.traits.CameraEventImage

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

שדות

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

פקודות

GenerateImage

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

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

סוג רכיב תיאור
אירוע אירוע Motion של תכונת CameraMotion המצלמה זיהתה תנועה.
אירוע אירוע אדם בתכונת CameraMovie המצלמה זיהתה אדם.
אירוע אירוע צליל של תכונת CameraSound המצלמה זיהתה צליל.
אירוע אירוע Chime של התכונה DoorbellChime פעמון הדלת נלחץ.
כדי לקבל כתובת URL להורדה של תמונת המצלמה שקשורה לאירוע הזה, משתמשים ב-eventId של אירוע נתמך בבקשת הפקודה.

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

בקשה

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

תשובה

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

שדות בקשה של GenerateImage

שדה תיאור סוג הנתונים
eventId מזהה האירוע שיש לבקש עבורו תמונת מצלמה קשורה. string
דוגמה: 'h5efqutCl-AhcwVgrdHsGzXmtD...'

שדות של תגובה מסוג GenerateImage

שדה תיאור סוג הנתונים
url כתובת ה-URL שממנה מורידים את תמונת המצלמה. string
דוגמה: "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1..."
token אסימון לשימוש בכותרת 'HTTP Authorization' כשמורידים את התמונה. string
דוגמה: "g.0.eventToken"

הורדת תמונה ממצלמה

כדי להוריד את תמונת המצלמה, מבצעים קריאת GET ל-url מתגובה של הפקודה GenerateImage , באמצעות token בכותרת Authorization HTTP עם הרשאה בסיסית.

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

משתמשים בפרמטרים של שאילתה width או height כדי להתאים אישית את הרזולוציה של התמונה שהורדתם. צריך לציין רק אחד מהפרמטרים האלה. הגודל של הפרמטר השני מותאם אוטומטית ליחס הגובה-רוחב של המצלמה.

לדוגמה, אם יחס הגובה-רוחב של המצלמה הוא 4:3, כדי להוריד את התמונה ברזולוציה של 480x360, צריך לציין את הרוחב או את הגובה:

רוחב

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.

במידע על מאפייני התמונות, אפשר לעיין ב- CameraImage .

שגיאות

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

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

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