סכימה של בקרת רשת ביתית חכמה

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

ATTRIBUTES במכשיר

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

מאפיינים	Type	תיאור
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 כוונות זמין בקטע מימוש כוונה.

מדינות	Type	תיאור
networkEnabled	בוליאני	אם הרשת הראשית מופעלת.
networkSettings	אובייקט	מכיל את ה-SSID של הרשת הראשית.
ssid	String	חובה. SSID של הרשת.
guestNetworkEnabled	בוליאני	האם רשת האורח מופעלת.
guestNetworkSettings	אובייקט	מכיל את ה-SSID של רשת האורחים.
ssid	String	חובה. SSID של הרשת.
numConnectedDevices	Integer	מספר המכשירים שמחוברים לרשת.
networkUsageMB	מספר	השימוש ברשת ב-MB (מגה-בייט). השימוש ברשת מתבצע במהלך תקופת החיוב הנוכחית, והיא יכולה להיות שימושית למעקב אחר מגבלת השימוש ברשת בתקופת החיוב.
networkUsageLimitMB	מספר	מגבלת השימוש ברשת במגה-בייט (מגה-בייט). מגבלת השימוש ברשת נמצאת בתקופת החיוב הנוכחית.
networkUsageUnlimited	בוליאני	האם השימוש ברשת הוא ללא הגבלה. אם ערך המדיניות הזה מוגדר כ-True, המערכת תתעלם מהרשת networkUsageLimitMB.
lastNetworkDownloadSpeedTest	אובייקט	מכיל את התוצאות של בדיקת מהירות ההורדה האחרונה של הרשת.
downloadSpeedMbps	מספר	מהירות ההורדה ב-Mbps (מגה-ביט לשנייה) של בדיקת המהירות האחרונה ברשת.
unixTimestampSec	Integer	חותמת הזמן של Unix (מספר השניות מאז 'תקופת Unix') שבה נערכה הבדיקה האחרונה של מהירות ההורדה ברשת.
status	String	מציינת אם בדיקת מהירות ההורדה האחרונה ברשת הצליחה או נכשלה. ערכים נתמכים: SUCCESS FAILURE
lastNetworkUploadSpeedTest	אובייקט	מכיל את התוצאות של בדיקת מהירות ההעלאה האחרונה ברשת.
uploadSpeedMbps	מספר	מהירות ההעלאה ב-Mbps (מגה-ביט לשנייה) של בדיקת המהירות האחרונה ברשת.
unixTimestampSec	Integer	חותמת הזמן של Unix (מספר השניות שחלפו מאז תקופת 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
}

המכשיר עם פרופיל הרשת "kids" מושבת.

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

פקודות מכשיר

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

action.devices.commands.EnableDisableGuestNetwork

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

פקודה זו מחייבת את המאפיינים הבאים:

{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

פרמטרים

פרמטרים	Type	תיאור
enable	בוליאני	חובה. הערך True כדי להפעיל את הרשת לאורחים, הערך False כדי להשבית את הרשת לאורחים.

דוגמאות

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

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

action.devices.commands.EnableDisableNetworkProfile

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

פקודה זו מחייבת את המאפיינים הבאים:

{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

פרמטרים

פרמטרים	Type	תיאור
profile	String	חובה. שם הפרופיל ממאפיין networkProfiles.
enable	בוליאני	חובה. הערך True כדי להפעיל את הפרופיל, הערך False כדי להשבית את הפרופיל.

דוגמאות

להשבית את האינטרנט לילדים.

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

שגיאות קשורות

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

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

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

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

פקודה זו מחייבת את המאפיינים הבאים:

{
  "supportsGettingGuestNetworkPassword": true
}

פרמטרים

פרמטרים	Type	תיאור
אין נכסים

דוגמאות

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

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

תוצאות

תוצאות	Type	תיאור
guestNetworkPassword	String	חובה. הסיסמה של רשת האורחים.

דוגמאות

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

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

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

פקודה זו מחייבת את המאפיינים הבאים:

{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

פרמטרים

פרמטרים	Type	תיאור
testDownloadSpeed	בוליאני	חובה. מציינת אם יש לבדוק את מהירות ההורדה.
testUploadSpeed	בוליאני	חובה. מציינת אם יש לבדוק את מהירות ההעלאה.
followUpToken	String	חובה. אסימון שסופק על ידי Google לתגובת המשך.

דוגמאות

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

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

שגיאות קשורות

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

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

networkSpeedTestInProgress

תשובות להמשך טיפול

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

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

הצלחה: networkDownloadSpeedMbps

שדות	Type	תיאור
followUpToken	String	חובה. האסימון סופק בבקשה המקורית להחרגה.
status	String	חובה. התוצאה של הבקשה. ערכים נתמכים: SUCCESS
networkDownloadSpeedMbps	מספר	חובה. מהירות ההורדה ברשת שנמדדת במגה-ביט לשנייה.

הצלחה: networkUploadSpeedMbps

שדות	Type	תיאור
followUpToken	String	חובה. האסימון סופק בבקשה המקורית להחרגה.
status	String	חובה. התוצאה של הבקשה. ערכים נתמכים: SUCCESS
networkUploadSpeedMbps	מספר	חובה. מהירות ההעלאה ברשת שנמדדת במגה-ביט לשנייה.

הצלחה: networkDownloadSpeedMbps ו-networkUploadSpeedMbps

שדות	Type	תיאור
followUpToken	String	חובה. האסימון סופק בבקשה המקורית להחרגה.
status	String	חובה. התוצאה של הבקשה. ערכים נתמכים: SUCCESS
networkDownloadSpeedMbps	מספר	חובה. מהירות ההורדה ברשת שנמדדת במגה-ביט לשנייה.
networkUploadSpeedMbps	מספר	חובה. מהירות ההעלאה ברשת שנמדדת במגה-ביט לשנייה.

כשל

שדות	Type	תיאור
followUpToken	String	חובה. האסימון סופק בבקשה המקורית להחרגה.
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"
    }
  }
}

ERRORS מכשיר

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

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

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

networkProfileNotRecognized

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

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

networkSpeedTestInProgress