Smart Home NetworkControl Trait Schema

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 String

ज़रूरी है.

नेटवर्क का SSID.
guestNetworkEnabled बूलियन

मेहमान उपयोगकर्ता के लिए नेटवर्क चालू है या नहीं.
guestNetworkSettings ऑब्जेक्ट

इसमें मेहमान नेटवर्क का एसएसआईडी होता है.
ssid String

ज़रूरी है.

नेटवर्क का SSID.
numConnectedDevices Integer

नेटवर्क से कनेक्ट किए गए डिवाइसों की संख्या.
networkUsageMB Number

नेटवर्क के इस्तेमाल की जानकारी, एमबी (मेगाबाइट) में. नेटवर्क के इस्तेमाल की यह जानकारी, बिलिंग की मौजूदा अवधि के लिए होती है. इससे बिलिंग की अवधि के दौरान नेटवर्क के इस्तेमाल की सीमा पर नज़र रखने में मदद मिलती है.
networkUsageLimitMB Number

नेटवर्क इस्तेमाल करने की सीमा एमबी (मेगाबाइट) में. नेटवर्क के इस्तेमाल की सीमा, मौजूदा बिलिंग अवधि के दौरान की है.
networkUsageUnlimited बूलियन

क्या नेटवर्क के इस्तेमाल की कोई सीमा नहीं है. अगर इसे 'सही है' पर सेट किया जाता है, तो डिवाइस की स्थिति networkUsageLimitMB को अनदेखा कर दिया जाएगा.
lastNetworkDownloadSpeedTest ऑब्जेक्ट

इस कुकी में, नेटवर्क की डाउनलोड स्पीड की हाल ही की जांच के नतीजे शामिल होते हैं.
downloadSpeedMbps Number

नेटवर्क की स्पीड की पिछली जांच में, डाउनलोड स्पीड को एमबीपीएस (मेगाबिट प्रति सेकंड) में दिखाया जाता है.
unixTimestampSec Integer

यह यूनीक्स टाइमस्टैंप है. यह बताता है कि पिछली बार नेटवर्क की डाउनलोड स्पीड की जांच कब की गई थी. यूनीक्स टाइमस्टैंप, यूनीक्स इपॉक के बाद से गुज़रे हुए सेकंड की संख्या होती है.
status String

इससे पता चलता है कि नेटवर्क की डाउनलोड करने की रफ़्तार की जाँच पूरी हुई या नहीं.

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

SUCCESS
FAILURE
lastNetworkUploadSpeedTest ऑब्जेक्ट

इस कुकी में, नेटवर्क की अपलोड करने की स्पीड की हाल ही की जांच के नतीजे शामिल होते हैं.
uploadSpeedMbps Number

नेटवर्क की स्पीड की पिछली जांच में अपलोड स्पीड, एमबीपीएस (मेगाबिट प्रति सेकंड) में.
unixTimestampSec Integer

यह Unix टाइमस्टैंप है. यह बताता है कि पिछली बार नेटवर्क की अपलोड करने की रफ़्तार की जाँच कब की गई थी. 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
}

"बच्चों" के लिए नेटवर्क प्रोफ़ाइल की सुविधा बंद होने पर डिवाइस पर.

{
  "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 बूलियन

ज़रूरी है.

मेहमान उपयोगकर्ता के लिए नेटवर्क को चालू करने के लिए सही और बंद करने के लिए गलत चुनें.

उदाहरण

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

{
  "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 ऑपरेशन के तहत फ़ॉलो-अप रिस्पॉन्स का यह पेलोड दिखा सकते हैं. फ़ॉलो-अप रिस्पॉन्स लागू करने के बारे में ज़्यादा जानने के लिए, स्मार्ट होम डिवाइसों के लिए उपलब्ध कार्रवाइयों से जुड़ी सूचनाएं देखें.

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

सफलता: networkDownloadSpeedMbps

फ़ील्ड टाइप ब्यौरा
followUpToken String

ज़रूरी है.

EXECUTE के मूल अनुरोध में दिया गया टोकन.
status String

ज़रूरी है.

अनुरोध का नतीजा.

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

SUCCESS
networkDownloadSpeedMbps Number

ज़रूरी है.

नेटवर्क की डाउनलोड स्पीड, मेगाबिट प्रति सेकंड में मापी जाती है.

सफलता: networkUploadSpeedMbps

फ़ील्ड टाइप ब्यौरा
followUpToken String

ज़रूरी है.

EXECUTE के मूल अनुरोध में दिया गया टोकन.
status String

ज़रूरी है.

अनुरोध का नतीजा.

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

SUCCESS
networkUploadSpeedMbps Number

ज़रूरी है.

नेटवर्क की अपलोड स्पीड, मेगाबिट प्रति सेकंड में मापी जाती है.

सफलता: networkDownloadSpeedMbps और networkUploadSpeedMbps

फ़ील्ड टाइप ब्यौरा
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"
    }
  }
}

डिवाइस से जुड़ी गड़बड़ियां

गड़बड़ियों और अपवादों की पूरी सूची देखें.

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

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

networkProfileNotRecognized

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

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

networkSpeedTestInProgress