סכימת 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" : "eqxAGXAQ3bD4LQkqCi4R8XaqC_..."
  }
}

תשובה

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

שדות של בקשת GenerateImage

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

שדות בתשובה של 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.

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

שגיאות

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

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

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