struct Matter::Cluster::Definitions::NetworkCommissioning::NetworkInformation

Included Modules

Defined in:

matter/cluster/definitions/network_commissioning.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(network_id : Slice(UInt8), connected : Bool) #

[View source]
def self.new(any : TLV::Any) #

[View source]

Class Method Detail

def self.from_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian) #

[View source]
def self.from_slice(bytes : Bytes) #

[View source]
def self.from_tlv(any : TLV::Any) #

[View source]
def self.from_tlv(data : Bytes) #

[View source]

Instance Method Detail

def connected : Bool #

This field shall indicate the connected status of the associated network, where "connected" means currently linked to the network technology (e.g. Associated for a Wi-Fi network, media connected for an Ethernet network).


[View source]
def connected=(connected : Bool) #

This field shall indicate the connected status of the associated network, where "connected" means currently linked to the network technology (e.g. Associated for a Wi-Fi network, media connected for an Ethernet network).


[View source]
def network_id : Slice(UInt8) #

Every network is uniquely identified (for purposes of commissioning) by a NetworkID mapping to the following technology-specific properties:

• SSID for Wi-Fi

• Extended PAN ID for Thread

• Network interface instance name at operating system (or equivalent unique name) for Ethernet.

The semantics of the NetworkID field therefore varies between network types accordingly. It contains SSID for Wi-Fi networks, Extended PAN ID (XPAN ID) for Thread networks and netif name for Ethernet networks.

NOTE

SSID in Wi-Fi is a collection of 1-32 bytes, the text encoding of which is not specified. Implementations must be careful to support reporting byte strings without requiring a particular encoding for transfer. Only the commissioner should try to potentially decode the bytes. The most common encoding is UTF-8, however this is just a convention. Some configurations may use Latin-1 or other character sets. A commissioner may decode using UTF-8, replacing encoding errors with "?" at the application level while retaining the underlying representation.

XPAN ID is a big-endian 64-bit unsigned number, represented on the first 8 octets of the octet string.


[View source]
def network_id=(network_id : Slice(UInt8)) #

Every network is uniquely identified (for purposes of commissioning) by a NetworkID mapping to the following technology-specific properties:

• SSID for Wi-Fi

• Extended PAN ID for Thread

• Network interface instance name at operating system (or equivalent unique name) for Ethernet.

The semantics of the NetworkID field therefore varies between network types accordingly. It contains SSID for Wi-Fi networks, Extended PAN ID (XPAN ID) for Thread networks and netif name for Ethernet networks.

NOTE

SSID in Wi-Fi is a collection of 1-32 bytes, the text encoding of which is not specified. Implementations must be careful to support reporting byte strings without requiring a particular encoding for transfer. Only the commissioner should try to potentially decode the bytes. The most common encoding is UTF-8, however this is just a convention. Some configurations may use Latin-1 or other character sets. A commissioner may decode using UTF-8, replacing encoding errors with "?" at the application level while retaining the underlying representation.

XPAN ID is a big-endian 64-bit unsigned number, represented on the first 8 octets of the octet string.


[View source]
def to_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian) : Nil #

[View source]
def to_slice : Bytes #

[View source]
def to_tlv(outer_tag : Nil | UInt8 | Tuple(UInt16, UInt16) | Tuple(UInt16, UInt16, UInt16) = nil) : TLV::Any #

[View source]