סכימת CameraEventImage

‫Nest Cam (גרסה קודמת) Nest Hub Max Nest Doorbell (גרסה קודמת) 

sdm.devices.traits.CameraEventImage

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

שדות

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

פקודות

GenerateImage

כתובת URL להורדה של תמונה מהמצלמה.

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

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

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

בקשה

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

תשובה

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

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

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

שדות התגובה של 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, כדי להוריד את תמונת המצלמה ברזולוציה של 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, ערך ברירת המחדל של width הוא 480.

מידע על מאפייני התמונות זמין במאפיין CameraImage .

שגיאות

יכול להיות שהמערכת תחזיר את קודי השגיאה הבאים שקשורים למאפיין הזה:

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

רשימה מלאה של קודי השגיאה של ה-API מפורטת בדף קודי השגיאה.