スマートホーム NetworkControl トレイト スキーマ

action.devices.traits.NetworkControl - このトレイトは、ネットワーク データの報告とネットワーク固有の操作の実行をサポートするデバイスに使用します。

デバイスの属性

このトレイトを持つデバイスは、以下をレポートすることがあります。 SYNC オペレーションの一部として使用できます。学習内容 SYNC インテントの処理の詳細については、以下をご覧ください。 インテント フルフィルメント。

属性 タイプ 説明
supportsEnablingGuestNetwork ブール値

（デフォルト: false）。

ゲスト ネットワークを有効にできる場合は true に設定します。
supportsDisablingGuestNetwork ブール値

（デフォルト: false）。

ゲスト ネットワークを無効にできる場合は true に設定します。
supportsGettingGuestNetworkPassword ブール値

（デフォルト: false）。

ゲスト ネットワークのパスワードが GetGuestNetworkPassword コマンドで取得できる場合は、true に設定します。
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 インテントの処理の詳細については、以下をご覧ください。 インテント フルフィルメント。

州 タイプ 説明
networkEnabled ブール値

メイン ネットワークが有効かどうか。
networkSettings オブジェクト

メイン ネットワークの SSID が含まれます。
ssid String

必須。

ネットワーク SSID。
guestNetworkEnabled ブール値

ゲスト ネットワークが有効かどうか。
guestNetworkSettings オブジェクト

ゲスト ネットワークの SSID が含まれます。
ssid String

必須。

ネットワーク SSID。
numConnectedDevices 整数

ネットワークに接続されているデバイスの数。
networkUsageMB 番号

ネットワーク使用量（MB（メガバイト）単位）。ネットワーク使用量が現在の請求対象期間内のものであるため、請求対象期間のネットワーク使用量の上限に関してモニタリングできます。
networkUsageLimitMB 番号

ネットワーク使用量の上限（MB（メガバイト）単位）。ネットワーク使用量の上限は、現在の請求対象期間内です。
networkUsageUnlimited ブール値

ネットワーク使用量が無制限かどうか。true に設定した場合、デバイスの状態 networkUsageLimitMB は無視されます。
lastNetworkDownloadSpeedTest オブジェクト

最新のネットワーク ダウンロード速度テストの結果が含まれています。
downloadSpeedMbps 番号

前回のネットワーク速度テストのダウンロード速度（Mbps（メガビット/秒）単位）。
unixTimestampSec 整数

前回のネットワーク ダウンロード速度テストが実行されたときの Unix タイムスタンプ（Unix エポックからの経過秒数）。
status String

前回のネットワーク ダウンロード速度テストが成功したか失敗したかを示します。

サポートされている値:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest オブジェクト

最新のネットワーク アップロード速度テストの結果が含まれます。
uploadSpeedMbps 番号

前回のネットワーク速度テストのアップロード速度（Mbps（メガビット/秒）単位）。
unixTimestampSec 整数

前回のネットワーク アップロード速度テストが実行されたときの Unix タイムスタンプ（Unix エポックからの経過秒数）。
status String

前回のネットワーク アップロード速度テストが成功したか失敗したかを示します。

サポートされている値:

SUCCESS
FAILURE
networkSpeedTestInProgress ブール値

（デフォルト: false）。

速度テストが現在実行中かどうか。
networkProfilesState オブジェクト

ネットワーク プロファイルの状態。この最上位オブジェクトには、Key-Value ペアが含まれている必要があります。キーは 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

ゲスト ネットワークを有効または無効にします。PIN による予備のユーザー確認を使用する必要があります。これらのコマンドで他のセキュリティ デバイスを無効にすると、ユーザーのホーム セキュリティに影響する可能性があります。

このコマンドには、次の属性が必要です。 
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

パラメータ

パラメータ タイプ 説明
enable ブール値

必須。

ゲスト ネットワークを有効にする場合は true、無効にする場合は false です。

例

ゲスト ネットワークを有効にします。

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

action.devices.commands.EnableDisableNetworkProfile

ネットワーク プロファイルを有効または無効にします。PIN による予備のユーザー確認を使用する必要があります。これらのコマンドで他のセキュリティ デバイスを無効にすると、ユーザーのホーム セキュリティに影響する可能性があります。

このコマンドには、次の属性が必要です。 
{
  "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

ゲスト ネットワークのパスワードを取得します。PIN による予備のユーザー確認を使用する必要があります。これらのコマンドで他のセキュリティ デバイスを無効にすると、ユーザーのホーム セキュリティに影響する可能性があります。

このコマンドには、次の属性が必要です。 
{
  "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
で確認できます。

フォローアップの回答

このトレイトを持つデバイスは、以下を返すことがあります。 EXECUTE オペレーションの一部としてのフォローアップ レスポンス ペイロード。学習内容 フォローアップ対応の実装について詳しくは、以下をご覧ください。 スマートホーム アクションの通知。

ペイロードには次のいずれかが含まれます。

成功: networkDownloadSpeedMbps

フィールド タイプ 説明
followUpToken String

必須。

元の EXECUTE リクエストで指定されたトークン。
status String

必須。

リクエストの結果。

サポートされている値:

SUCCESS
networkDownloadSpeedMbps 番号

必須。

ネットワーク ダウンロード速度（Mbps）。

成功: networkUploadSpeedMbps

フィールド タイプ 説明
followUpToken String

必須。

元の EXECUTE リクエストで指定されたトークン。
status String

必須。

リクエストの結果。

サポートされている値:

SUCCESS
networkUploadSpeedMbps 番号

必須。

ネットワークのアップロード速度（Mbps）。

成功: networkDownloadSpeedMbps と networkUploadSpeedMbps

フィールド タイプ 説明
followUpToken String

必須。

元の EXECUTE リクエストで指定されたトークン。
status String

必須。

リクエストの結果。

サポートされている値:

SUCCESS
networkDownloadSpeedMbps 番号

必須。

ネットワーク ダウンロード速度（Mbps）。
networkUploadSpeedMbps 番号

必須。

ネットワークのアップロード速度（Mbps）。

失敗

フィールド タイプ 説明
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"
    }
  }
}

デバイスエラー

詳しくは、 エラーと例外をご覧ください。

指定されたネットワーク プロファイルの制御中にエラーが発生しました。

サポートされている値:

networkProfileNotRecognized

速度テストのリクエスト中にエラーが発生しました。

サポートされている値:

networkSpeedTestInProgress