struct

Matter::Cluster::Definitions::NetworkCommissioning::NetworkConfigurationResponse

Inherits TLV::Serializable < Struct < Value < Object

This response command relates status information for some commands which require it as their response command. See each individual cluster server command for the situations that may cause a NetworkingStatus different than Success.

Before generating a NetworkConfigResponse, the server shall set the LastNetworkingStatus attribute value to the NetworkingStatus matching the response.

Before generating a NetworkConfigResponse, the server shall set the LastNetworkID attribute value to the NetworkID that was used in the command for which an invocation caused the response to be generated.

The NetworkingStatus field shall indicate the status of the last operation attempting to modify the Networks attribute configuration, taking one of these values:

• Success: Operation succeeded.

• OutOfRange: Network identifier was invalid (e.g. empty, too long, etc).

• BoundsExceeded: Adding this network configuration would exceed the limit defined by Section 11.8.6.1, “MaxNetworks Attribute”.

• NetworkIdNotFound: The network identifier was expected to be found, but was not found among the added network configurations in Networks attribute.

• UnknownError: An internal error occurred during the operation.

See Section 11.8.7.2.2, “DebugText Field” for usage.

Constructors

new(any : TLV::Any)
Source
new(status_code : StatusCode, debug_text : String | Nil = nil, network_index : UInt8 | Nil = nil)
Source

Class methods

from_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian)
Source
from_slice(bytes : Bytes)
Source
from_tlv(any : TLV::Any)
Source
from_tlv(data : Bytes)
Source

Instance methods

debug_text
Source
debug_text=(debug_text : String | Nil)
Source
network_index

When the NetworkingStatus is Success, this field shall be present. It shall contain the 0-based index of the entry in the Networks attribute that was last added, updated or removed successfully by the associated request command.

Source
network_index=(network_index : UInt8 | Nil)

When the NetworkingStatus is Success, this field shall be present. It shall contain the 0-based index of the entry in the Networks attribute that was last added, updated or removed successfully by the associated request command.

Source
status_code
Source
status_code=(status_code : StatusCode)
Source
to_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian) : Nil
Source
to_slice
Source
to_tlv(outer_tag : Nil | UInt8 | Tuple(UInt16, UInt16) | Tuple(UInt16, UInt16, UInt16) = nil) : TLV::Any
Source