nl:: Weave:: Profiles:: NetworkProvisioning
此命名空间包括 Weave 网络配置配置文件中的所有接口,这是三个 Weave 预配配置文件中的第一个。
摘要
接口定义了状态代码、消息类型、数据元素标记、其他常量、服务器对象和代理对象。
Nest Weave 网络配置文件专门用于为 Weave 设备提供用于获取网络接口的数据,例如 802.15.4/Thread 和 802.11/Wi-Fi,从而让设备可以加入这些网络。
函数 |
|
---|---|
ReplaceValue(char *& dest, const char *src)
|
|
ReplaceValue(uint8_t *& dest, uint32_t & destLen, const uint8_t *src, uint32_t srcLen)
|
类 |
|
---|---|
nl:: |
一种实用程序类,用于对通过 NetworkProvisioning 配置文件传达的载荷进行序列化和反序列化:它封装了与检测和配置网络相关的信息。 |
nl:: |
用于实现网络配置操作的代理类。 |
nl:: |
用于实现网络预配配置文件的服务器类。 |
nl:: |
用于存放无线监管配置信息的容器。 |
结构体 |
|
---|---|
nl:: |
由 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
|
[ 数组 ] NetworkIds 数组,用于标识设备上当前启用的网络。 |
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
|
[ byte string ] 线程扩展 PAN ID。 |
kTag_ThreadMeshPrefix
|
[ 字节字符串,恰好 8 字节 ] 线程网格 IPv6 /64 前缀(可选)。 |
kTag_ThreadNetworkKey
|
[字节字符串 ] 线程主网络键。 |
kTag_ThreadNetworkName
|
[UTF-8 字符串 ] 包含 Thread 网络名称的 UTF-8 字符串。 |
kTag_ThreadPANId
|
[ uint, 16-bit max ] 线程 PAN ID(可选)。 |
kTag_ThreadPSKc
|
[ uint, 16-bit max ] Thread PSKc(可选)。 |
kTag_WiFiMode
|
[ uint, 8-bit max ] 一个整数,用于标识 Wi-Fi 网络的操作模式。 |
kTag_WiFiPreSharedKey
|
[字节字符串 ] 包含 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 Enum, 8-bit max ] 与无线监管规则相关的工作地点。 |
kTag_WirelessRegConfig_RegulatoryDomain
|
[UTF-8 字符串, len 2 ] 无线监管网域。 |
kTag_WirelessRegConfig_SupportedRegulatoryDomains
|
[一组字符串 2 ] 支持监管网域的列表。 |
kTag_WirelessSignalStrength
|
[ int, 16-bit max ] 有符号整数值,表示无线网络的信号强度(以 dBm 为单位)。 |
@215
@215
线程 PAN ID。
@216
@216
线程渠道。
GetNetworkFlags
GetNetworkFlags
获取网络标志。
NetworkType
NetworkType
网络类型。
RendezvousMode 标志
RendezvousModeFlags
配对模式标志。
Wi-Fi 模式
WiFiMode
Wi-Fi 操作模式。
WiFi 角色
WiFiRole
设备 Wi-Fi 角色。
无线操作位置
WirelessOperatingLocation
设备运行位置,与无线监管规则相关。
属性 | |
---|---|
kWirelessOperatingLocation_Indoors
|
在室内操作。 表示设备的预期运行位置在室内。 |
kWirelessOperatingLocation_NotSpecified
|
预留值。 不得通过无线方式发送。 |
kWirelessOperatingLocation_Outdoors
|
在室外运行。 表示设备的预期运行位置在室外。 |
kWirelessOperatingLocation_Unknown
|
工作地点未知。 表明设备的预期运行位置未知,或可能会随时间发生变化。 |
函数
替换值
WEAVE_ERROR ReplaceValue( char *& dest, const char *src )
替换值
WEAVE_ERROR ReplaceValue( uint8_t *& dest, uint32_t & destLen, const uint8_t *src, uint32_t srcLen )