struct

Matter::Cluster::Definitions::GeneralDiagnostics::NetworkInterface

Inherits TLV::Serializable < Struct < Value < Object

This structure describes a network interface supported by the Node, as provided in the NetworkInterfaces attribute.

Constructors

new(any : TLV::Any)

Class methods

from_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian)

from_slice(bytes : Bytes)

from_tlv(any : TLV::Any)

from_tlv(data : Bytes)

Instance methods

hardware_address

This field shall contain the current link-layer address for a 802.3 or IEEE 802.11-2020 network interface and contain the current extended MAC address for a 802.15.4 interface. The byte order of the octstr shall be in wire byte order. For addresses values less than 64 bits, the first two bytes shall be zero.

hardware_address=(hardware_address : Slice(UInt8))

This field shall contain the current link-layer address for a 802.3 or IEEE 802.11-2020 network interface and contain the current extended MAC address for a 802.15.4 interface. The byte order of the octstr shall be in wire byte order. For addresses values less than 64 bits, the first two bytes shall be zero.

ipv4_addresses

This field shall provide a list of the IPv4 addresses that are currently assigned to the network interface.

ipv4_addresses=(ipv4_addresses : Array(Slice(UInt8)))

This field shall provide a list of the IPv4 addresses that are currently assigned to the network interface.

ipv6_addresses

This field shall provide a list of the unicast IPv6 addresses that are currently assigned to the network interface. This list shall include the Node’s link-local address and SHOULD include any assigned GUA and ULA addresses. This list shall NOT include any multicast group addresses to which the Node is subscribed.

ipv6_addresses=(ipv6_addresses : Array(Slice(UInt8)))

This field shall provide a list of the unicast IPv6 addresses that are currently assigned to the network interface. This list shall include the Node’s link-local address and SHOULD include any assigned GUA and ULA addresses. This list shall NOT include any multicast group addresses to which the Node is subscribed.

is_operational=(is_operational : Bool)

This field shall indicate if the Node is currently advertising itself operationally on this network interface and is capable of successfully receiving incoming traffic from other Nodes.

is_operational?

This field shall indicate if the Node is currently advertising itself operationally on this network interface and is capable of successfully receiving incoming traffic from other Nodes.

name

This field shall indicate a human-readable (displayable) name for the network interface, that is different from all other interfaces.

name=(name : String)

This field shall indicate a human-readable (displayable) name for the network interface, that is different from all other interfaces.

off_premise_services_reachable_ipv4

This field shall indicate whether the Node is currently able to reach off-premise services it uses by utilizing IPv4. The value shall be null if the Node does not use such services or does not know whether it can reach them.

off_premise_services_reachable_ipv4=(off_premise_services_reachable_ipv4 : Bool | Nil)

This field shall indicate whether the Node is currently able to reach off-premise services it uses by utilizing IPv4. The value shall be null if the Node does not use such services or does not know whether it can reach them.

off_premise_services_reachable_ipv6

This field shall indicate whether the Node is currently able to reach off-premise services it uses by utilizing IPv6. The value shall be null if the Node does not use such services or does not know whether it can reach them.

off_premise_services_reachable_ipv6=(off_premise_services_reachable_ipv6 : Bool | Nil)

This field shall indicate whether the Node is currently able to reach off-premise services it uses by utilizing IPv6. The value shall be null if the Node does not use such services or does not know whether it can reach them.

to_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian) : Nil

to_slice

to_tlv(outer_tag : Nil | UInt8 | Tuple(UInt16, UInt16) | Tuple(UInt16, UInt16, UInt16) = nil) : TLV::Any

type

This field shall indicate the type of the interface using the InterfaceTypeEnum.

type=(type : InterfaceType)

This field shall indicate the type of the interface using the InterfaceTypeEnum.