nl::Weave::Profiles::NetworkProvisioning

この名前空間には、Weave ネットワーク プロビジョニング プロファイル(3 つの Weave プロビジョニング プロファイルの 1 つ目のプロファイル)に対応する Weave 内のすべてのインターフェースが含まれます。

概要

インターフェースは、ステータス コード、メッセージ タイプ、データ要素タグ、その他の定数、サーバー オブジェクト、デリゲート オブジェクトを定義します。

Nest Weave ネットワーク プロビジョニング プロファイルは、デバイスがネットワークに接続できるようにプロビジョニングされた Weave デバイスのネットワーク インターフェース(802.15.4/Thread や 802.11/Wi-Fi など)を取得するためのデータを提供することに重点を置いています。

列挙型

@212{
  kStatusCode_UnknownNetwork = 1,
  kStatusCode_TooManyNetworks = 2,
  kStatusCode_InvalidNetworkConfiguration = 3,
  kStatusCode_UnsupportedNetworkType = 4,
  kStatusCode_UnsupportedWiFiMode = 5,
  kStatusCode_UnsupportedWiFiRole = 6,
  kStatusCode_UnsupportedWiFiSecurityType = 7,
  kStatusCode_InvalidState = 8,
  kStatusCode_TestNetworkFailed = 9,
  kStatusCode_NetworkConnectFailed = 10,
  kStatusCode_NoRouterAvailable = 11,
  kStatusCode_UnsupportedRegulatoryDomain = 12,
  kStatusCode_UnsupportedOperatingLocation = 13
}
enum
ネットワーク プロビジョニングのステータス コード。
@213 enum
ネットワーク プロビジョニングのメッセージのタイプ。
@214{
  kTag_Networks = 1,
  kTag_EnabledNetworks = 2,
  kTag_RendezvousMode = 3,
  kTag_NetworkInformation = 32,
  kTag_NetworkId = 33,
  kTag_NetworkType = 34,
  kTag_WirelessSignalStrength = 35,
  kTag_WiFiSSID = 64,
  kTag_WiFiMode = 65,
  kTag_WiFiRole = 66,
  kTag_WiFiSecurityType = 67,
  kTag_WiFiPreSharedKey = 68,
  kTag_ThreadExtendedPANId = 80,
  kTag_ThreadNetworkName = 81,
  kTag_ThreadNetworkKey = 82,
  kTag_ThreadMeshPrefix = 83,
  kTag_ThreadChannel = 84,
  kTag_ThreadPANId = 85,
  kTag_ThreadPSKc = 86,
  kTag_WirelessRegConfig_RegulatoryDomain = 1,
  kTag_WirelessRegConfig_OperatingLocation = 2,
  kTag_WirelessRegConfig_SupportedRegulatoryDomains = 3
}
enum
@215 enum
スレッドの PAN ID。
@216 enum
Thread チャンネル。
GetNetworkFlags enum
ネットワーク フラグを取得します。
NetworkType enum
ネットワークの種類。
RendezvousModeFlags enum
ランデブー モード フラグ。
WiFiMode enum
Wi-Fi 動作モード。
WiFiRole enum
デバイスの Wi-Fi ロール。
WiFiSecurityType enum
Wi-Fi セキュリティ モード。
WirelessOperatingLocation{
  kWirelessOperatingLocation_NotSpecified = 0x00,
  kWirelessOperatingLocation_Unknown = 0x01,
  kWirelessOperatingLocation_Indoors = 0x02,
  kWirelessOperatingLocation_Outdoors = 0x03
}
enum
デバイスの動作場所(ワイヤレスに関する規制規定に基づく)。

関数

ReplaceValue(char *& dest, const char *src)
ReplaceValue(uint8_t *& dest, uint32_t & destLen, const uint8_t *src, uint32_t srcLen)

クラス

nl::Weave::Profiles::NetworkProvisioning::NetworkInfo

NetworkProvisioning プロファイルを介して通信されるペイロードをシリアル化および逆シリアル化するためのユーティリティ クラス。ネットワークの検出と構成に関する情報をカプセル化します。

nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningDelegate

ネットワーク プロビジョニング操作を実装するためのデリゲート クラス。

nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer

ネットワーク プロビジョニング プロファイルを実装するためのサーバークラス。

nl::Weave::Profiles::NetworkProvisioning::WirelessRegConfig

無線通信規則の設定情報のコンテナ。

構造体

nl::Weave::Profiles::NetworkProvisioning::WirelessRegDomain

無線通信規制の分野を識別する 2 文字のコード。

列挙型

@212

 @212

ネットワーク プロビジョニングのステータス コード。

プロパティ
kStatusCode_InvalidNetworkConfiguration

指定したネットワーク構成は無効です。

kStatusCode_InvalidState

現在の状態ではネットワーク プロビジョニング操作を実行できませんでした。

kStatusCode_NetworkConnectFailed

指定したネットワークへの接続に失敗しました。

kStatusCode_NoRouterAvailable

適切なネットワーク ルーターが見つかりませんでした。

kStatusCode_TestNetworkFailed

指定したネットワークの接続テストが失敗しました。

kStatusCode_TooManyNetworks

プロビジョニングされたネットワークの数が上限に達しました。

kStatusCode_UnknownNetwork

指定されたネットワーク ID のプロビジョニング済みネットワークが見つかりませんでした。

kStatusCode_UnsupportedNetworkType

指定されたネットワークの種類は不明であるか、サポートされていません。

kStatusCode_UnsupportedOperatingLocation

指定したワイヤレスの動作場所がサポートされていません。

kStatusCode_UnsupportedRegulatoryDomain

指定されたワイヤレス通信規制ドメインがサポートされていません。

kStatusCode_UnsupportedWiFiMode

指定された Wi-Fi モードはサポートされていません。

kStatusCode_UnsupportedWiFiRole

指定された Wi-Fi ロールはサポートされていません。

kStatusCode_UnsupportedWiFiSecurityType

指定された Wi-Fi セキュリティの種類はサポートされていません。

@213

 @213

ネットワーク プロビジョニングのメッセージのタイプ。

@214

 @214

ネットワーク プロビジョニング データ要素タグ。

プロパティ
kTag_EnabledNetworks

[ 配列 ] デバイスで現在有効になっているネットワークを識別する NetworkId の配列。

kTag_NetworkId

[ uint, 32-bit max ] プロビジョニングされたネットワークを一意に識別する整数。

kTag_NetworkInformation

[ struct ] ネットワークに関する情報を含む構造体。

kTag_NetworkType

[ uint, 8-bit max ] ネットワークの種類を識別する符号なし整数値。

kTag_Networks

[ 配列 ] NetworkConfiguration 構造体の配列。

kTag_RendezvousMode

[ uint ] 現在アクティブなランデブー モードを示すビット フィールド。

kTag_ThreadChannel

[ uint, 8-bit max ] スレッド チャンネル番号(オプション)。

kTag_ThreadExtendedPANId

[ バイト文字列 ] スレッド拡張 PAN ID。

kTag_ThreadMeshPrefix

[ バイト文字列、正確に 8 バイト ] スレッド メッシュの IPv6 /64 接頭辞(省略可)。

kTag_ThreadNetworkKey

[ bytes string ] Thread のマスター ネットワーク キー。

kTag_ThreadNetworkName

[ UTF-8 文字列 ] Thread ネットワークの名前を含む UTF-8 文字列。

kTag_ThreadPANId

[ uint, 16-bit max ] スレッドの PAN ID(省略可)。

kTag_ThreadPSKc

[ uint, 16-bit max ] スレッド PSKc(オプション)。

kTag_WiFiMode

[ uint, 8-bit max ] Wi-Fi ネットワークの動作モードを識別する整数値。

kTag_WiFiPreSharedKey

[ byte string ] WiFi パスワード/事前共有キーを含むバイト文字列。

kTag_WiFiRole

[ uint, 8-bit max ] Wi-Fi ネットワークでデバイスが果たす役割を示す整数。

kTag_WiFiSSID

[ UTF-8 文字列 ] Wi-Fi SSID を含む文字列。

kTag_WiFiSecurityType

[ uint, 8-bit max ] Wi-Fi ネットワークで使用されているセキュリティの種類を識別する整数値。

kTag_WirelessRegConfig_OperatingLocation

[ uint 列挙型、最大 8 ビット ] 無線規制規則に関連する動作場所。

kTag_WirelessRegConfig_RegulatoryDomain

[ UTF-8 文字列, len 2 ] ワイヤレス通信の規制ドメイン。

kTag_WirelessRegConfig_SupportedRegulatoryDomains

[ 文字列 len 2 の配列 ] サポート規制ドメインのリスト。

kTag_WirelessSignalStrength

[ int, 16-bit max ] ワイヤレス ネットワークの電波強度を dBm 単位で示す符号付き整数値。

@215

 @215

スレッドの PAN ID。

@216

 @216

Thread チャンネル。

GetNetworkFlags

 GetNetworkFlags

ネットワーク フラグを取得します。

NetworkType

 NetworkType

ネットワークの種類。

RendezvousModeFlags

 RendezvousModeFlags

ランデブー モード フラグ。

WiFiMode

 WiFiMode

Wi-Fi 動作モード。

WiFiRole

 WiFiRole

デバイスの Wi-Fi ロール。

WiFiSecurityType

 WiFiSecurityType

Wi-Fi セキュリティ モード。

WirelessOperatingLocation

 WirelessOperatingLocation

デバイスの動作場所(ワイヤレスに関する規制規定に基づく)。

プロパティ
kWirelessOperatingLocation_Indoors

屋内で操作する。

デバイスの想定される動作場所が屋内であることを示します。

kWirelessOperatingLocation_NotSpecified

予約済みの値。

有線では送信できません。

kWirelessOperatingLocation_Outdoors

屋外で運用します。

デバイスの想定される動作場所が屋外であることを示します。

kWirelessOperatingLocation_Unknown

営業地域が不明です。

デバイスの想定される動作場所が不明であるか、時間の経過とともに変化する可能性があることを示します。

関数

ReplaceValue

WEAVE_ERROR ReplaceValue(
  char *& dest,
  const char *src
)

ReplaceValue

WEAVE_ERROR ReplaceValue(
  uint8_t *& dest,
  uint32_t & destLen,
  const uint8_t *src,
  uint32_t srcLen
)