דף זה תורגם על ידי Cloud Translation API.

תכונות

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

כל הקריאות ל-SDM API צריכות להתבסס על נקודת קצה (endpoint):
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 של מאפיין מידע במכשירים עם הורה מובנה RoomInfo trait למכשירים עם הורה לחדר.

פקודות

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

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

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

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

אירועים

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

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