תכונות

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

כל הקריאות ל-SDM API צריכות להשתמש בנקודת הקצה הבאה:
https://smartdevicemanagement.googleapis.com/v1

שדות

שדות הם ערכים עם סוגי נתונים נפוצים, כמו מספר או מחרוזת. לדוגמה, שדה יכול להכיל את המצב הנוכחי או את הלחות הסביבתית של 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 כדי להסיק או להסתמך על הפונקציונליות של המכשיר בפועל שאליו הוא מוקצה. אין ערובה שסוג מכשיר מסוים יישאר יציב במכשיר ספציפי ככל שיתווספו תכונות ל-SDM API. במקום זאת, צריך להשתמש במאפיינים שהוחזרו עבור המכשיר.

parentRelations

האובייקט parentRelations מייצג את משאב ההורה של המשאב הנוכחי, שהוא מבנה או חדר. השם המוצג תואם לשדה customName שלInfo במכשירים עם הורה מסוג מבנה, או למאפייןRoomInfo במכשירים עם הורה מסוג חדר.

פקודות

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

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

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

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

אירועים

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

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

קטגוריות של מאפיינים

מבנה

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

מכשיר

מאפיינים
קישוריות	sdm.devices.traits.Connectivity המאפיין הזה שייך לכל מכשיר שיש בו פרטי קישוריות.
Fan	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 המאפיין הזה שייך לסוגי מכשירים מסוג THERMOSTAT שתומכים במצבי ECO.
ThermostatHvac	sdm.devices.traits.ThermostatHvac המאפיין הזה שייך לסוגים של מכשירים מסוג תרמוסטט שיכולים לדווח על פרטי בקרת אקלים.
ThermostatMode	sdm.devices.traits.ThermostatMode המאפיין הזה שייך לסוגים של מכשירי THERMOSTAT שתומכים במצבים שונים של התרמוסטט.
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 המאפיין הזה שייך לכל מכשיר שתומך בצלצול של פעמון דלת ובאירועי לחיצה קשורים.