תכונות

תכונה ב-SDM API מורכבת משדות, פקודות ואירועים.

שדות

שדות הם ערכים עם סוגי נתונים נפוצים, כמו מספר או מחרוזת. לדוגמה, שדה עשוי להכיל את המצב הנוכחי או את לחות הסביבה של Google Nest Thermostat.

אפשר להציג תכונות ושדות באמצעות קריאה ל-GET לנקודת הקצה הרצויה של ה-API:

GET /enterprises/project-id/devices/device-id
{
  "name" : "enterprises/project-id/devices/device-id",
  "type" : "sdm.devices.types.device-type",
  "traits" : { ... },
  "parentRelations" : [
    {
      "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName" : "Lobby"
    }
  ]
}

סוגי מכשירים

אין להשתמש ב-sdm.devices.types.device-type שהוחזר על ידי SDM API כדי להסיק או להסיק את הפונקציונליות של המכשיר האמיתי שאליו הוא מוקצה. אין ערובה לכך שסוג מכשיר יישאר יציב במכשיר ספציפי ככל שיתווספו תכונות נוספות ל-SSD API. במקום זאת, צריך להשתמש בתכונות שהוחזרו עבור המכשיר.

parentRelations

האובייקט parentRelations מייצג את משאב ההורה של המשאב הנוכחי – מבנה או חדר. השם המוצג תואם לשדה customName ב-Info trait למכשירים עם הורה במבנה או ציוד מידע לחדר .

פקודות

פקודות הן בקשות שמשויכות ל-trait. לדוגמה, שינוי המצב הנוכחי או הגדרת הטמפרטורה ב-Google Nest Thermostat.

פקודה נשלחת על ידי קריאה ל-API של executeCommand:

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "command-name",
  "params" : {
    "field" : "value"
  }
}

רוב התשובות לפקודה הן הצלחה או כישלון פשוטים. במדריכים הספציפיים לגבי traits מפורטות דוגמאות לשימוש בפקודות ספציפיות.

אירועים

האירועים הם אסינכרוניים ומנוהלים על ידי Google Cloud Pub/Sub בנושא אחד לכל Project מזהה.

אירועים נשלחים כברירת מחדל לכל שינוי בערך של שדה trait. אפשר גם לשלוח אותם בתגובה לפעולות ספציפיות במכשיר או לשינויים בהקצאות המשאבים. אפשר לקרוא מידע נוסף באירועים.

קטגוריות התכונה

מבנה

תכונות
מידע
sdm.structures.traits.Info
התכונה הזו שייכת לכל מבנה של מידע שקשור למבנה.
RoomInfo
sdm.structures.traits.RoomInfo
התכונה הזו שייכת לכל חדר למידע שקשור לחדרים.

מכשיר

תכונות
קישוריות
sdm.devices.traits.Connectivity
התכונה הזו שייכת לכל מכשיר שיש לו מידע על קישוריות.
מעריץ
sdm.devices.traits.Fan
התכונה הזו שייכת לכל מכשיר שיש לו יכולת לשלוט במאוורר.
לחות
sdm.devices.traits.Humidity
התכונה הזו שייכת לכל מכשיר שיש בו חיישן למדידת הלחות.
מידע
sdm.devices.traits.Info
התכונה הזו שייכת לכל מכשיר שיש בו מידע שקשור למכשיר.
הגדרות
sdm.devices.traits.Settings
התכונה הזו שייכת לכל מכשיר לקבלת פרטי הגדרות שקשורים למכשיר.
הטמפרטורה
sdm.devices.traits.Temperature
התכונה הזו שייכת לכל מכשיר שיש בו חיישן למדידת טמפרטורה.

תרמוסטט

תכונות
ThermostatEco
sdm.devices.traits.ThermostatEco
התכונה הזו שייכת לסוגי מכשירים של תרמוסטט שתומכים במצבי ECO.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
התכונה הזו שייכת לסוגי מכשירים של תרמוסטט שיכול לדווח על פרטי בקרת אקלים.
ThermostatMode
sdm.devices.traits.ThermostatMode
התכונה הזו שייכת לסוגי מכשירים של תרמוסטט שתומכים במצבים שונים של התרמוסטט.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
התכונה הזו שייכת לסוגי מכשירים של THERmostAT שתומכים בהגדרה של טמפרטורת יעד וטווח הטמפרטורה.

מצלמה

תכונות
CameraClipPreview
sdm.devices.traits.CameraClipPreview
התכונה הזו שייכת לכל מכשיר שתומך בהורדה של תצוגה מקדימה של קליפ.
CameraEventImage
sdm.devices.traits.CameraEventImage
התכונה הזו שייכת לכל מכשיר שתומך ביצירת תמונות מאירועים.
CameraImage
sdm.devices.traits.CameraImage
התכונה הזו שייכת לכל מכשיר שתומך בצילום תמונות.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
התכונה הזו שייכת לכל מכשיר שתומך בסטרימינג בשידור חי.
CameraMotion
sdm.devices.traits.CameraMotion
התכונה הזו שייכת לכל מכשיר שתומך באירועי זיהוי תנועה.
CameraPerson
sdm.devices.traits.CameraPerson
התכונה הזו שייכת לכל מכשיר שתומך באירועי זיהוי אנשים.
CameraSound
sdm.devices.traits.CameraSound
התכונה הזו שייכת לכל מכשיר שתומך באירועי זיהוי צלילים.

פעמון דלת

תכונות
DoorbellChime
sdm.devices.traits.DoorbellChime
התכונה הזו שייכת לכל מכשיר שתומך במנגנון צלצול בפעמון דלת ובאירועי לחיצה קשורים.