סכימת מאפיינים של שליטה ברשת הבית החכם

‫action.devices.traits.NetworkControl – המאפיין הזה שייך למכשירים שתומכים בדיווח על נתוני רשת ובביצוע פעולות ספציפיות לרשת.

מאפייני המכשיר

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

מאפיינים סוג תיאור
supportsEnablingGuestNetwork בוליאני

(ברירת מחדל: false)

הגדרה ל-True אם אפשר להפעיל את הרשת לאורחים.
supportsDisablingGuestNetwork בוליאני

(ברירת מחדל: false)

הגדרה כ-True אם אפשר להשבית את הרשת לאורחים.
supportsGettingGuestNetworkPassword בוליאני

(ברירת מחדל: false)

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

מציין את השמות הנתמכים של פרופילי הרשת.
[item, ...] String

השם של פרופיל רשת שמייצג קבוצה של מכשירים קשורים.
supportsEnablingNetworkProfile בוליאני

(ברירת מחדל: "false")

ההגדרה צריכה להיות True אם אפשר להפעיל פרופילים של רשתות.
supportsDisablingNetworkProfile בוליאני

(ברירת מחדל: "false")

הגדרת הערך כ-True מאפשרת להשבית פרופילים של רשתות.
supportsNetworkDownloadSpeedTest בוליאני

(ברירת מחדל: false)

הערך צריך להיות True אם אפשר להריץ בדיקת מהירות הורדה.
supportsNetworkUploadSpeedTest בוליאני

(ברירת מחדל: false)

ההגדרה צריכה להיות True אם אפשר להריץ בדיקה של מהירות ההעלאה.

דוגמאות

מכשיר רשת שתומך ברשת לאורחים, בפרופילים ובבדיקת מהירות.

{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true,
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true,
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true,
  "supportsGettingGuestNetworkPassword": true,
  "networkProfiles": [
    "Kids"
  ]
}

מצבי המכשיר

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

מדינות סוג תיאור
networkEnabled בוליאני

האם הרשת הראשית מופעלת.
networkSettings אובייקט

מכיל את ה-SSID של הרשת הראשית.
ssid String

חובה.

‫SSID של הרשת.
guestNetworkEnabled בוליאני

אם הרשת לאורחים מופעלת.
guestNetworkSettings אובייקט

מכיל את ה-SSID של הרשת לאורחים.
ssid String

חובה.

‫SSID של הרשת.
numConnectedDevices Integer

מספר המכשירים שמחוברים לרשת.
networkUsageMB Number

השימוש ברשת במגה-בייט (MB). השימוש ברשת הוא במסגרת תקופת החיוב הנוכחית, וזה יכול להיות שימושי למעקב אחרי מגבלת השימוש ברשת בתקופת החיוב.
networkUsageLimitMB Number

מגבלת השימוש ברשת במגה-בייט (MB). מגבלת השימוש ברשת היא במסגרת תקופת החיוב הנוכחית.
networkUsageUnlimited בוליאני

האם השימוש ברשת הוא ללא הגבלה. אם המדיניות הזו מוגדרת כ-True, המערכת מתעלמת ממצב המכשיר networkUsageLimitMB.
lastNetworkDownloadSpeedTest אובייקט

מכיל את התוצאות של בדיקת מהירות ההורדה האחרונה ברשת.
downloadSpeedMbps Number

מהירות ההורדה במגה-ביט לשנייה (Mbps) של בדיקת מהירות הרשת האחרונה.
unixTimestampSec Integer

חותמת הזמן של מערכת Unix (מספר השניות מאז ראשית זמן יוניקס) של הזמן שבו בוצעה בדיקת המהירות האחרונה של הורדה מהרשת.
status String

מציין אם בדיקת המהירות האחרונה של ההורדה מהרשת הצליחה או נכשלה.

ערכים נתמכים:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest אובייקט

מכיל את התוצאות של בדיקת מהירות ההעלאה האחרונה ברשת.
uploadSpeedMbps Number

מהירות ההעלאה במגה-ביט לשנייה (Mbps) של בדיקת מהירות הרשת האחרונה.
unixTimestampSec Integer

חותמת הזמן של מערכת Unix (מספר השניות מאז ראשית זמן יוניקס) של הזמן שבו בוצעה בדיקת מהירות ההעלאה האחרונה ברשת.
status String

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

ערכים נתמכים:

SUCCESS
FAILURE
networkSpeedTestInProgress בוליאני

(ברירת מחדל: false)

האם בדיקת מהירות מופעלת כרגע.
networkProfilesState אובייקט

מצב של פרופילי רשת. האובייקט הזה ברמה העליונה צריך להכיל צמדי מפתח-ערך, שבהם המפתח הוא השם של אחד מפרופילי הרשת שמופיעים במאפיין networkProfiles, והערך הוא המצב התואם של הפרופיל.
<string> אובייקט

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

המצב הנוכחי של פרופיל הרשת (מופעל או מושבת).

דוגמאות

מכשיר עם רשת פעילה.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8
}

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

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8,
  "lastNetworkDownloadSpeedTest": {
    "downloadSpeedMbps": 159.8,
    "unixTimestampSec": 1563215576,
    "status": "SUCCESS"
  },
  "lastNetworkUploadSpeedTest": {
    "uploadSpeedMbps": 64.1,
    "unixTimestampSec": 1563215576,
    "status": "SUCCESS"
  }
}

מכשיר עם רשת פעילה ובדיקת מהירות בתהליך.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8,
  "networkSpeedTestInProgress": true
}

מכשיר שבו פרופיל הערוצים 'ילדים' מושבת.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "networkProfilesState": {
    "parents": {
      "enabled": true
    },
    "kids": {
      "enabled": false
    }
  }
}

פקודות במכשיר

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

action.devices.commands.EnableDisableGuestNetwork

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

הפקודה הזו דורשת את המאפיינים הבאים: 
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

פרמטרים

פרמטרים סוג תיאור
enable בוליאני

חובה.

הערך True מפעיל את הרשת לאורחים, והערך False משבית אותה.

דוגמאות

מפעילים את רשת האורחים.

{
  "command": "action.devices.commands.EnableDisableGuestNetwork",
  "params": {
    "enable": true
  }
}

action.devices.commands.EnableDisableNetworkProfile

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

הפקודה הזו דורשת את המאפיינים הבאים: 
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

פרמטרים

פרמטרים סוג תיאור
profile String

חובה.

שם הפרופיל מהמאפיין networkProfiles.
enable בוליאני

חובה.

הערך True מפעיל את הפרופיל, והערך False משבית את הפרופיל.

דוגמאות

מנתקים את האינטרנט לילדים.

{
  "command": "action.devices.commands.EnableDisableNetworkProfile",
  "params": {
    "profile": "Kids",
    "enable": false
  }
}

אירעה שגיאה בניסיון לשלוט בפרופיל הרשת שצוין.

ערכים נתמכים:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

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

הפקודה הזו דורשת את המאפיינים הבאים: 
{
  "supportsGettingGuestNetworkPassword": true
}

פרמטרים

פרמטרים סוג תיאור

אין נכסים

דוגמאות

הצגת הסיסמה של רשת ה-Wi-Fi לאורחים

{
  "command": "action.devices.commands.GetGuestNetworkPassword",
  "params": {}
}

תוצאות

תוצאות סוג תיאור
guestNetworkPassword String

חובה.

הסיסמה של הרשת לאורחים.

דוגמאות

הצגת הסיסמה של רשת ה-Wi-Fi לאורחים

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

בודקים את מהירות ההורדה ומהירות ההעלאה של הרשת.

הפקודה הזו דורשת את המאפיינים הבאים: 
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

פרמטרים

פרמטרים סוג תיאור
testDownloadSpeed בוליאני

חובה.

מציין אם צריך לבדוק את מהירות ההורדה.
testUploadSpeed בוליאני

חובה.

מציין אם צריך לבדוק את מהירות ההעלאה.
followUpToken String

חובה.

אסימון ש-Google מספקת לתשובה להמשך השיחה.

דוגמאות

מה מהירות ה-Wi-Fi?

{
  "command": "action.devices.commands.TestNetworkSpeed",
  "params": {
    "testDownloadSpeed": true,
    "testUploadSpeed": true,
    "followUpToken": "123"
  }
}

קרתה שגיאה במהלך הניסיון לבקש בדיקת מהירות.

ערכים נתמכים:

networkSpeedTestInProgress

תשובות המשך

מכשירים עם המאפיין הזה עשויים להחזיר את מטען המידע (payload) הבא של תגובת המשך כחלק מפעולת EXECUTE. מידע נוסף על הטמעה של תגובות המשך זמין במאמר התראות לפעולות בבית חכם.

המטען הייעודי (payload) מכיל את אחד מהערכים הבאים:

הצלחה: networkDownloadSpeedMbps

שדות סוג תיאור
followUpToken String

חובה.

הטוקן שסופק בבקשת ה-EXECUTE המקורית.
status String

חובה.

תוצאת הבקשה.

ערכים נתמכים:

SUCCESS
networkDownloadSpeedMbps Number

חובה.

מהירות ההורדה ברשת, שנמדדת במגה-ביט לשנייה.

הצלחה: networkUploadSpeedMbps

שדות סוג תיאור
followUpToken String

חובה.

הטוקן שסופק בבקשת ה-EXECUTE המקורית.
status String

חובה.

תוצאת הבקשה.

ערכים נתמכים:

SUCCESS
networkUploadSpeedMbps Number

חובה.

מהירות ההעלאה ברשת, שנמדדת במגה-ביט לשנייה.

הצלחה: networkDownloadSpeedMbps ו-networkUploadSpeedMbps

שדות סוג תיאור
followUpToken String

חובה.

הטוקן שסופק בבקשת ה-EXECUTE המקורית.
status String

חובה.

תוצאת הבקשה.

ערכים נתמכים:

SUCCESS
networkDownloadSpeedMbps Number

חובה.

מהירות ההורדה ברשת, שנמדדת במגה-ביט לשנייה.
networkUploadSpeedMbps Number

חובה.

מהירות ההעלאה ברשת, שנמדדת במגה-ביט לשנייה.

כשל

שדות סוג תיאור
followUpToken String

חובה.

הטוקן שסופק בבקשת ה-EXECUTE המקורית.
status String

חובה.

תוצאת הבקשה.

ערכים נתמכים:

FAILURE
errorCode String

חובה.

הערך יכול להיות כל קוד שגיאה של המאפיין הזה, למשל transientError.

דוגמאות

מה מהירות ה-Wi-Fi? (תשובה למעקב)

{
  "NetworkControl": {
    "priority": 0,
    "followUpResponse": {
      "status": "SUCCESS",
      "networkDownloadSpeedMbps": 23.3,
      "networkUploadSpeedMbps": 10.2,
      "followUpToken": "1234"
    }
  }
}

מה מהירות ה-Wi-Fi? (תגובה להמשך עם כשל)

{
  "NetworkControl": {
    "priority": 0,
    "followUpResponse": {
      "status": "FAILURE",
      "errorCode": "transientError",
      "followUpToken": "1234"
    }
  }
}

שגיאות במכשיר

רשימה מלאה של שגיאות וחריגים

אירעה שגיאה בניסיון לשלוט בפרופיל הרשת שצוין.

ערכים נתמכים:

networkProfileNotRecognized

קרתה שגיאה במהלך הניסיון לבקש בדיקת מהירות.

ערכים נתמכים:

networkSpeedTestInProgress