סכימת DoorbellChime

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

sdm.devices.traits.DoorbellChime

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

שדות

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

פקודות

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

אירועים

צלצול פעמונים

ניתן לעדכן 

הופעלה לחיצה על פעמון הדלת.

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

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

מטען ייעודי

{
  "eventId" : "43c9e9e6-797b-4be8-96a1-a6a7a4481047",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.DoorbellChime.Chime" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "-eimJDFj0zCoPljrfIKaxSvB6q..."
      }
    }
  }
  "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
דוגמה: "-eimJDFj0zCoPljrfIKaxSvB6q...‎"

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

שדה תיאור סוג הנתונים
eventId המזהה הייחודי של האירוע. ‫string
דוגמה: "43c9e9e6-797b-4be8-96a1-a6a7a4481047"
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 זמינה בעמוד קודי השגיאה של ה-API.