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

package/src/clusters/descriptor.d.ts

@@ -40,7 +40,7 @@ import type { DeviceTypeId } from "../datatype/DeviceTypeId.js";
  * > For Example: A Refrigerator/Freezer appliance device type may be defined as being composed of multiple Temperature
  *   Sensor endpoints, a Metering endpoint, and two Thermostat endpoints.
  *
- * @see {@link MatterSpecification.v151.Core} § 9.5
+ * @see {@link MatterSpecification.v16.Core} § 9.5
  */
 export declare namespace Descriptor {
     /**
@@ -54,7 +54,7 @@ export declare namespace Descriptor {
     export const name: "Descriptor";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 3;
 
@@ -77,21 +77,21 @@ export declare namespace Descriptor {
          * common for more than one device type in the DeviceTypeList shall be supported as a shared cluster instance on
          * the endpoint.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.1
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.1
          */
         deviceTypeList: DeviceType[];
 
         /**
          * This attribute shall list each cluster ID for the server clusters present on the endpoint instance.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.2
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.2
          */
         serverList: ClusterId[];
 
         /**
          * This attribute shall list each cluster ID for the client clusters present on the endpoint instance.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.3
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.3
          */
         clientList: ClusterId[];
 
@@ -101,7 +101,7 @@ export declare namespace Descriptor {
          *
          * See Endpoint Composition for more information about which endpoints to include in this list.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.4
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.4
          */
         partsList: EndpointNumber[];
 
@@ -118,7 +118,7 @@ export declare namespace Descriptor {
          * The value does not need to be human readable, since it is intended for machine to machine (M2M)
          * communication.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.6
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.6
          */
         endpointUniqueId?: string;
     }
@@ -146,7 +146,7 @@ export declare namespace Descriptor {
          * A client may use the Label field of each SemanticTagStruct, if present in each structure, to indicate
          * characteristics of an endpoint, or to augment what is provided in the TagID field of the same structure.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.5
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.5
          */
         tagList: Semtag[];
     }
@@ -166,21 +166,21 @@ export declare namespace Descriptor {
          * common for more than one device type in the DeviceTypeList shall be supported as a shared cluster instance on
          * the endpoint.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.1
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.1
          */
         deviceTypeList: DeviceType[];
 
         /**
          * This attribute shall list each cluster ID for the server clusters present on the endpoint instance.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.2
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.2
          */
         serverList: ClusterId[];
 
         /**
          * This attribute shall list each cluster ID for the client clusters present on the endpoint instance.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.3
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.3
          */
         clientList: ClusterId[];
 
@@ -190,7 +190,7 @@ export declare namespace Descriptor {
          *
          * See Endpoint Composition for more information about which endpoints to include in this list.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.4
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.4
          */
         partsList: EndpointNumber[];
 
@@ -207,7 +207,7 @@ export declare namespace Descriptor {
          * The value does not need to be human readable, since it is intended for machine to machine (M2M)
          * communication.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.6
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.6
          */
         endpointUniqueId: string;
 
@@ -230,7 +230,7 @@ export declare namespace Descriptor {
          * A client may use the Label field of each SemanticTagStruct, if present in each structure, to indicate
          * characteristics of an endpoint, or to augment what is provided in the TagID field of the same structure.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.6.5
+         * @see {@link MatterSpecification.v16.Core} § 9.5.6.5
          */
         tagList: Semtag[];
     }
@@ -244,7 +244,7 @@ export declare namespace Descriptor {
     /**
      * These are optional features supported by DescriptorCluster.
      *
-     * @see {@link MatterSpecification.v151.Core} § 9.5.4
+     * @see {@link MatterSpecification.v16.Core} § 9.5.4
      */
     export enum Feature {
         /**
@@ -253,7 +253,7 @@ export declare namespace Descriptor {
          * See the Disambiguation section in the System Model spec for conformance requirements for this feature and the
          * corresponding attribute.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.4.1
+         * @see {@link MatterSpecification.v16.Core} § 9.5.4.1
          */
         TagList = "TagList"
     }
@@ -262,7 +262,7 @@ export declare namespace Descriptor {
      * The device type and revision define endpoint conformance to a release of a device type definition. See the Data
      * Model specification for more information.
      *
-     * @see {@link MatterSpecification.v151.Core} § 9.5.5.1
+     * @see {@link MatterSpecification.v16.Core} § 9.5.5.1
      */
     export class DeviceType {
         constructor(values?: Partial<DeviceType>);
@@ -271,7 +271,7 @@ export declare namespace Descriptor {
          * This shall indicate the device type definition. The endpoint shall conform to the device type definition and
          * cluster specifications required by the device type.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.5.1.1
+         * @see {@link MatterSpecification.v16.Core} § 9.5.5.1.1
          */
         deviceType: DeviceTypeId;
 
@@ -279,7 +279,7 @@ export declare namespace Descriptor {
          * This is the implemented revision of the device type definition. The endpoint shall conform to this revision
          * of the device type.
          *
-         * @see {@link MatterSpecification.v151.Core} § 9.5.5.1.2
+         * @see {@link MatterSpecification.v16.Core} § 9.5.5.1.2
          */
         revision: number;
     }

package/src/clusters/device-energy-management-mode.d.ts

@@ -19,7 +19,7 @@ import type { VendorId } from "../datatype/VendorId.js";
  * This cluster is derived from the Mode Base cluster and defines additional mode tags and namespaced enumerated values
  * for Device Energy Management devices.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 9.8
+ * @see {@link MatterSpecification.v16.Cluster} § 9.8
  */
 export declare namespace DeviceEnergyManagementMode {
     /**
@@ -33,7 +33,7 @@ export declare namespace DeviceEnergyManagementMode {
     export const name: "DeviceEnergyManagementMode";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 2;
 
@@ -61,12 +61,12 @@ export declare namespace DeviceEnergyManagementMode {
          * An entry in the SupportedModes attribute that includes one of an DeviceOptimization, LocalOptimization, or
          * GridOptimization tags shall NOT also include NoOptimization tag.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.6.1
          */
         supportedModes: ModeOption[];
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.6
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.6
          */
         currentMode: number;
     }
@@ -91,12 +91,12 @@ export declare namespace DeviceEnergyManagementMode {
          * An entry in the SupportedModes attribute that includes one of an DeviceOptimization, LocalOptimization, or
          * GridOptimization tags shall NOT also include NoOptimization tag.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.6.1
          */
         supportedModes: ModeOption[];
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.6
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.6
          */
         currentMode: number;
     }
@@ -110,7 +110,7 @@ export declare namespace DeviceEnergyManagementMode {
          *
          * 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: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
     }
@@ -126,7 +126,7 @@ export declare namespace DeviceEnergyManagementMode {
     /**
      * These are optional features supported by DeviceEnergyManagementModeCluster.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 9.8.4
+     * @see {@link MatterSpecification.v16.Cluster} § 9.8.4
      */
     export enum Feature {
         /**
@@ -141,7 +141,7 @@ export declare namespace DeviceEnergyManagementMode {
      * The table below lists the changes relative to the Mode Base cluster for the fields of the ModeOptionStruct type.
      * A blank field indicates no change.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 9.8.5.1
+     * @see {@link MatterSpecification.v16.Cluster} § 9.8.5.1
      */
     export class ModeOption {
         constructor(values?: Partial<ModeOption>);
@@ -151,19 +151,19 @@ export declare namespace DeviceEnergyManagementMode {
          * 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.
          *
@@ -198,59 +198,59 @@ export declare namespace DeviceEnergyManagementMode {
          *   - 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[];
     }
 
     export enum ModeTag {
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         Auto = 0,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         Quick = 1,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         Quiet = 2,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         LowNoise = 3,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         LowEnergy = 4,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         Vacation = 5,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         Min = 6,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         Max = 7,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         Night = 8,
 
         /**
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1
          */
         Day = 9,
 
@@ -258,28 +258,28 @@ export declare namespace DeviceEnergyManagementMode {
          * The device prohibits optimization of energy usage management: its energy usage is determined only by the user
          * configuration and internal device needs.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1.1
          */
         NoOptimization = 16384,
 
         /**
          * The device is permitted to manage its own energy usage. For example, using tariff information it may obtain.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1.2
          */
         DeviceOptimization = 16385,
 
         /**
          * The device permits management of energy usage by an energy manager to optimize the local energy usage.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1.3
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1.3
          */
         LocalOptimization = 16386,
 
         /**
          * The device permits management of energy usage by an energy manager to optimize the grid energy usage.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 9.8.7.1.4
+         * @see {@link MatterSpecification.v16.Cluster} § 9.8.7.1.4
          */
         GridOptimization = 16387
     }
@@ -287,7 +287,7 @@ export declare namespace DeviceEnergyManagementMode {
     /**
      * 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>);
@@ -303,7 +303,7 @@ export declare namespace DeviceEnergyManagementMode {
          * 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;
 
@@ -311,7 +311,7 @@ export declare namespace DeviceEnergyManagementMode {
          * 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 | ModeBase.ModeTag;
     }