סכימת DoorbellChime

‫Nest Doorbell (גרסה קודמת) Nest Doorbell (סוללה) Nest Doorbell (עם חיבור קווי) 

sdm.devices.traits.DoorbellChime

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

שדות

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

פקודות

אין פקודות בשביל המאפיין הזה.

אירועים

מנגנון צלצול

ניתן לעדכן 

פעמון הדלת נלחץ.

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

אירוע של צלצול

מטען ייעודי (payload)

{
  "eventId" : "47c8099c-1727-4640-a29c-1c3e51ea095a",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.DoorbellChime.Chime" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "gItLXXH4whIMvCkC4s3y3FG9_A..."
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
  "eventThreadState" : "STARTED",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

השדות של אירוע הצלצול

שדה תיאור סוג הנתונים
eventSessionId ‫Nest Doorbell (סוללה) Nest Doorbell (עם חיבור קווי) מזהה שניתן לאירועים שמתרחשים כחלק מסשן יחיד של אירועים קשורים. אפשר להשתמש בו כדי לאחד אירועים.

אפשר להשתמש בו כדי לשייך את האירוע הזה לאירוע הקשור ClipPreview של המאפיין CameraClipPreview.

 ‫string
דוגמה: "CjY5Y3VKaTZwR3o4Y19YbTVfMF...‎"
eventId ‫Nest Doorbell (גרסה קודמת) מזהה שמשויך לאירוע.

אפשר להשתמש בו עם הפקודה GenerateImage כדי להוריד את התמונה שקשורה לאירוע הזה שצולמה במצלמה.

 ‫string
דוגמה: "gItLXXH4whIMvCkC4s3y3FG9_A...‎"

שדות המטען הייעודי (payload) של האירוע

שדה תיאור סוג נתונים
eventId המזהה הייחודי של האירוע. ‫string
דוגמה: ‎47c8099c-1727-4640-a29c-1c3e51ea095a‎
timestamp השעה שבה התרחש האירוע. ‫string
דוגמה: ‎"2019-01-01T00:00:01Z"‎
resourceUpdate אובייקט שמכיל פרטים על עדכון המשאב. object
userId מזהה ייחודי שעובר ערפול ומייצג את המשתמש. ‫string
דוגמה: ‎AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi‎
eventThreadId ‫ניתן לעדכון המזהה הייחודי של שרשור האירועים. ‫string
דוגמה: ‎d67cd3f7-86a7-425e-8bb3-462f92ec9f59‎"
eventThreadState ‫ניתן לעדכון הסטטוס של שרשור האירועים. ‫string
ערכים: "STARTED",‏ "UPDATED",‏ "ENDED"
resourceGroup אובייקט שמציין משאבים שעשויים להיות להם עדכונים דומים לאירוע הזה. המשאב של האירוע עצמו (מהאובייקט resourceUpdate) תמיד יהיה נוכח באובייקט הזה. object

בקטע אירועים מוסבר על הסוגים השונים של האירועים ועל אופן הפעולה שלהם.

שגיאות

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

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

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