סכימת תכונות של רשת בית חכם

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

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

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

מאפיינים	סוג	תיאור
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"
  ]
}

מכשיר STATES

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

מדינות	סוג	תיאור
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	חותמת הזמן של 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
}

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

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

COMMANDS של מכשיר

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

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

תגובות המשך

מכשירים עם התכונה הזו עשויים להחזיר את המטען הייעודי (payload) הבא של התגובה, במסגרת הפעולה 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"
    }
  }
}

מכשיר ERRORS

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

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

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

networkProfileNotRecognized

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

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

networkSpeedTestInProgress