interface State {
    basicCommissioningInfo: TypeFromFields<{
        failSafeExpiryLengthSeconds: FieldType<number>;
        maxCumulativeFailsafeSeconds: FieldType<number>;
    }>;
    breadcrumb: number | bigint;
    locationCapability: GeneralCommissioning.RegulatoryLocationType;
    regulatoryConfig: GeneralCommissioning.RegulatoryLocationType;
    supportsConcurrentConnection: boolean;
}

Hierarchy

  • StateType
    • State

Properties

basicCommissioningInfo: TypeFromFields<{
    failSafeExpiryLengthSeconds: FieldType<number>;
    maxCumulativeFailsafeSeconds: FieldType<number>;
}>

This attribute shall describe critical parameters needed at the beginning of commissioning flow. See BasicCommissioningInfo for more information.

Type declaration

  • failSafeExpiryLengthSeconds: FieldType<number>

    This field shall contain a conservative initial duration (in seconds) to set in the FailSafe for the commissioning flow to complete successfully. This may vary depending on the speed or sleepiness of the Commissionee. This value, if used in the ArmFailSafe command’s ExpiryLengthSeconds field SHOULD allow a Commissioner to proceed with a nominal commissioning without having to-rearm the fail-safe, with some margin.

    MatterSpecification.v13.Core § 11.10.4.3.1

  • maxCumulativeFailsafeSeconds: FieldType<number>

    This field shall contain a conservative value in seconds denoting the maximum total duration for which a fail safe timer can be re-armed. See Section 11.10.6.2.1, “Fail Safe Context”.

    The value of this field shall be greater than or equal to the FailSafeExpiryLengthSeconds. Absent additional guidelines, it is recommended that the value of this field be aligned with the initial Announcement Duration and default to 900 seconds.

    MatterSpecification.v13.Core § 11.10.4.3.2

MatterSpecification.v13.Core § 11.10.5.2

breadcrumb: number | bigint

This attribute allows for the storage of a client-provided small payload which Administrators and Commissioners may write and then subsequently read, to keep track of their own progress. This may be used by the Commissioner to avoid repeating already-executed actions upon re-establishing a commissioning link after an error.

On start/restart of the server, such as when a device is power-cycled, this attribute shall be reset to zero.

Some commands related to commissioning also have a side-effect of updating or resetting this attribute and this is specified in their respective functional descriptions.

The format of the value within this attribute is unspecified and its value is not otherwise used by the functioning of any cluster, other than being set as a side-effect of commands where this behavior is described.

MatterSpecification.v13.Core § 11.10.5.1

LocationCapability is statically set by the manufacturer and indicates if this Node needs to be told an exact RegulatoryLocation. For example a Node which is "Indoor Only" would not be certified for outdoor use at all, and thus there is no need for a commissioner to set or ask the user about whether the device will be used inside or outside. However a device which states its capability is "Indoor/Outdoor" means it would like clarification if possible.

For Nodes without radio network interfaces (e.g. Ethernet-only devices), the value IndoorOutdoor shall always be used.

The default value of the RegulatoryConfig attribute is the value of LocationCapability attribute. This means devices always have a safe default value, and Commissioners which choose to implement smarter handling can.

MatterSpecification.v13.Core § 11.10.5.4

Indicates the regulatory configuration for the product.

Note that the country code is part of Basic Information Cluster and therefore NOT listed on the RegulatoryConfig attribute.

MatterSpecification.v13.Core § 11.10.5.3

supportsConcurrentConnection: boolean

Indicates whether this device supports "concurrent connection flow" commissioning mode (see Section 5.5, “Commissioning Flows”). If false, the device only supports "non-concurrent connection flow" mode.

MatterSpecification.v13.Core § 11.10.5.5