nl::Weave::Profiles::NetworkProvisioning

這個命名空間包含 Weave 針對 Weave 網路佈建設定檔的所有介面,也就是三個 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
}
列舉
網路佈建狀態碼。
@213 列舉
網路佈建訊息類型。
@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
}
列舉
@215 列舉
執行緒永久帳號 ID。
@216 列舉
討論串頻道。
GetNetworkFlags 列舉
取得網路旗標。
NetworkType 列舉
網路類型。
RendezvousModeFlags 列舉
模式標幟。
WiFiMode 列舉
Wi-Fi 作業模式。
WiFiRole 列舉
裝置 Wi-Fi 角色。
WiFiSecurityType 列舉
Wi-Fi 安全模式。
WirelessOperatingLocation{
  kWirelessOperatingLocation_NotSpecified = 0x00,
  kWirelessOperatingLocation_Unknown = 0x01,
  kWirelessOperatingLocation_Indoors = 0x02,
  kWirelessOperatingLocation_Outdoors = 0x03
}
列舉
與無線法規相關的裝置營運位置。

函式

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

無線法規設定資訊的容器。

Structs

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

雙字元代碼,用於識別無線法規網域。

列舉

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 位元最大值 ] 用於識別已佈建網路的整數。

kTag_NetworkInformation

[ 結構 ] 包含網路資訊的結構。

kTag_NetworkType

[ uint, 8 位元最大值 ] 表示網路類型的無正負號整數值。

kTag_Networks

[陣列 ] 一組 NetworkConfiguration 結構。

kTag_RendezvousMode

[ uint ] 指出目前使用中模式模式的位元欄位。

kTag_ThreadChannel

[ uint,最大 8 位元 ] 執行緒頻道編號 (選填)。

kTag_ThreadExtendedPANId

[ byte string ] 執行緒擴充永久帳號 ID。

kTag_ThreadMeshPrefix

[位元組字串,正好是 8 個位元組 ] 執行緒網格 IPv6 /64 前置字元 (選填)。

kTag_ThreadNetworkKey

[位元組字串 ] Thread 主要網路金鑰。

kTag_ThreadNetworkName

[ UTF-8 字串 ] 包含 Thread 網路名稱的 UTF-8 字串。

kTag_ThreadPANId

[ uint,最大 16 位元 ] 執行緒永久帳號 ID (選用)。

kTag_ThreadPSKc

[ uint,最大 16 位元 ] Thread PSKc (選用)。

kTag_WiFiMode

[ uint, 8 位元最大值 ] 用整數表示 Wi-Fi 網路的運作模式,

kTag_WiFiPreSharedKey

[ 位元組字串 ] 包含 WiFi 密碼/預先共用金鑰的位元組字串。

kTag_WiFiRole

[ uint, 8 位元最大值 ] 一個整數,用來表示裝置在 Wi-Fi 網路中扮演的角色。

kTag_WiFiSSID

[ UTF-8 string ] 包含 Wi-Fi SSID 的字串。

kTag_WiFiSecurityType

[ uint, 8 位元最大值 ] 這個整數值,用於識別 WiFi 網路使用的安全性類型。

kTag_WirelessRegConfig_OperatingLocation

[ uint enum, 8-bit max ] 與無線法規規則相關的營運地點。

kTag_WirelessRegConfig_RegulatoryDomain

[ UTF-8 string, len 2 ] 無線法規網域。

kTag_WirelessRegConfig_SupportedRegulatoryDomains

[Array of string len 2 ] 支援法規網域清單。

kTag_WirelessSignalStrength

[ int, 16-bit max ] 整數值 (以 dBm 為單位) 表示無線網路的訊號強度,此為帶正負號的整數。

215 次

 @215

執行緒永久帳號 ID。

216 次

 @216

討論串頻道。

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
)