Smart Home NetworkControl Trait स्कीमा

action.devices.traits.NetworkControl - यह एट्रिब्यूट ऐसे डिवाइसों से जुड़ा है जो नेटवर्क डेटा की रिपोर्टिंग और नेटवर्क से जुड़ी कार्रवाइयां करने में मदद करते हैं.

डिवाइस ATTRIBUTES

इस विशेषता वाले डिवाइस ये रिपोर्ट कर सकते हैं SYNC ऑपरेशन के हिस्से के तौर पर एट्रिब्यूट की वैल्यू सबमिट करता है. सीखने में SYNC इंटेंट को मैनेज करने के बारे में ज़्यादा जानने के लिए, देखें इंटेंट पूरा करना.

विशेषताएं	टाइप	ब्यौरा
supportsEnablingGuestNetwork	बूलियन	(डिफ़ॉल्ट: false) अगर मेहमान नेटवर्क चालू किया जा सकता है, तो 'सही' पर सेट करें.
supportsDisablingGuestNetwork	बूलियन	(डिफ़ॉल्ट: false) अगर मेहमान नेटवर्क को बंद किया जा सकता है, तो 'सही है' पर सेट करें.
supportsGettingGuestNetworkPassword	बूलियन	(डिफ़ॉल्ट: false) अगर GetGuestNetworkPassword निर्देश के ज़रिए मेहमान नेटवर्क का पासवर्ड पाया जा सकता है, तो 'सही है' पर सेट करें.
networkProfiles	कलेक्शन	यह विकल्प, इस्तेमाल किए जा सकने वाले नेटवर्क प्रोफ़ाइल के नामों को दिखाता है.
[item, ...]	String	मिलते-जुलते डिवाइसों के ग्रुप को दिखाने वाली नेटवर्क प्रोफ़ाइल का नाम.
supportsEnablingNetworkProfile	बूलियन	(डिफ़ॉल्ट: "false") अगर नेटवर्क प्रोफ़ाइल चालू की जा सकती हों, तो 'सही' पर सेट करें.
supportsDisablingNetworkProfile	बूलियन	(डिफ़ॉल्ट: "false") अगर नेटवर्क प्रोफ़ाइल बंद की जा सकती हों, तो सही पर सेट करें.
supportsNetworkDownloadSpeedTest	बूलियन	(डिफ़ॉल्ट: false) अगर डाउनलोड करने की स्पीड की जांच की जा सकती है, तो 'सही है' पर सेट करें.
supportsNetworkUploadSpeedTest	बूलियन	(डिफ़ॉल्ट: false) अगर अपलोड करने की स्पीड की जांच की जा सकती है, तो 'सही' पर सेट करें.

उदाहरण

ऐसा नेटवर्क डिवाइस जिस पर मेहमान नेटवर्क, प्रोफ़ाइल, और स्पीड टेस्ट की सुविधा काम करती हो.

{
  "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	एमबी में नेटवर्क इस्तेमाल (मेगाबाइट). नेटवर्क का इस्तेमाल, मौजूदा बिलिंग अवधि के अंदर किया जाता है. इससे, नेटवर्क के इस्तेमाल की सीमा के हिसाब से निगरानी की जा सकती है.
networkUsageLimitMB	Number	नेटवर्क के इस्तेमाल की सीमा एमबी में (मेगाबाइट). नेटवर्क के इस्तेमाल की सीमा, मौजूदा बिलिंग अवधि के अंदर है.
networkUsageUnlimited	बूलियन	नेटवर्क के इस्तेमाल की कोई सीमा नहीं है. अगर इसे 'सही है' पर सेट किया जाता है, तो डिवाइस की स्थिति networkUsageLimitMB को अनदेखा कर दिया जाएगा.
lastNetworkDownloadSpeedTest	ऑब्जेक्ट	इसमें, नेटवर्क की हाल ही में डाउनलोड की गई स्पीड की जांच के नतीजे होते हैं.
downloadSpeedMbps	Number	नेटवर्क स्पीड की पिछली जांच में, डाउनलोड की स्पीड एमबीपीएस (मेगाबिट प्रति सेकंड) में.
unixTimestampSec	Integer	पिछली बार नेटवर्क की डाउनलोड स्पीड टेस्ट किए जाने के समय का यूनिक्स टाइमस्टैंप (Unix Epoch के बाद के सेकंड की संख्या).
status	String	यह बताता है कि पिछला नेटवर्क डाउनलोड स्पीड टेस्ट हो पाया था या नहीं. इस्तेमाल की जा सकने वाली वैल्यू: SUCCESS FAILURE
lastNetworkUploadSpeedTest	ऑब्जेक्ट	इसमें, नेटवर्क की हाल ही की अपलोड स्पीड की जांच के नतीजे शामिल होते हैं.
uploadSpeedMbps	Number	नेटवर्क स्पीड की पिछली जांच में, अपलोड की स्पीड एमबीपीएस (मेगाबिट प्रति सेकंड) में.
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
}

"बच्चों" वाला डिवाइस NetworkProfile बंद की गई.

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

डिवाइस COMMANDS

इस विशेषता वाले डिवाइस इन सुविधाओं के लिए काम कर सकते हैं EXECUTE से जुड़ी कार्रवाइयों के लिए, सभी कमांड इस्तेमाल किए जा सकते हैं. सीखने में EXECUTE इंटेंट को मैनेज करने के बारे में ज़्यादा जानने के लिए, देखें इंटेंट पूरा करना.

action.devices.commands.EnableDisableGuestNetwork

मेहमान नेटवर्क को चालू या बंद करें. उपयोगकर्ता की पुष्टि के लिए पिन का इस्तेमाल करना ज़रूरी है. अगर इन निर्देशों का इस्तेमाल करके सुरक्षा से जुड़े दूसरे डिवाइस बंद कर दिए जाते हैं, तो उपयोगकर्ता के घर की सुरक्षा पर असर पड़ सकता है.

इस निर्देश के लिए इन एट्रिब्यूट की ज़रूरत है:

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

अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
enable	बूलियन	ज़रूरी है. मेहमान नेटवर्क को चालू करने के लिए सही, मेहमान नेटवर्क को बंद करने के लिए गलत.

उदाहरण

मेहमान नेटवर्क चालू करें.

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

action.devices.commands.EnableDisableNetworkProfile

नेटवर्क प्रोफ़ाइल को चालू या बंद करें. उपयोगकर्ता की पुष्टि के लिए पिन का इस्तेमाल करना ज़रूरी है. अगर इन निर्देशों का इस्तेमाल करके सुरक्षा से जुड़े दूसरे डिवाइस बंद कर दिए जाते हैं, तो उपयोगकर्ता के घर की सुरक्षा पर असर पड़ सकता है.

इस निर्देश के लिए इन एट्रिब्यूट की ज़रूरत है:

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

अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
profile	String	ज़रूरी है. networkProfiles एट्रिब्यूट से प्रोफ़ाइल का नाम.
enable	बूलियन	ज़रूरी है. प्रोफ़ाइल को चालू करने के लिए सही, प्रोफ़ाइल बंद करने के लिए गलत.

उदाहरण

बच्चों के लिए इंटरनेट बंद करें.

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

मिलती-जुलती गड़बड़ियां

दी गई नेटवर्क प्रोफ़ाइल को कंट्रोल करते समय कोई गड़बड़ी हुई.

इस्तेमाल की जा सकने वाली वैल्यू:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

मेहमान नेटवर्क का पासवर्ड पाएं. उपयोगकर्ता की पुष्टि के लिए पिन का इस्तेमाल करना ज़रूरी है. अगर इन निर्देशों का इस्तेमाल करके सुरक्षा से जुड़े दूसरे डिवाइस बंद कर दिए जाते हैं, तो उपयोगकर्ता के घर की सुरक्षा पर असर पड़ सकता है.

इस निर्देश के लिए इन एट्रिब्यूट की ज़रूरत है:

{
  "supportsGettingGuestNetworkPassword": true
}

अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
कोई प्रॉपर्टी नहीं

उदाहरण

मेहमान के तौर पर सेट किए गए मेरे वाई-फ़ाई का पासवर्ड दिखाओ.

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

नतीजे

नतीजे	टाइप	ब्यौरा
guestNetworkPassword	String	ज़रूरी है. मेहमान नेटवर्क के लिए पासवर्ड.

उदाहरण

मेहमान के तौर पर सेट किए गए मेरे वाई-फ़ाई का पासवर्ड दिखाओ.

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

नेटवर्क की डाउनलोड और अपलोड करने की स्पीड की जांच करें.

इस निर्देश के लिए इन एट्रिब्यूट की ज़रूरत है:

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

अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
testDownloadSpeed	बूलियन	ज़रूरी है. यह बताता है कि डाउनलोड स्पीड की जांच की जानी चाहिए या नहीं.
testUploadSpeed	बूलियन	ज़रूरी है. यह बताता है कि अपलोड करने की स्पीड की जांच की जानी चाहिए या नहीं.
followUpToken	String	ज़रूरी है. फ़ॉलो-अप जवाब के लिए Google की ओर से दिया गया टोकन.

उदाहरण

वाई-फ़ाई की स्पीड कितनी है?

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

मिलती-जुलती गड़बड़ियां

स्पीड टेस्ट का अनुरोध करते समय कोई गड़बड़ी हुई.

इस्तेमाल की जा सकने वाली वैल्यू:

networkSpeedTestInProgress

फ़ॉलो-अप जवाब

इस विशेषता वाले डिवाइस पर ये नतीजे मिल सकते हैं EXECUTE कार्रवाई के तहत, फ़ॉलो-अप रिस्पॉन्स पेलोड. सीखने में फ़ॉलो-अप जवाबों को लागू करने के बारे में ज़्यादा जानने के लिए, स्मार्ट होम कार्रवाइयों के लिए सूचनाएं.

पेलोड में इनमें से कोई एक शामिल होता है:

सफल: networkDownloadSpeedMB

फ़ील्ड	टाइप	ब्यौरा
followUpToken	String	ज़रूरी है. मूल EXECUTE अनुरोध में टोकन दिया गया था.
status	String	ज़रूरी है. अनुरोध का नतीजा. इस्तेमाल की जा सकने वाली वैल्यू: SUCCESS
networkDownloadSpeedMbps	Number	ज़रूरी है. नेटवर्क की डाउनलोड स्पीड, मेगाबिट प्रति सेकंड में मापी जाती है.

सफल: networkUploadSpeedMB

फ़ील्ड	टाइप	ब्यौरा
followUpToken	String	ज़रूरी है. मूल EXECUTE अनुरोध में टोकन दिया गया था.
status	String	ज़रूरी है. अनुरोध का नतीजा. इस्तेमाल की जा सकने वाली वैल्यू: SUCCESS
networkUploadSpeedMbps	Number	ज़रूरी है. नेटवर्क अपलोड करने की स्पीड, मेगाबिट प्रति सेकंड में मापी जाती है.

सफल: networkDownloadSpeedMB और networkUploadSpeedMB

फ़ील्ड	टाइप	ब्यौरा
followUpToken	String	ज़रूरी है. मूल EXECUTE अनुरोध में टोकन दिया गया था.
status	String	ज़रूरी है. अनुरोध का नतीजा. इस्तेमाल की जा सकने वाली वैल्यू: SUCCESS
networkDownloadSpeedMbps	Number	ज़रूरी है. नेटवर्क की डाउनलोड स्पीड, मेगाबिट प्रति सेकंड में मापी जाती है.
networkUploadSpeedMbps	Number	ज़रूरी है. नेटवर्क अपलोड करने की स्पीड, मेगाबिट प्रति सेकंड में मापी जाती है.

अपलोड नहीं हुआ

फ़ील्ड	टाइप	ब्यौरा
followUpToken	String	ज़रूरी है. मूल EXECUTE अनुरोध में टोकन दिया गया था.
status	String	ज़रूरी है. अनुरोध का नतीजा. इस्तेमाल की जा सकने वाली वैल्यू: FAILURE
errorCode	String	ज़रूरी है. इस विशेषता के लिए वैल्यू, कोई भी गड़बड़ी कोड हो सकती है. जैसे, transientError.

उदाहरण

वाई-फ़ाई की स्पीड कितनी है? (फ़ॉलो-अप जवाब)

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

वाई-फ़ाई की स्पीड कितनी है? (फ़ेल होने पर फ़ॉलो-अप जवाब)

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

डिवाइस ERRORS

पूरी सूची देखें गड़बड़ियों और अपवाद के तौर पर मार्क किया जा सकता है.

दी गई नेटवर्क प्रोफ़ाइल को कंट्रोल करते समय कोई गड़बड़ी हुई.

इस्तेमाल की जा सकने वाली वैल्यू:

networkProfileNotRecognized

स्पीड टेस्ट का अनुरोध करते समय कोई गड़बड़ी हुई.

इस्तेमाल की जा सकने वाली वैल्यू:

networkSpeedTestInProgress