הסכימה של מאפיין NetworkControl לבית חכם

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 מספר

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

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

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

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

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

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

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

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

SUCCESS
FAILURE
lastNetworkUploadSpeedTest אובייקט

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

מהירות ההעלאה במגה-בייט לשנייה (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
}

מכשיר שבו האפשרות networkProfile‏ 'ילדים' מושבתת.

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

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

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

action.devices.commands.EnableDisableGuestNetwork

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

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

פרמטרים

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

חובה.

True כדי להפעיל את הרשת לאורחים, false כדי להשבית את הרשת לאורחים.

דוגמאות

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

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

action.devices.commands.EnableDisableNetworkProfile

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

כדי להשתמש בפקודה הזו, צריך את המאפיינים הבאים: 
{
  "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

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

כדי להשתמש בפקודה הזו, צריך את המאפיינים הבאים: 
{
  "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

תשובות למעקב

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

המטען הייעודי מכיל אחד מהפריטים הבאים:

הצלחה: networkDownloadSpeedMbps

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

חובה.

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

חובה.

התוצאה של הבקשה.

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

SUCCESS
networkDownloadSpeedMbps מספר

חובה.

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

הצלחה: networkUploadSpeedMbps

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

חובה.

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

חובה.

התוצאה של הבקשה.

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

SUCCESS
networkUploadSpeedMbps מספר

חובה.

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

הצלחה: networkDownloadSpeedMbps ו-networkUploadSpeedMbps

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

חובה.

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

חובה.

התוצאה של הבקשה.

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

SUCCESS
networkDownloadSpeedMbps מספר

חובה.

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

חובה.

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

כשל

שדות סוג תיאור
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