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

package/dist/cjs/clusters/mode-base.d.ts

@@ -33,7 +33,7 @@ import type { VendorId } from "../datatype/VendorId.js";
  *
  * An anonymous mode shall NOT replace the meaning of a standard mode tag, when one exists, for the cluster purpose.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 1.10
+ * @see {@link MatterSpecification.v16.Cluster} § 1.10
  */
 export declare namespace ModeBase {
     /**
@@ -42,7 +42,7 @@ export declare namespace ModeBase {
     export const name: "ModeBase";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 2;
 
@@ -74,7 +74,7 @@ export declare namespace ModeBase {
          *
          * Simplified examples of disallowed ModeTags lists:
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.6.1
          */
         supportedModes: ModeOption[];
 
@@ -88,7 +88,7 @@ export declare namespace ModeBase {
          * sequence of operations, on system time-outs or idle delays, or via interactions coming from a fabric other
          * than the one which last executed a ChangeToMode.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.6.2
          */
         currentMode: number;
 
@@ -106,7 +106,7 @@ export declare namespace ModeBase {
          *
          * If this attribute is not implemented, or is set to the null value, it shall have no effect.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.6.3
          */
         startUpMode?: number | null;
     }
@@ -122,7 +122,7 @@ export declare namespace ModeBase {
          *
          * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.6.4
          */
         onMode: number | null;
     }
@@ -151,7 +151,7 @@ export declare namespace ModeBase {
          *
          * Simplified examples of disallowed ModeTags lists:
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.6.1
          */
         supportedModes: ModeOption[];
 
@@ -165,7 +165,7 @@ export declare namespace ModeBase {
          * sequence of operations, on system time-outs or idle delays, or via interactions coming from a fabric other
          * than the one which last executed a ChangeToMode.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.6.2
          */
         currentMode: number;
 
@@ -183,7 +183,7 @@ export declare namespace ModeBase {
          *
          * If this attribute is not implemented, or is set to the null value, it shall have no effect.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.6.3
          */
         startUpMode: number | null;
 
@@ -194,7 +194,7 @@ export declare namespace ModeBase {
          *
          * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.6.4
          */
         onMode: number | null;
     }
@@ -208,7 +208,7 @@ export declare namespace ModeBase {
          *
          * On receipt of this command the device shall respond with a ChangeToModeResponse command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.1
          */
         changeToMode(request: ChangeToModeRequest): MaybePromise<ChangeToModeResponse>;
     }
@@ -227,7 +227,7 @@ export declare namespace ModeBase {
     /**
      * These are optional features supported by ModeBaseCluster.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.10.4
+     * @see {@link MatterSpecification.v16.Cluster} § 1.10.4
      */
     export enum Feature {
         /**
@@ -236,7 +236,7 @@ export declare namespace ModeBase {
          * This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same
          * endpoint. See OnMode for more information.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.4.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.4.1
          */
         OnOff = "OnOff"
     }
@@ -244,7 +244,7 @@ export declare namespace ModeBase {
     /**
      * This is a struct representing a possible mode of the server.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.2
+     * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.2
      */
     export class ModeOption {
         constructor(values?: Partial<ModeOption>);
@@ -254,19 +254,19 @@ export declare namespace ModeBase {
          * the user to indicate what this option means. This field is meant to be readable and understandable by the
          * user.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.2.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.2.1
          */
         label: string;
 
         /**
          * This field is used to identify the mode option.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.2.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.2.2
          */
         mode: number;
 
         /**
-         * This field shall contain a list of tags that are associated with the mode option. This may be used by clients
+         * This field shall contain a list of tags that are associated with the mode option. This can be used by clients
          * to determine the full or the partial semantics of a certain mode, depending on which tags they understand,
          * using standard definitions and/or manufacturer specific namespace definitions.
          *
@@ -301,7 +301,7 @@ export declare namespace ModeBase {
          *   - A mode that includes both a generic Quick tag (defined here), and Vacuum and Mop tags, (defined in the
          *     RVC Clean cluster that is a derivation of this cluster).
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.2.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.2.3
          */
         modeTags: ModeTagStruct[];
     }
@@ -311,7 +311,7 @@ export declare namespace ModeBase {
      *
      * On receipt of this command the device shall respond with a ChangeToModeResponse command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.1
      */
     export class ChangeToModeRequest {
         constructor(values?: Partial<ChangeToModeRequest>);
@@ -339,7 +339,7 @@ export declare namespace ModeBase {
          * shall have the Status field set to Success and the StatusText field may be supplied with a human readable
          * string or include an empty string.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.1.1
          */
         newMode: number;
     }
@@ -347,13 +347,13 @@ export declare namespace ModeBase {
     /**
      * This command is sent by the device on receipt of the ChangeToMode command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.2
+     * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.2
      */
     export class ChangeToModeResponse {
         constructor(values?: Partial<ChangeToModeResponse>);
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.2.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.2.1
          */
         status: ModeChangeStatus;
 
@@ -363,7 +363,7 @@ export declare namespace ModeBase {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.1
      */
     export class ModeTagStruct {
         constructor(values?: Partial<ModeTagStruct>);
@@ -379,7 +379,7 @@ export declare namespace ModeBase {
          * whose purpose is to choose the amount of sugar, or in a cluster whose purpose is to choose the amount of
          * salt.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.1.1
          */
         mfgCode?: VendorId;
 
@@ -387,7 +387,7 @@ export declare namespace ModeBase {
          * This field shall indicate the mode tag within a mode tag namespace which is either manufacturer specific or
          * standard.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.5.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.5.1.2
          */
         value: ModeTag;
     }
@@ -397,14 +397,14 @@ export declare namespace ModeBase {
          * Switching to the mode indicated by the NewMode field is allowed and possible. The CurrentMode attribute is
          * set to the value of the NewMode field.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.2.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.2.1.2
          */
         Success = 0,
 
         /**
          * The value of the NewMode field doesn't match any entries in the SupportedModes attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.2.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.2.1.2
          */
         UnsupportedMode = 1,
 
@@ -412,66 +412,66 @@ export declare namespace ModeBase {
          * Generic failure code, indicating that switching to the mode indicated by the NewMode field is not allowed or
          * not possible.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.2.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.2.1.2
          */
         GenericFailure = 2,
 
         /**
          * The received request cannot be handled due to the current mode of the device
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.7.2.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.7.2.1.2
          */
         InvalidInMode = 3
     }
 
     export enum ModeTag {
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         Auto = 0,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         Quick = 1,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         Quiet = 2,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         LowNoise = 3,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         LowEnergy = 4,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         Vacation = 5,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         Min = 6,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         Max = 7,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         Night = 8,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 1.10.8
+         * @see {@link MatterSpecification.v16.Cluster} § 1.10.8
          */
         Day = 9
     }

package/dist/cjs/clusters/mode-select.d.ts

@@ -34,7 +34,7 @@ import type { VendorId } from "../datatype/VendorId.js";
  * derived cluster purpose. An anonymous mode shall NOT replace the meaning of a standard semantic tag, when one exists,
  * for the cluster purpose.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 1.9
+ * @see {@link MatterSpecification.v16.Cluster} § 1.9
  */
 export declare namespace ModeSelect {
     /**
@@ -48,7 +48,7 @@ export declare namespace ModeSelect {
     export const name: "ModeSelect";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 2;
 
@@ -71,7 +71,7 @@ export declare namespace ModeSelect {
          * and the second instance can have the description Sugar. This allows the user to tell the purpose of each of
          * the instances.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.1
          */
         description: string;
 
@@ -81,7 +81,7 @@ export declare namespace ModeSelect {
          * no standard namespace, and therefore, no standard semantic tags are provided in this cluster instance. Each
          * standard namespace and corresponding values and value meanings shall be defined in another document.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.2
          */
         standardNamespace: Namespace | null;
 
@@ -90,7 +90,7 @@ export declare namespace ModeSelect {
          * in this list represents a unique mode as indicated by the Mode field of the ModeOptionStruct. Each entry in
          * this list shall have a unique value for the Mode field.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.3
          */
         supportedModes: ModeOption[];
 
@@ -99,7 +99,7 @@ export declare namespace ModeSelect {
          *
          * The value of this field must match the Mode field of one of the entries in the SupportedModes attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.4
          */
         currentMode: number;
 
@@ -118,7 +118,7 @@ export declare namespace ModeSelect {
          *
          * If this attribute is not implemented, or is set to the null value, it shall have no effect.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.5
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.5
          */
         startUpMode?: number | null;
     }
@@ -134,7 +134,7 @@ export declare namespace ModeSelect {
          *
          * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.6
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.6
          */
         onMode: number | null;
     }
@@ -154,7 +154,7 @@ export declare namespace ModeSelect {
          * and the second instance can have the description Sugar. This allows the user to tell the purpose of each of
          * the instances.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.1
          */
         description: string;
 
@@ -164,7 +164,7 @@ export declare namespace ModeSelect {
          * no standard namespace, and therefore, no standard semantic tags are provided in this cluster instance. Each
          * standard namespace and corresponding values and value meanings shall be defined in another document.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.2
          */
         standardNamespace: Namespace | null;
 
@@ -173,7 +173,7 @@ export declare namespace ModeSelect {
          * in this list represents a unique mode as indicated by the Mode field of the ModeOptionStruct. Each entry in
          * this list shall have a unique value for the Mode field.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.3
          */
         supportedModes: ModeOption[];
 
@@ -182,7 +182,7 @@ export declare namespace ModeSelect {
          *
          * The value of this field must match the Mode field of one of the entries in the SupportedModes attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.4
          */
         currentMode: number;
 
@@ -201,7 +201,7 @@ export declare namespace ModeSelect {
          *
          * If this attribute is not implemented, or is set to the null value, it shall have no effect.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.5
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.5
          */
         startUpMode: number | null;
 
@@ -212,7 +212,7 @@ export declare namespace ModeSelect {
          *
          * The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.6.6
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.6.6
          */
         onMode: number | null;
     }
@@ -226,7 +226,7 @@ export declare namespace ModeSelect {
          * the server shall set the CurrentMode attribute to the NewMode value, otherwise, the server shall respond with
          * an INVALID_COMMAND status response.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.7.1
          */
         changeToMode(request: ChangeToModeRequest): MaybePromise;
     }
@@ -245,7 +245,7 @@ export declare namespace ModeSelect {
     /**
      * These are optional features supported by ModeSelectCluster.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.9.4
+     * @see {@link MatterSpecification.v16.Cluster} § 1.9.4
      */
     export enum Feature {
         /**
@@ -254,7 +254,7 @@ export declare namespace ModeSelect {
          * This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same
          * endpoint. See Section 1.9.6.6, "OnMode Attribute" for more information.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.4.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.4.1
          */
         OnOff = "OnOff"
     }
@@ -262,7 +262,7 @@ export declare namespace ModeSelect {
     /**
      * This is a struct representing a possible mode of the server.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.9.5.2
+     * @see {@link MatterSpecification.v16.Cluster} § 1.9.5.2
      */
     export class ModeOption {
         constructor(values?: Partial<ModeOption>);
@@ -271,7 +271,7 @@ export declare namespace ModeSelect {
          * This field is readable text that describes the mode option that can be used by a client to indicate to the
          * user what this option means. This field is meant to be readable and understandable by the user.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.5.2.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.5.2.1
          */
         label: string;
 
@@ -279,7 +279,7 @@ export declare namespace ModeSelect {
          * The Mode field is used to identify the mode option. The value shall be unique for every item in the
          * SupportedModes attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.5.2.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.5.2.2
          */
         mode: number;
 
@@ -297,7 +297,7 @@ export declare namespace ModeSelect {
          * For example: A mode labeled "100%" can have both the HIGH (MS) and MAX (standard) semantic tag. Clients
          * seeking the option for either HIGH or MAX will find the same option in this case.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.5.2.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.5.2.3
          */
         semanticTags: SemanticTag[];
     }
@@ -307,7 +307,7 @@ export declare namespace ModeSelect {
      * server shall set the CurrentMode attribute to the NewMode value, otherwise, the server shall respond with an
      * INVALID_COMMAND status response.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.9.7.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.9.7.1
      */
     export class ChangeToModeRequest {
         constructor(values?: Partial<ChangeToModeRequest>);
@@ -317,7 +317,7 @@ export declare namespace ModeSelect {
     /**
      * A Semantic Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.9.5.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.9.5.1
      */
     export class SemanticTag {
         constructor(values?: Partial<SemanticTag>);
@@ -329,7 +329,7 @@ export declare namespace ModeSelect {
          * have the same meaning. For example: a manufacturer tag meaning "pinch", has the same meaning in a cluster
          * whose purpose is to choose the amount of sugar, or amount of salt.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.5.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.5.1.2
          */
         mfgCode: VendorId;
 
@@ -337,7 +337,7 @@ export declare namespace ModeSelect {
          * This field shall indicate the semantic tag within a semantic tag namespace which is either manufacturer
          * specific or standard. For semantic tags in a standard namespace, see Standard Namespace.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.9.5.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.9.5.1.1
          */
         value: number;
     }