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.

MatterSpecification.v13.Core § 11.9.7.7

interface NetworkConfigResponse {
    debugText?: string;
    networkIndex?: number;
    networkingStatus: NetworkCommissioning.NetworkCommissioningStatus;
}

Hierarchy (view full)

Properties

debugText?: string

See Section 11.9.7.2.2, “DebugText Field” for usage.

MatterSpecification.v13.Core § 11.9.7.7.2

networkIndex?: number

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.

MatterSpecification.v13.Core § 11.9.7.7.3

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.9.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.

MatterSpecification.v13.Core § 11.9.7.7.1