@matter/types 0.13.0-alpha.0-20250329-cd36948da → 0.13.0-alpha.0-20250330-df5a17eba

package/src/clusters/descriptor.ts

@@ -24,7 +24,7 @@ export namespace Descriptor {
     /**
      * These are optional features supported by DescriptorCluster.
      *
-     * @see {@link MatterSpecification.v13.Core} § 9.5.4
+     * @see {@link MatterSpecification.v14.Core} § 9.5.4
      */
     export enum Feature {
         /**
@@ -33,7 +33,7 @@ export namespace Descriptor {
          * See the Disambiguation section in the System Model spec for conformance requirements for this feature and the
          * corresponding attribute.
          *
-         * @see {@link MatterSpecification.v13.Core} § 9.5.4.1
+         * @see {@link MatterSpecification.v14.Core} § 9.5.4.1
          */
         TagList = "TagList"
     }
@@ -42,14 +42,14 @@ export 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.v13.Core} § 9.5.5.1
+     * @see {@link MatterSpecification.v14.Core} § 9.5.5.1
      */
     export const TlvDeviceType = TlvObject({
         /**
          * 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.v13.Core} § 9.5.5.1.1
+         * @see {@link MatterSpecification.v14.Core} § 9.5.5.1.1
          */
         deviceType: TlvField(0, TlvDeviceTypeId),
 
@@ -57,7 +57,7 @@ export 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.v13.Core} § 9.5.5.1.2
+         * @see {@link MatterSpecification.v14.Core} § 9.5.5.1.2
          */
         revision: TlvField(1, TlvUInt16.bound({ min: 1 }))
     });
@@ -66,7 +66,7 @@ export 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.v13.Core} § 9.5.5.1
+     * @see {@link MatterSpecification.v14.Core} § 9.5.5.1
      */
     export interface DeviceType extends TypeFromSchema<typeof TlvDeviceType> {}
 
@@ -94,7 +94,7 @@ export 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.v13.Core} § 9.5.6.5
+             * @see {@link MatterSpecification.v14.Core} § 9.5.6.5
              */
             tagList: FixedAttribute(0x4, TlvArray(TlvSemtag, { minLength: 1, maxLength: 6 }))
         }
@@ -115,7 +115,7 @@ export namespace Descriptor {
              * See the Disambiguation section in the System Model spec for conformance requirements for this feature and
              * the corresponding attribute.
              *
-             * @see {@link MatterSpecification.v13.Core} § 9.5.4.1
+             * @see {@link MatterSpecification.v14.Core} § 9.5.4.1
              */
             tagList: BitFlag(0)
         },
@@ -129,21 +129,21 @@ export 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.v13.Core} § 9.5.6.1
+             * @see {@link MatterSpecification.v14.Core} § 9.5.6.1
              */
             deviceTypeList: FixedAttribute(0x0, TlvArray(TlvDeviceType, { minLength: 1 })),
 
             /**
              * This attribute shall list each cluster ID for the server clusters present on the endpoint instance.
              *
-             * @see {@link MatterSpecification.v13.Core} § 9.5.6.2
+             * @see {@link MatterSpecification.v14.Core} § 9.5.6.2
              */
             serverList: FixedAttribute(0x1, TlvArray(TlvClusterId), { default: [] }),
 
             /**
              * This attribute shall list each cluster ID for the client clusters present on the endpoint instance.
              *
-             * @see {@link MatterSpecification.v13.Core} § 9.5.6.3
+             * @see {@link MatterSpecification.v14.Core} § 9.5.6.3
              */
             clientList: FixedAttribute(0x2, TlvArray(TlvClusterId), { default: [] }),
 
@@ -153,7 +153,7 @@ export namespace Descriptor {
              *
              * See Endpoint Composition for more information about which endpoints to include in this list.
              *
-             * @see {@link MatterSpecification.v13.Core} § 9.5.6.4
+             * @see {@link MatterSpecification.v14.Core} § 9.5.6.4
              */
             partsList: Attribute(0x3, TlvArray(TlvEndpointNumber), { default: [] })
         },
@@ -188,7 +188,7 @@ export namespace Descriptor {
      * DescriptorCluster supports optional features that you can enable with the DescriptorCluster.with() factory
      * method.
      *
-     * @see {@link MatterSpecification.v13.Core} § 9.5
+     * @see {@link MatterSpecification.v14.Core} § 9.5
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

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

@@ -23,7 +23,7 @@ export namespace DeviceEnergyManagementMode {
     /**
      * These are optional features supported by DeviceEnergyManagementModeCluster.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 9.8.4
+     * @see {@link MatterSpecification.v14.Cluster} § 9.8.4
      */
     export enum Feature {
         /**
@@ -36,52 +36,52 @@ export namespace DeviceEnergyManagementMode {
 
     export enum ModeTag {
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         Auto = 0,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         Quick = 1,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         Quiet = 2,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         LowNoise = 3,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         LowEnergy = 4,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         Vacation = 5,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         Min = 6,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         Max = 7,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         Night = 8,
 
         /**
-         * @see {@link MatterSpecification.v13.Cluster} § 9.8.7.1
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1
          */
         Day = 9,
 
@@ -89,28 +89,28 @@ export 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.v13.Cluster} § 9.8.7.1.1
+         * @see {@link MatterSpecification.v14.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.v13.Cluster} § 9.8.7.1.2
+         * @see {@link MatterSpecification.v14.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.v13.Cluster} § 9.8.7.1.3
+         * @see {@link MatterSpecification.v14.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.v13.Cluster} § 9.8.7.1.4
+         * @see {@link MatterSpecification.v14.Cluster} § 9.8.7.1.4
          */
         GridOptimization = 16387
     }
@@ -118,7 +118,7 @@ export namespace DeviceEnergyManagementMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1
      */
     export const TlvModeTagStruct = TlvObject({
         /**
@@ -132,7 +132,7 @@ export 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.v13.Cluster} § 1.10.5.1.1
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1.1
          */
         mfgCode: TlvOptionalField(0, TlvVendorId),
 
@@ -140,7 +140,7 @@ export namespace DeviceEnergyManagementMode {
          * This field shall indicate the mode tag within a mode tag namespace which is either manufacturer specific or
          * standard.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1.2
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1.2
          */
         value: TlvField(1, TlvEnum<ModeTag | ModeBase.ModeTag>())
     });
@@ -148,7 +148,7 @@ export namespace DeviceEnergyManagementMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1
      */
     export interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {}
 
@@ -156,7 +156,7 @@ export 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.v13.Cluster} § 9.8.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 9.8.5.1
      */
     export const TlvModeOption = TlvObject({
         /**
@@ -164,14 +164,14 @@ export 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.v13.Cluster} § 1.10.5.2.1
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.2.1
          */
         label: TlvField(0, TlvString.bound({ maxLength: 64 })),
 
         /**
          * This field is used to identify the mode option.
          *
-         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.2
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.2.2
          */
         mode: TlvField(1, TlvUInt8),
 
@@ -209,7 +209,7 @@ export 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.v13.Cluster} § 1.10.5.2.3
+         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.2.3
          */
         modeTags: TlvField(2, TlvArray(TlvModeTagStruct, { maxLength: 8 }))
     });
@@ -218,7 +218,7 @@ export 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.v13.Cluster} § 9.8.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 9.8.5.1
      */
     export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
 
@@ -253,7 +253,7 @@ export 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.v13.Cluster} § 9.8.6.1
+             * @see {@link MatterSpecification.v14.Cluster} § 9.8.6.1
              */
             supportedModes: FixedAttribute(
                 0x0,
@@ -262,7 +262,7 @@ export namespace DeviceEnergyManagementMode {
             ),
 
             /**
-             * @see {@link MatterSpecification.v13.Cluster} § 9.8.6
+             * @see {@link MatterSpecification.v14.Cluster} § 9.8.6
              */
             currentMode: Attribute(0x1, TlvUInt8, { persistent: true })
         },
@@ -273,7 +273,7 @@ export namespace DeviceEnergyManagementMode {
              *
              * On receipt of this command the device shall respond with a ChangeToModeResponse command.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.1
              */
             changeToMode: Command(0x0, ModeBase.TlvChangeToModeRequest, 0x1, ModeBase.TlvChangeToModeResponse)
         },
@@ -297,7 +297,7 @@ export namespace DeviceEnergyManagementMode {
      * DeviceEnergyManagementModeCluster supports optional features that you can enable with the
      * DeviceEnergyManagementModeCluster.with() factory method.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 9.8
+     * @see {@link MatterSpecification.v14.Cluster} § 9.8
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}