ThreadNetworkManagementTrait.NetworkInfo

class ThreadNetworkManagementTrait.NetworkInfo : ClusterStruct


Information about a Thread network.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

NetworkInfo(
    networkName: String,
    panId: UShort,
    extendedPanId: ULong,
    channel: UByte
)

Creates the NetworkInfo class.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

UByte

The channel of the Thread network.

ULong

The extended PAN ID of the Thread network.

String

The network name of the Thread network.

UShort

Public constructors

NetworkInfo

NetworkInfo(
    networkName: String = "",
    panId: UShort,
    extendedPanId: ULong,
    channel: UByte
)

Creates the NetworkInfo class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

channel

val channelUByte

The channel of the Thread network.

extendedPanId

val extendedPanIdULong

The extended PAN ID of the Thread network.

networkName

val networkNameString

The network name of the Thread network.

panId

val panIdUShort