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

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"
  ]
}

מצבי המכשיר

ישויות עם התכונה הזו עשויות לדווח על הנושאים הבאים כחלק מהפעולה 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 epoch)] של הזמן שבו בוצעה בדיקת המהירות האחרונה של הורדת רשת.

status String

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

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

SUCCESS
FAILURE
lastNetworkUploadSpeedTest מפגע

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

uploadSpeedMbps מספר

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

unixTimestampSec Integer

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

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
}

מכשיר עם ה'ילדים' Network Profile (פרופיל הרשת) מושבת.

{
  "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. למידה מידע נוסף על הטמעת תשובות המשך: התראות על פעולות בבית חכם.

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

הצלחה: 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