@matter/types 0.17.4 → 0.17.5-alpha.0-20260704-9ea70abfa

package/dist/esm/clusters/general-commissioning.d.ts

@@ -20,7 +20,7 @@ import type { Bytes, MaybePromise } from "@matter/general";
  * clusters, like Section 11.9, "Network Commissioning Cluster". It also hosts functionalities those other clusters may
  * depend on.
  *
- * @see {@link MatterSpecification.v151.Core} § 11.10
+ * @see {@link MatterSpecification.v16.Core} § 11.10
  */
 export declare namespace GeneralCommissioning {
     /**
@@ -34,7 +34,7 @@ export declare namespace GeneralCommissioning {
     export const name: "GeneralCommissioning";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 2;
 
@@ -64,7 +64,7 @@ export declare namespace GeneralCommissioning {
          * functioning of any cluster, other than being set as a side-effect of commands where this behavior is
          * described.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.1
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.1
          */
         breadcrumb: number | bigint;
 
@@ -72,7 +72,7 @@ export declare namespace GeneralCommissioning {
          * This attribute shall describe critical parameters needed at the beginning of commissioning flow. See Section
          * 11.10.5.4, "BasicCommissioningInfo" for more information.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.2
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.2
          */
         basicCommissioningInfo: BasicCommissioningInfo;
 
@@ -82,7 +82,7 @@ export declare namespace GeneralCommissioning {
          * Note that the country code is part of Section 11.1, "Basic Information Cluster" and therefore NOT listed on
          * the RegulatoryConfig attribute.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.3
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.3
          */
         regulatoryConfig: RegulatoryLocationType;
 
@@ -99,7 +99,7 @@ export declare namespace GeneralCommissioning {
          * 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.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.4
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.4
          */
         locationCapability: RegulatoryLocationType;
 
@@ -107,7 +107,7 @@ export declare namespace GeneralCommissioning {
          * 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.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.5
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.5
          */
         supportsConcurrentConnection: boolean;
 
@@ -119,10 +119,11 @@ export declare namespace GeneralCommissioning {
          * because it can harvest energy from NFC to operate. However, such a Commissionee must be powered on to switch
          * to the operational channel.
          *
-         * This attribute is used by the Commissioner as described in step 18 of Section 5.5, "Commissioning Flows".
-         * This attribute is linked to the Commissionee behavior after reception of the ConnectNetwork Command.
+         * This attribute is used by the Commissioner as described in initial phase step 17 of Section 5.5,
+         * "Commissioning Flows". This attribute is linked to the Commissionee behavior after reception of the
+         * ConnectNetwork Command.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.13
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.13
          */
         isCommissioningWithoutPower?: boolean;
     }
@@ -140,7 +141,7 @@ export declare namespace GeneralCommissioning {
          * attribute is set to a value which is greater than or equal to TCMinRequiredVersion before returning the user
          * back to the originating Commissioner (see Section 5.7.4, "Enhanced Setup Flow (ESF)").
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.6
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.6
          */
         tcAcceptedVersion: number;
 
@@ -152,7 +153,7 @@ export declare namespace GeneralCommissioning {
          * the device shall update TCAcknowledgementsRequired to True so that an administrator can detect that a newer
          * version of the texts needs to be presented to the user.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.7
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.7
          */
         tcMinRequiredVersion: number;
 
@@ -167,7 +168,7 @@ export declare namespace GeneralCommissioning {
          * with the latest responses. This may happen in response to updated terms that were presented to the user. On a
          * factory reset this field shall be reset with all bits set to 0.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.8
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.8
          */
         tcAcknowledgements: number;
 
@@ -188,7 +189,7 @@ export declare namespace GeneralCommissioning {
          * that this attribute is set to False before returning the user back to the original Commissioner (see Section
          * 5.7.4, "Enhanced Setup Flow (ESF)").
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.9
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.9
          */
         tcAcknowledgementsRequired: boolean;
 
@@ -199,7 +200,7 @@ export declare namespace GeneralCommissioning {
          *
          * A null value indicates that there is no pending deadline for updated TC acceptance.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.10
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.10
          */
         tcUpdateDeadline: number | null;
     }
@@ -218,7 +219,7 @@ export declare namespace GeneralCommissioning {
          * 64-bit number space to ensure a high likelihood of uniqueness from values selected by other Nodes. This value
          * SHOULD be obtained through Crypto_DRBG(len = 64).
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.11
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.11
          */
         recoveryIdentifier: Bytes;
 
@@ -226,7 +227,7 @@ export declare namespace GeneralCommissioning {
          * This attribute shall contain the primary reason that triggered the Network Recovery flow and its associated
          * advertisements. Null when the Node is not undergoing a Network Recovery flow.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.12
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.12
          */
         networkRecoveryReason: NetworkRecoveryReason | null;
     }
@@ -253,7 +254,7 @@ export declare namespace GeneralCommissioning {
          * functioning of any cluster, other than being set as a side-effect of commands where this behavior is
          * described.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.1
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.1
          */
         breadcrumb: number | bigint;
 
@@ -261,7 +262,7 @@ export declare namespace GeneralCommissioning {
          * This attribute shall describe critical parameters needed at the beginning of commissioning flow. See Section
          * 11.10.5.4, "BasicCommissioningInfo" for more information.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.2
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.2
          */
         basicCommissioningInfo: BasicCommissioningInfo;
 
@@ -271,7 +272,7 @@ export declare namespace GeneralCommissioning {
          * Note that the country code is part of Section 11.1, "Basic Information Cluster" and therefore NOT listed on
          * the RegulatoryConfig attribute.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.3
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.3
          */
         regulatoryConfig: RegulatoryLocationType;
 
@@ -288,7 +289,7 @@ export declare namespace GeneralCommissioning {
          * 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.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.4
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.4
          */
         locationCapability: RegulatoryLocationType;
 
@@ -296,7 +297,7 @@ export declare namespace GeneralCommissioning {
          * 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.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.5
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.5
          */
         supportsConcurrentConnection: boolean;
 
@@ -308,10 +309,11 @@ export declare namespace GeneralCommissioning {
          * because it can harvest energy from NFC to operate. However, such a Commissionee must be powered on to switch
          * to the operational channel.
          *
-         * This attribute is used by the Commissioner as described in step 18 of Section 5.5, "Commissioning Flows".
-         * This attribute is linked to the Commissionee behavior after reception of the ConnectNetwork Command.
+         * This attribute is used by the Commissioner as described in initial phase step 17 of Section 5.5,
+         * "Commissioning Flows". This attribute is linked to the Commissionee behavior after reception of the
+         * ConnectNetwork Command.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.13
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.13
          */
         isCommissioningWithoutPower: boolean;
 
@@ -324,7 +326,7 @@ export declare namespace GeneralCommissioning {
          * attribute is set to a value which is greater than or equal to TCMinRequiredVersion before returning the user
          * back to the originating Commissioner (see Section 5.7.4, "Enhanced Setup Flow (ESF)").
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.6
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.6
          */
         tcAcceptedVersion: number;
 
@@ -336,7 +338,7 @@ export declare namespace GeneralCommissioning {
          * the device shall update TCAcknowledgementsRequired to True so that an administrator can detect that a newer
          * version of the texts needs to be presented to the user.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.7
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.7
          */
         tcMinRequiredVersion: number;
 
@@ -351,7 +353,7 @@ export declare namespace GeneralCommissioning {
          * with the latest responses. This may happen in response to updated terms that were presented to the user. On a
          * factory reset this field shall be reset with all bits set to 0.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.8
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.8
          */
         tcAcknowledgements: number;
 
@@ -372,7 +374,7 @@ export declare namespace GeneralCommissioning {
          * that this attribute is set to False before returning the user back to the original Commissioner (see Section
          * 5.7.4, "Enhanced Setup Flow (ESF)").
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.9
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.9
          */
         tcAcknowledgementsRequired: boolean;
 
@@ -383,7 +385,7 @@ export declare namespace GeneralCommissioning {
          *
          * A null value indicates that there is no pending deadline for updated TC acceptance.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.10
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.10
          */
         tcUpdateDeadline: number | null;
 
@@ -397,7 +399,7 @@ export declare namespace GeneralCommissioning {
          * 64-bit number space to ensure a high likelihood of uniqueness from values selected by other Nodes. This value
          * SHOULD be obtained through Crypto_DRBG(len = 64).
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.11
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.11
          */
         recoveryIdentifier: Bytes;
 
@@ -405,7 +407,7 @@ export declare namespace GeneralCommissioning {
          * This attribute shall contain the primary reason that triggered the Network Recovery flow and its associated
          * advertisements. Null when the Node is not undergoing a Network Recovery flow.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.6.12
+         * @see {@link MatterSpecification.v16.Core} § 11.10.6.12
          */
         networkRecoveryReason: NetworkRecoveryReason | null;
     }
@@ -454,7 +456,7 @@ export declare namespace GeneralCommissioning {
          *
          * On successful execution of the command, the ErrorCode field of the ArmFailSafeResponse shall be set to OK.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.2
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.2
          */
         armFailSafe(request: ArmFailSafeRequest): MaybePromise<ArmFailSafeResponse>;
 
@@ -490,7 +492,7 @@ export declare namespace GeneralCommissioning {
          * when SetRegulatoryConfigResponse has the ErrorCode field set to OK. If the command fails, the Breadcrumb
          * attribute shall be left unchanged.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.4
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.4
          */
         setRegulatoryConfig(request: SetRegulatoryConfigRequest): MaybePromise<SetRegulatoryConfigResponse>;
 
@@ -549,7 +551,7 @@ export declare namespace GeneralCommissioning {
          * After receipt of a CommissioningCompleteResponse with an ErrorCode value of OK, a client cannot expect any
          * previously established PASE session to still be usable, due to the server having cleared such sessions.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.6
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.6
          */
         commissioningComplete(): MaybePromise<CommissioningCompleteResponse>;
     }
@@ -562,7 +564,7 @@ export declare namespace GeneralCommissioning {
          * This command is used to set the user acknowledgements received in the Enhanced Setup Flow Terms & Conditions
          * into the node.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.8
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.8
          */
         setTcAcknowledgements(request: SetTcAcknowledgementsRequest): MaybePromise<SetTcAcknowledgementsResponse>;
     }
@@ -590,7 +592,7 @@ export declare namespace GeneralCommissioning {
     /**
      * These are optional features supported by GeneralCommissioningCluster.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.4
+     * @see {@link MatterSpecification.v16.Core} § 11.10.4
      */
     export enum Feature {
         /**
@@ -611,7 +613,7 @@ export declare namespace GeneralCommissioning {
     /**
      * This structure provides some constant values that may be of use to all commissioners.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.5.4
+     * @see {@link MatterSpecification.v16.Core} § 11.10.5.4
      */
     export class BasicCommissioningInfo {
         constructor(values?: Partial<BasicCommissioningInfo>);
@@ -623,7 +625,7 @@ export declare namespace GeneralCommissioning {
          * SHOULD allow a Commissioner to proceed with a nominal commissioning without having to-rearm the fail-safe,
          * with some margin.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.5.4.1
+         * @see {@link MatterSpecification.v16.Core} § 11.10.5.4.1
          */
         failSafeExpiryLengthSeconds: number;
 
@@ -635,7 +637,7 @@ export declare namespace GeneralCommissioning {
          * guidelines, it is recommended that the value of this field be aligned with the initial Section 5.4.2.3,
          * "Announcement Duration" and default to 900 seconds.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.5.4.2
+         * @see {@link MatterSpecification.v16.Core} § 11.10.5.4.2
          */
         maxCumulativeFailsafeSeconds: number;
     }
@@ -644,7 +646,7 @@ export declare namespace GeneralCommissioning {
      * This enumeration is used by the RegulatoryConfig and LocationCapability attributes to indicate possible radio
      * usage.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.5.2
+     * @see {@link MatterSpecification.v16.Core} § 11.10.5.2
      */
     export enum RegulatoryLocationType {
         /**
@@ -669,7 +671,7 @@ export declare namespace GeneralCommissioning {
      * This enumeration is used by the NetworkRecoveryReason attribute and may be embedded in the beacons advertising
      * the need for Network Recovery.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.5.3
+     * @see {@link MatterSpecification.v16.Core} § 11.10.5.3
      */
     export enum NetworkRecoveryReason {
         /**
@@ -728,7 +730,7 @@ export declare namespace GeneralCommissioning {
      *
      * On successful execution of the command, the ErrorCode field of the ArmFailSafeResponse shall be set to OK.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.7.2
+     * @see {@link MatterSpecification.v16.Core} § 11.10.7.2
      */
     export class ArmFailSafeRequest {
         constructor(values?: Partial<ArmFailSafeRequest>);
@@ -739,7 +741,7 @@ export declare namespace GeneralCommissioning {
     /**
      * This command is used to report the result of the ArmFailSafe command.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.7.3
+     * @see {@link MatterSpecification.v16.Core} § 11.10.7.3
      */
     export class ArmFailSafeResponse {
         constructor(values?: Partial<ArmFailSafeResponse>);
@@ -748,14 +750,14 @@ export declare namespace GeneralCommissioning {
          * This field shall contain the result of the operation, based on the behavior specified in the functional
          * description of the ArmFailSafe command.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.3.1
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.3.1
          */
         errorCode: CommissioningError;
 
         /**
          * See Section 11.10.7.1, "Common fields in General Commissioning cluster responses".
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.3.2
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.3.2
          */
         debugText: string;
     }
@@ -792,7 +794,7 @@ export declare namespace GeneralCommissioning {
      * SetRegulatoryConfigResponse has the ErrorCode field set to OK. If the command fails, the Breadcrumb attribute
      * shall be left unchanged.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.7.4
+     * @see {@link MatterSpecification.v16.Core} § 11.10.7.4
      */
     export class SetRegulatoryConfigRequest {
         constructor(values?: Partial<SetRegulatoryConfigRequest>);
@@ -804,7 +806,7 @@ export declare namespace GeneralCommissioning {
     /**
      * This command is used to report the result of the SetRegulatoryConfig command.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.7.5
+     * @see {@link MatterSpecification.v16.Core} § 11.10.7.5
      */
     export class SetRegulatoryConfigResponse {
         constructor(values?: Partial<SetRegulatoryConfigResponse>);
@@ -813,14 +815,14 @@ export declare namespace GeneralCommissioning {
          * This field shall contain the result of the operation, based on the behavior specified in the functional
          * description of the SetRegulatoryConfig command.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.5.1
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.5.1
          */
         errorCode: CommissioningError;
 
         /**
          * See Section 11.10.7.1, "Common fields in General Commissioning cluster responses".
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.5.2
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.5.2
          */
         debugText: string;
     }
@@ -828,7 +830,7 @@ export declare namespace GeneralCommissioning {
     /**
      * This command is used to report the result of the CommissioningComplete command.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.7.7
+     * @see {@link MatterSpecification.v16.Core} § 11.10.7.7
      */
     export class CommissioningCompleteResponse {
         constructor(values?: Partial<CommissioningCompleteResponse>);
@@ -837,14 +839,14 @@ export declare namespace GeneralCommissioning {
          * This field shall contain the result of the operation, based on the behavior specified in the functional
          * description of the CommissioningComplete command.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.7.1
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.7.1
          */
         errorCode: CommissioningError;
 
         /**
          * See Section 11.10.7.1, "Common fields in General Commissioning cluster responses".
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.7.2
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.7.2
          */
         debugText: string;
     }
@@ -853,7 +855,7 @@ export declare namespace GeneralCommissioning {
      * This command is used to set the user acknowledgements received in the Enhanced Setup Flow Terms & Conditions into
      * the node.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.7.8
+     * @see {@link MatterSpecification.v16.Core} § 11.10.7.8
      */
     export class SetTcAcknowledgementsRequest {
         constructor(values?: Partial<SetTcAcknowledgementsRequest>);
@@ -862,16 +864,16 @@ export declare namespace GeneralCommissioning {
          * This field shall contain the version of the Enhanced Setup Flow Terms & Conditions that were presented to the
          * user.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.8.1
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.8.1
          */
         tcVersion: number;
 
         /**
          * This field shall contain the user responses to the Enhanced Setup Flow Terms & Conditions as a map where each
-         * bit set in the bitmap corresponds to an accepted term in the file located at Section 11.23.6.22,
+         * bit set in the bitmap corresponds to an accepted term in the file located at Section 11.23.6.23,
          * "EnhancedSetupFlowTCUrl".
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.8.2
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.8.2
          */
         tcUserResponse: number;
     }
@@ -879,7 +881,7 @@ export declare namespace GeneralCommissioning {
     /**
      * This command is used to report the result of the SetTCAcknowledgements command.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.7.9
+     * @see {@link MatterSpecification.v16.Core} § 11.10.7.9
      */
     export class SetTcAcknowledgementsResponse {
         constructor(values?: Partial<SetTcAcknowledgementsResponse>);
@@ -888,7 +890,7 @@ export declare namespace GeneralCommissioning {
          * This field shall contain the result of the operation, based on the behavior specified in the functional
          * description of the SetTCAcknowledgements command.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.10.7.9.1
+         * @see {@link MatterSpecification.v16.Core} § 11.10.7.9.1
          */
         errorCode: CommissioningError;
     }
@@ -896,7 +898,7 @@ export declare namespace GeneralCommissioning {
     /**
      * This enumeration is used by several response commands in this cluster to indicate particular errors.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.10.5.1
+     * @see {@link MatterSpecification.v16.Core} § 11.10.5.1
      */
     export enum CommissioningError {
         /**