הסכימה של CameraEventImage

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

sdm.devices.traits.CameraEventImage

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

שדות

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

פקודות

GenerateImage

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

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

סוג רכיב תיאור
אירוע האירוע תנועה של המאפיין 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" : "G3bcBgWL_M1vso939z5WqrcOE5..."
  }
}

תשובה

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

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

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

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

שדה תיאור סוג הנתונים
url כתובת ה-URL שממנה מורידים את התמונה מהמצלמה. string
דוגמה: "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1..."
token אסימון לשימוש בכותרת Authorization של 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 על 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.