nl::Weave::DeviceLayer::Internal::DeviceNetworkInfo

Summary

Public types
`@401`	enum
`NetworkType_t`	typedef `::nl::Weave::Profiles::NetworkProvisioning::NetworkType`
`WiFiMode_t`	typedef `::nl::Weave::Profiles::NetworkProvisioning::WiFiMode`
`WiFiRole_t`	typedef `::nl::Weave::Profiles::NetworkProvisioning::WiFiRole`
`WiFiSecurityType_t`	typedef `::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType`

Public attributes
`FieldPresent`	`struct nl::Weave::DeviceLayer::Internal::DeviceNetworkInfo::@402`
`NetworkId`	`uint32_t` The network id assigned to the network by the device.
`NetworkId`	`bool` True if the NetworkId field is present.
`NetworkType`	`NetworkType_t` The type of network.
`ThreadChannel`	`uint8_t` The Thread channel (currently [11..26]), or kThreadChannel_NotSpecified.
`ThreadExtendedPANId[kThreadExtendedPANIdLength]`	`uint8_t` The Thread extended PAN ID.
`ThreadExtendedPANId`	`bool` True if the ThreadExtendedPANId field is present.
`ThreadMeshPrefix[kThreadMeshPrefixLength]`	`uint8_t` The Thread mesh prefix.
`ThreadMeshPrefix`	`bool` True if the ThreadMeshPrefix field is present.
`ThreadNetworkKey[kThreadNetworkKeyLength]`	`uint8_t` The Thread master network key (NOT NULL-terminated).
`ThreadNetworkKey`	`bool` True if the ThreadNetworkKey field is present.
`ThreadNetworkName[kMaxThreadNetworkNameLength+1]`	`char` The Thread network name as a NULL-terminated string.
`ThreadPANId`	`uint32_t` The 16-bit Thread PAN ID, or kThreadPANId_NotSpecified.
`ThreadPSKc[kThreadPSKcLength]`	`uint8_t` The Thread pre-shared commissioner key (NOT NULL-terminated).
`ThreadPSKc`	`bool` True if the ThreadPSKc field is present.
`WiFiKey[kMaxWiFiKeyLength]`	`uint8_t` The WiFi key (NOT NULL-terminated).
`WiFiKeyLen`	`uint8_t` The length in bytes of the WiFi key.
`WiFiMode`	`WiFiMode_t` The operating mode of the WiFi network.
`WiFiRole`	`WiFiRole_t` The role played by the device on the WiFi network.
`WiFiSSID[kMaxWiFiSSIDLength+1]`	`char` The WiFi SSID as a NULL-terminated string.
`WiFiSecurityType`	`WiFiSecurityType_t` The WiFi security type.
`WirelessSignalStrength`	`int16_t` The signal strength of the network, or INT16_MIN if not available/applicable.

Public functions
`Decode(::nl::Weave::TLV::TLVReader & reader)`	`WEAVE_ERROR`
`Encode(::nl::Weave::TLV::TLVWriter & writer) const`	`WEAVE_ERROR`
`MergeTo(DeviceNetworkInfo & dest)`	`WEAVE_ERROR`
`Reset()`	`void`

Public static functions
`EncodeArray(nl::Weave::TLV::TLVWriter & writer, const DeviceNetworkInfo *elems, size_t count)`	`WEAVE_ERROR`

Public types

@401

 @401

NetworkType_t

::nl::Weave::Profiles::NetworkProvisioning::NetworkType NetworkType_t

WiFiMode_t

::nl::Weave::Profiles::NetworkProvisioning::WiFiMode WiFiMode_t

WiFiRole_t

::nl::Weave::Profiles::NetworkProvisioning::WiFiRole WiFiRole_t

WiFiSecurityType_t

::nl::Weave::Profiles::NetworkProvisioning::WiFiSecurityType WiFiSecurityType_t

Public attributes

FieldPresent

struct nl::Weave::DeviceLayer::Internal::DeviceNetworkInfo::@402 FieldPresent

NetworkId

uint32_t NetworkId

The network id assigned to the network by the device.

NetworkId

bool NetworkId

True if the NetworkId field is present.

NetworkType

NetworkType_t NetworkType

The type of network.

ThreadChannel

uint8_t ThreadChannel

The Thread channel (currently [11..26]), or kThreadChannel_NotSpecified.

ThreadExtendedPANId

uint8_t ThreadExtendedPANId[kThreadExtendedPANIdLength]

The Thread extended PAN ID.

ThreadExtendedPANId

bool ThreadExtendedPANId

True if the ThreadExtendedPANId field is present.

ThreadMeshPrefix

uint8_t ThreadMeshPrefix[kThreadMeshPrefixLength]

The Thread mesh prefix.

ThreadMeshPrefix

bool ThreadMeshPrefix

True if the ThreadMeshPrefix field is present.

ThreadNetworkKey

uint8_t ThreadNetworkKey[kThreadNetworkKeyLength]

The Thread master network key (NOT NULL-terminated).

ThreadNetworkKey

bool ThreadNetworkKey

True if the ThreadNetworkKey field is present.

ThreadNetworkName

char ThreadNetworkName[kMaxThreadNetworkNameLength+1]

The Thread network name as a NULL-terminated string.

ThreadPANId

uint32_t ThreadPANId

The 16-bit Thread PAN ID, or kThreadPANId_NotSpecified.

ThreadPSKc

uint8_t ThreadPSKc[kThreadPSKcLength]

The Thread pre-shared commissioner key (NOT NULL-terminated).

ThreadPSKc

bool ThreadPSKc

True if the ThreadPSKc field is present.

WiFiKey

uint8_t WiFiKey[kMaxWiFiKeyLength]

The WiFi key (NOT NULL-terminated).

WiFiKeyLen

uint8_t WiFiKeyLen

The length in bytes of the WiFi key.

WiFiMode

WiFiMode_t WiFiMode

The operating mode of the WiFi network.

WiFiRole

WiFiRole_t WiFiRole

The role played by the device on the WiFi network.

WiFiSSID

char WiFiSSID[kMaxWiFiSSIDLength+1]

The WiFi SSID as a NULL-terminated string.

WiFiSecurityType

WiFiSecurityType_t WiFiSecurityType

The WiFi security type.

WirelessSignalStrength

int16_t WirelessSignalStrength

The signal strength of the network, or INT16_MIN if not available/applicable.

Public functions

Decode

WEAVE_ERROR Decode(
  ::nl::Weave::TLV::TLVReader & reader
)

Encode

WEAVE_ERROR Encode(
  ::nl::Weave::TLV::TLVWriter & writer
) const

MergeTo

WEAVE_ERROR MergeTo(
  DeviceNetworkInfo & dest
)

Reset

void Reset()

Public static functions

EncodeArray

WEAVE_ERROR EncodeArray(
  nl::Weave::TLV::TLVWriter & writer,
  const DeviceNetworkInfo *elems,
  size_t count
)