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 列舉
「Rendezvous Mode」旗標。
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

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

結構

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 ] 用於識別網路類型的無正負號整數值。

kTag_Networks

[陣列 ] NetworkConfiguration 結構的陣列。

kTag_RendezvousMode

[ uint ] 這個位元欄位代表目前啟用的慢速模式。

kTag_ThreadChannel

[ uint, 8-bit ] Thread 通道號碼 (選填)。

kTag_ThreadExtendedPANId

[ byte string ] 執行緒延伸 PAN ID。

kTag_ThreadMeshPrefix

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

kTag_ThreadNetworkKey

[位元組字串 ] 執行緒主網路金鑰。

kTag_ThreadNetworkName

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

kTag_ThreadPANId

[ uint,最多 16 位元 ] Thread PAN ID (選填)。

kTag_ThreadPSKc

[ uint, 16 位元上限 ] Thread PSKc (選用)。

kTag_WiFiMode

[ uint, 8-bit max ] 整數用於表示 Wi-Fi 網路的作業模式。

kTag_WiFiPreSharedKey

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

kTag_WiFiRole

[ uint, 8-bit ] 整數,代表裝置在 Wi-Fi 網路中扮演的角色。

kTag_WiFiSSID

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

kTag_WiFiSecurityType

[ uint, 8-bit ] 整數值,用於識別 Wi-Fi 網路使用的安全性類型。

kTag_WirelessRegConfig_OperatingLocation

[ uint enum, 8-bit max ] 作業位置與無線法規規則相關。

kTag_WirelessRegConfig_RegulatoryDomain

[ UTF-8 string, len 2 ] 無線監管網域。

kTag_WirelessRegConfig_SupportedRegulatoryDomains

[ string len 2 ] 支援監管網域清單。

kTag_WirelessSignalStrength

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

@215

 @215

討論串永久帳號 ID。

@216

 @216

執行緒頻道。

GetNetworkFlags

 GetNetworkFlags

取得網路標記。

NetworkType

 NetworkType

聯播網類型。

RendezvousModeFlags

 RendezvousModeFlags

「Rendezvous Mode」旗標。

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
)