स्मार्ट होम नेटवर्क कंट्रोल ट्रैट स्कीमा

action.devices.traits.NetworkControl - यह ट्रैट उन डिवाइसों से जुड़ा है जो नेटवर्क डेटा की रिपोर्टिंग करने और नेटवर्क से जुड़े खास ऑपरेशन करने की सुविधा देते हैं.

डिवाइस के एट्रिब्यूट

इस विशेषता वाले डिवाइस, 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

नेटवर्क की डाउनलोड स्पीड की पिछली बार जांच करने का यूनिक्स टाइमस्टैंप (यूनिक्स एपिक के बाद से सेकंड की संख्या).

status String

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

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

SUCCESS
FAILURE
lastNetworkUploadSpeedTest ऑब्जेक्ट

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

uploadSpeedMbps Number

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

unixTimestampSec Integer

नेटवर्क की अपलोड स्पीड की पिछली जांच कब की गई थी, इसका यूनिक्स टाइमस्टैंप (यूनिक्स एपिक के बाद से सेकंड की संख्या).

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

डिवाइस के लिए निर्देश

इस विशेषता वाले डिवाइस, 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