طرحواره ویژگی کنترل شبکه خانه هوشمند

action.devices.traits.NetworkControl - این trait متعلق به دستگاه‌هایی است که از گزارش داده‌های شبکه و انجام عملیات خاص شبکه پشتیبانی می‌کنند.

ویژگی‌های دستگاه

دستگاه‌هایی که این ویژگی را دارند، ممکن است ویژگی‌های زیر را به عنوان بخشی از عملیات SYNC گزارش دهند. برای کسب اطلاعات بیشتر در مورد مدیریت اهداف SYNC ، به بخش «تحقق اهداف» مراجعه کنید.

ویژگی‌ها نوع توضیحات
supportsEnablingGuestNetwork بولی

(پیش‌فرض: false )

اگر شبکه مهمان قابل فعال شدن باشد، روی درست تنظیم کنید.

supportsDisablingGuestNetwork بولی

(پیش‌فرض: false )

اگر شبکه مهمان قابل غیرفعال شدن باشد، روی درست تنظیم شود.

supportsGettingGuestNetworkPassword بولی

(پیش‌فرض: false )

اگر رمز عبور شبکه مهمان از طریق دستور GetGuestNetworkPassword قابل دسترسی باشد، روی true تنظیم کنید.

networkProfiles آرایه

نام‌های پروفایل شبکه پشتیبانی‌شده را نشان می‌دهد.

[ item, ... ] رشته

نام یک پروفایل شبکه که نشان‌دهنده گروهی از دستگاه‌های مرتبط است.

supportsEnablingNetworkProfile بولی

(پیش‌فرض: "false" )

اگر پروفایل‌های شبکه قابل فعال شدن باشند، روی درست تنظیم کنید.

supportsDisablingNetworkProfile بولی

(پیش‌فرض: "false" )

اگر بتوان پروفایل‌های شبکه را غیرفعال کرد، روی درست تنظیم کنید.

supportsNetworkDownloadSpeedTest بولی

(پیش‌فرض: false )

اگر بتوان تست سرعت دانلود را اجرا کرد، روی true تنظیم کنید.

supportsNetworkUploadSpeedTest بولی

(پیش‌فرض: false )

اگر بتوان تست سرعت آپلود را اجرا کرد، روی درست تنظیم کنید.

مثال‌ها

دستگاه شبکه‌ای که از شبکه مهمان، پروفایل‌ها و تست سرعت پشتیبانی می‌کند.

{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true,
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true,
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true,
  "supportsGettingGuestNetworkPassword": true,
  "networkProfiles": [
    "Kids"
  ]
}

وضعیت دستگاه

موجودیت‌هایی با این ویژگی ممکن است حالت‌های زیر را به عنوان بخشی از عملیات QUERY گزارش دهند. برای کسب اطلاعات بیشتر در مورد مدیریت اهداف QUERY ، به بخش «تحقق اهداف» مراجعه کنید.

ایالت‌ها نوع توضیحات
networkEnabled بولی

اینکه آیا شبکه اصلی فعال است یا خیر.

networkSettings شیء

شامل SSID شبکه اصلی است.

ssid رشته

الزامی است.

SSID شبکه.

guestNetworkEnabled بولی

اینکه آیا شبکه مهمان فعال است یا خیر.

guestNetworkSettings شیء

حاوی SSID شبکه مهمان است.

ssid رشته

الزامی است.

SSID شبکه.

numConnectedDevices عدد صحیح

تعداد دستگاه‌های متصل به شبکه.

networkUsageMB شماره

میزان مصرف شبکه بر حسب مگابایت. میزان مصرف شبکه در دوره صورتحساب فعلی است که می‌تواند برای نظارت بر محدودیت استفاده از شبکه در دوره صورتحساب مفید باشد.

networkUsageLimitMB شماره

محدودیت استفاده از شبکه بر حسب مگابایت. محدودیت استفاده از شبکه مربوط به دوره صورتحساب فعلی است.

networkUsageUnlimited بولی

آیا میزان استفاده از شبکه نامحدود است یا خیر. اگر این گزینه روی true تنظیم شده باشد، وضعیت دستگاه networkUsageLimitMB نادیده گرفته می‌شود.

lastNetworkDownloadSpeedTest شیء

شامل نتایج جدیدترین تست سرعت دانلود شبکه است.

downloadSpeedMbps شماره

سرعت دانلود بر حسب مگابیت بر ثانیه (Mbps) در آخرین تست سرعت شبکه.

unixTimestampSec عدد صحیح

مهر زمانی یونیکس (تعداد ثانیه‌ها از زمان آغاز یونیکس) مربوط به آخرین باری که تست سرعت دانلود شبکه انجام شده است.

status رشته

نشان می‌دهد که آیا آخرین تست سرعت دانلود شبکه موفقیت‌آمیز بوده یا خیر.

مقادیر پشتیبانی شده:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest شیء

شامل نتایج جدیدترین تست سرعت آپلود شبکه است.

uploadSpeedMbps شماره

سرعت آپلود بر حسب مگابیت بر ثانیه (Mbps) در آخرین تست سرعت شبکه.

unixTimestampSec عدد صحیح

مهر زمانی یونیکس (تعداد ثانیه‌ها از زمان آغاز یونیکس) مربوط به زمانی که آخرین تست سرعت آپلود شبکه انجام شده است.

status رشته

نشان می‌دهد که آیا آخرین تست سرعت آپلود شبکه موفقیت‌آمیز بوده یا خیر.

مقادیر پشتیبانی شده:

SUCCESS
FAILURE
networkSpeedTestInProgress بولی

(پیش‌فرض: false )

اینکه آیا در حال حاضر تست سرعت در حال اجرا است یا خیر.

networkProfilesState شیء

وضعیت برای پروفایل‌های شبکه. این شیء سطح بالا باید شامل جفت‌های کلید-مقدار باشد که در آن کلید، نام یکی از پروفایل‌های شبکه ذکر شده در ویژگی networkProfiles و مقدار، وضعیت مربوط به آن پروفایل است.

<string> شیء

شیء‌ای که وضعیت یک پروفایل شبکه‌ی مجزا را ذخیره می‌کند. مقدارِ key باید نام یکی از پروفایل‌های شبکه در ویژگی 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 بولی

الزامی است.

برای فعال کردن شبکه مهمان، مقدار True و برای غیرفعال کردن شبکه مهمان، مقدار false را وارد کنید.

مثال‌ها

شبکه مهمان را روشن کنید.

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

action.devices.commands.EnableDisableNetworkProfile

فعال یا غیرفعال کردن یک پروفایل شبکه. تأیید هویت ثانویه کاربر با پین باید استفاده شود. اگر سایر دستگاه‌های امنیتی از طریق این دستورات غیرفعال شوند، می‌توان امنیت خانه کاربر را تحت تأثیر قرار گرفته در نظر گرفت.

این دستور به ویژگی‌های زیر نیاز دارد: 
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

پارامترها

پارامترها نوع توضیحات
profile رشته

الزامی است.

نام پروفایل از ویژگی networkProfiles .

enable بولی

الزامی است.

برای فعال کردن پروفایل مقدار True و برای غیرفعال کردن پروفایل مقدار false را وارد کنید.

مثال‌ها

اینترنت را برای بچه‌ها خاموش کنید.

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

هنگام تلاش برای کنترل نمایه شبکه داده شده، خطایی روی داد.

مقادیر پشتیبانی شده:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

رمز عبور شبکه مهمان را دریافت کنید. تأیید هویت ثانویه کاربر با پین باید استفاده شود. اگر سایر دستگاه‌های امنیتی از طریق این دستورات غیرفعال شوند، می‌توان امنیت خانه کاربر را تحت تأثیر قرار داد.

این دستور به ویژگی‌های زیر نیاز دارد: 
{
  "supportsGettingGuestNetworkPassword": true
}

پارامترها

پارامترها نوع توضیحات

بدون ملک

مثال‌ها

رمز عبور وای‌فای مهمان من را نشان بده. 

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

نتایج

نتایج نوع توضیحات
guestNetworkPassword رشته

الزامی است.

رمز عبور برای شبکه مهمان.

مثال‌ها

رمز عبور وای‌فای مهمان من را نشان بده. 

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

سرعت دانلود و آپلود شبکه را آزمایش کنید.

این دستور به ویژگی‌های زیر نیاز دارد: 
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

پارامترها

پارامترها نوع توضیحات
testDownloadSpeed بولی

الزامی است.

نشان می‌دهد که آیا سرعت دانلود باید آزمایش شود یا خیر.

testUploadSpeed بولی

الزامی است.

نشان می‌دهد که آیا سرعت آپلود باید آزمایش شود یا خیر.

followUpToken رشته

الزامی است.

توکن ارائه شده توسط گوگل برای پاسخ‌های بعدی.

مثال‌ها

سرعت وای فایش چقدره؟ 

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

هنگام درخواست تست سرعت، خطایی روی داد.

مقادیر پشتیبانی شده:

networkSpeedTestInProgress

پاسخ‌های تکمیلی

دستگاه‌هایی که این ویژگی را دارند، ممکن است به عنوان بخشی از عملیات EXECUTE بار داده پاسخ پیگیری زیر را برگردانند. برای کسب اطلاعات بیشتر در مورد پیاده‌سازی پاسخ‌های پیگیری، به بخش اعلان‌ها برای اقدامات خانه هوشمند مراجعه کنید.

محموله شامل یکی از موارد زیر است:

موفقیت: سرعت دانلود شبکه مگابیت در ثانیه

فیلدها نوع توضیحات
followUpToken رشته

الزامی است.

توکن ارائه شده در درخواست EXECUTE اصلی.

status رشته

الزامی است.

نتیجه درخواست.

مقادیر پشتیبانی شده:

SUCCESS
networkDownloadSpeedMbps شماره

الزامی است.

سرعت دانلود شبکه بر حسب مگابیت بر ثانیه اندازه‌گیری می‌شود.

موفقیت: سرعت آپلود شبکه مگابیت در ثانیه

فیلدها نوع توضیحات
followUpToken رشته

الزامی است.

توکن ارائه شده در درخواست EXECUTE اصلی.

status رشته

الزامی است.

نتیجه درخواست.

مقادیر پشتیبانی شده:

SUCCESS
networkUploadSpeedMbps شماره

الزامی است.

سرعت آپلود شبکه بر حسب مگابیت بر ثانیه اندازه‌گیری می‌شود.

موفقیت: سرعت دانلود شبکه (networkDownloadSpeedMbps) و سرعت آپلود شبکه (networkUploadSpeedMbps)

فیلدها نوع توضیحات
followUpToken رشته

الزامی است.

توکن ارائه شده در درخواست EXECUTE اصلی.

status رشته

الزامی است.

نتیجه درخواست.

مقادیر پشتیبانی شده:

SUCCESS
networkDownloadSpeedMbps شماره

الزامی است.

سرعت دانلود شبکه بر حسب مگابیت بر ثانیه اندازه‌گیری می‌شود.

networkUploadSpeedMbps شماره

الزامی است.

سرعت آپلود شبکه بر حسب مگابیت بر ثانیه اندازه‌گیری می‌شود.

شکست

فیلدها نوع توضیحات
followUpToken رشته

الزامی است.

توکن ارائه شده در درخواست EXECUTE اصلی.

status رشته

الزامی است.

نتیجه درخواست.

مقادیر پشتیبانی شده:

FAILURE
errorCode رشته

الزامی است.

مقدار می‌تواند هر کد خطایی برای این trait باشد، برای مثال، 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