@matter/types 0.14.0-alpha.0-20250601-939a65f46 → 0.14.0-alpha.0-20250603-af0cad2ff

package/src/clusters/water-heater-management.ts

@@ -31,7 +31,7 @@ export namespace WaterHeaterManagement {
     /**
      * These are optional features supported by WaterHeaterManagementCluster.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.4
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.4
      */
     export enum Feature {
         /**
@@ -50,7 +50,7 @@ export namespace WaterHeaterManagement {
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.1
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.1
      */
     export const WaterHeaterHeatSource = {
         /**
@@ -80,7 +80,7 @@ export namespace WaterHeaterManagement {
     };
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.2
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.2
      */
     export enum BoostState {
         /**
@@ -95,13 +95,13 @@ export namespace WaterHeaterManagement {
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.3
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.3
      */
     export const TlvWaterHeaterBoostInfo = TlvObject({
         /**
          * This field shall indicate the time period, in seconds, for which the boost state is activated.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.3.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.3.1
          */
         duration: TlvField(0, TlvUInt32.bound({ min: 1 })),
 
@@ -115,7 +115,7 @@ export namespace WaterHeaterManagement {
          *
          *   • the TargetPercentage (if specified).
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.3.2
+         * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.3.2
          */
         oneShot: TlvOptionalField(1, TlvBoolean),
 
@@ -125,7 +125,7 @@ export namespace WaterHeaterManagement {
          *
          * The choice of which heat sources are activated is manufacturer specific.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.3.3
+         * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.3.3
          */
         emergencyBoost: TlvOptionalField(2, TlvBoolean),
 
@@ -138,7 +138,7 @@ export namespace WaterHeaterManagement {
          * The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
          * attributes (inclusive), of the thermostat cluster.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.3.4
+         * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.3.4
          */
         temporarySetpoint: TlvOptionalField(3, TlvInt16),
 
@@ -146,7 +146,7 @@ export namespace WaterHeaterManagement {
          * This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
          * must reach before the heating is switched off.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.3.5
+         * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.3.5
          */
         targetPercentage: TlvOptionalField(4, TlvPercent),
 
@@ -161,41 +161,41 @@ export namespace WaterHeaterManagement {
          *
          * This field shall be less than or equal to the TargetPercentage field.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.3.6
+         * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.3.6
          */
         targetReheat: TlvOptionalField(5, TlvPercent)
     });
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.6.3
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.6.3
      */
     export interface WaterHeaterBoostInfo extends TypeFromSchema<typeof TlvWaterHeaterBoostInfo> {}
 
     /**
      * Input to the WaterHeaterManagement boost command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.8.1
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.8.1
      */
     export const TlvBoostRequest = TlvObject({ boostInfo: TlvField(0, TlvWaterHeaterBoostInfo) });
 
     /**
      * Input to the WaterHeaterManagement boost command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.8.1
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.8.1
      */
     export interface BoostRequest extends TypeFromSchema<typeof TlvBoostRequest> {}
 
     /**
      * Body of the WaterHeaterManagement boostStarted event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.9.1
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.9.1
      */
     export const TlvBoostStartedEvent = TlvObject({ boostInfo: TlvField(0, TlvWaterHeaterBoostInfo) });
 
     /**
      * Body of the WaterHeaterManagement boostStarted event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5.9.1
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5.9.1
      */
     export interface BoostStartedEvent extends TypeFromSchema<typeof TlvBoostStartedEvent> {}
 
@@ -208,7 +208,7 @@ export namespace WaterHeaterManagement {
              * Indicates the volume of water that the hot water tank can hold (in units of Litres). This allows an
              * energy management system to estimate the required heating energy needed to reach the target temperature.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.7.3
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.7.3
              */
             tankVolume: Attribute(0x2, TlvUInt16, { default: 0 }),
 
@@ -251,7 +251,7 @@ export namespace WaterHeaterManagement {
              *   for 1kWh of electrical energy input. The conversion between heat energy and electrical energy is
              *   outside the scope of this cluster.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.7.4
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.7.4
              */
             estimatedHeatRequired: Attribute(0x3, TlvInt64.bound({ min: 0 }), { default: 0 })
         }
@@ -289,7 +289,7 @@ export namespace WaterHeaterManagement {
              *
              * ### TankPercentage = 50%
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.7.5
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.7.5
              */
             tankPercentage: Attribute(0x4, TlvPercent, { default: 0 })
         }
@@ -320,7 +320,7 @@ export namespace WaterHeaterManagement {
              * Indicates the heat sources that the water heater can call on for heating. If a bit is set then the water
              * heater supports the corresponding heat source.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.7.1
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.7.1
              */
             heaterTypes: FixedAttribute(0x0, TlvBitmap(TlvUInt8, WaterHeaterHeatSource)),
 
@@ -328,7 +328,7 @@ export namespace WaterHeaterManagement {
              * Indicates if the water heater is heating water. If a bit is set then the corresponding heat source is
              * active.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.7.2
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.7.2
              */
             heatDemand: Attribute(0x1, TlvBitmap(TlvUInt8, WaterHeaterHeatSource)),
 
@@ -337,7 +337,7 @@ export namespace WaterHeaterManagement {
              *
              * See Boost and CancelBoost commands for more details.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.7.6
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.7.6
              */
             boostState: Attribute(0x5, TlvEnum<BoostState>(), { default: BoostState.Inactive })
         },
@@ -346,14 +346,14 @@ export namespace WaterHeaterManagement {
             /**
              * Allows a client to request that the water heater is put into a Boost state.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.8.1
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.8.1
              */
             boost: Command(0x0, TlvBoostRequest, 0x0, TlvNoResponse, { invokeAcl: AccessLevel.Manage }),
 
             /**
              * Allows a client to cancel an ongoing Boost operation. This command has no payload.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.8.2
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.8.2
              */
             cancelBoost: Command(0x1, TlvNoArguments, 0x1, TlvNoResponse, { invokeAcl: AccessLevel.Manage })
         },
@@ -365,14 +365,14 @@ export namespace WaterHeaterManagement {
              * The corresponding structure fields within the WaterHeaterBoostInfoStruct are copied from the Boost
              * command.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.9.1
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.9.1
              */
             boostStarted: Event(0x0, EventPriority.Info, TlvBoostStartedEvent),
 
             /**
              * This event shall be generated whenever the BoostState transitions from Active to Inactive.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.5.9.2
+             * @see {@link MatterSpecification.v141.Cluster} § 9.5.9.2
              */
             boostEnded: Event(0x1, EventPriority.Info, TlvNoArguments)
         },
@@ -402,7 +402,7 @@ export namespace WaterHeaterManagement {
      * WaterHeaterManagementCluster supports optional features that you can enable with the
      * WaterHeaterManagementCluster.with() factory method.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 9.5
+     * @see {@link MatterSpecification.v141.Cluster} § 9.5
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/water-heater-mode.ts

@@ -23,7 +23,7 @@ export namespace WaterHeaterMode {
     /**
      * These are optional features supported by WaterHeaterModeCluster.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 9.6.4
+     * @see {@link MatterSpecification.v141.Cluster} § 9.6.4
      */
     export enum Feature {
         /**
@@ -36,59 +36,59 @@ export namespace WaterHeaterMode {
 
     export enum ModeTag {
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         Auto = 0,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         Quick = 1,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         Quiet = 2,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         LowNoise = 3,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         LowEnergy = 4,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         Vacation = 5,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         Min = 6,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         Max = 7,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         Night = 8,
 
         /**
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1
          */
         Day = 9,
 
         /**
          * While in modes with this tag, the device will not attempt to keep the water warm.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1.1
          */
         Off = 16384,
 
@@ -96,7 +96,7 @@ export namespace WaterHeaterMode {
          * While in modes with this tag, the device will attempt to keep the water warm based on the
          * OccupiedHeatingSetpoint attribute of the associated Thermostat cluster.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1.2
          */
         Manual = 16385,
 
@@ -104,7 +104,7 @@ export namespace WaterHeaterMode {
          * While in modes with this tag, the device will attempt to keep the water warm based on the Schedules attribute
          * of the associated Thermostat cluster.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 9.6.7.1.3
+         * @see {@link MatterSpecification.v141.Cluster} § 9.6.7.1.3
          */
         Timed = 16386
     }
@@ -112,7 +112,7 @@ export namespace WaterHeaterMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.1
      */
     export const TlvModeTagStruct = TlvObject({
         /**
@@ -126,7 +126,7 @@ export namespace WaterHeaterMode {
          * 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.v14.Cluster} § 1.10.5.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.1.1
          */
         mfgCode: TlvOptionalField(0, TlvVendorId),
 
@@ -134,7 +134,7 @@ export namespace WaterHeaterMode {
          * This field shall indicate the mode tag within a mode tag namespace which is either manufacturer specific or
          * standard.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.1.2
          */
         value: TlvField(1, TlvEnum<ModeTag | ModeBase.ModeTag>())
     });
@@ -142,7 +142,7 @@ export namespace WaterHeaterMode {
     /**
      * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.1
      */
     export interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {}
 
@@ -150,7 +150,7 @@ export namespace WaterHeaterMode {
      * 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.v14.Cluster} § 9.6.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 9.6.5.1
      */
     export const TlvModeOption = TlvObject({
         /**
@@ -158,14 +158,14 @@ export namespace WaterHeaterMode {
          * the user to indicate what this option means. This field is meant to be readable and understandable by the
          * user.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 1.10.5.2.1
+         * @see {@link MatterSpecification.v141.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.v14.Cluster} § 1.10.5.2.2
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.2.2
          */
         mode: TlvField(1, TlvUInt8),
 
@@ -202,7 +202,7 @@ export namespace WaterHeaterMode {
          *   • 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.v14.Cluster} § 1.10.5.2.3
+         * @see {@link MatterSpecification.v141.Cluster} § 1.10.5.2.3
          */
         modeTags: TlvField(2, TlvArray(TlvModeTagStruct, { maxLength: 8 }))
     });
@@ -211,7 +211,7 @@ export namespace WaterHeaterMode {
      * 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.v14.Cluster} § 9.6.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 9.6.5.1
      */
     export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
 
@@ -241,7 +241,7 @@ export namespace WaterHeaterMode {
              * An entry in the SupportedModes attribute that includes one of an Off, Manual, or Timed tag shall NOT also
              * include an additional instance of any one of these tag types.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 9.6.6.1
+             * @see {@link MatterSpecification.v141.Cluster} § 9.6.6.1
              */
             supportedModes: FixedAttribute(
                 0x0,
@@ -250,7 +250,7 @@ export namespace WaterHeaterMode {
             ),
 
             /**
-             * @see {@link MatterSpecification.v14.Cluster} § 9.6.6
+             * @see {@link MatterSpecification.v141.Cluster} § 9.6.6
              */
             currentMode: Attribute(0x1, TlvUInt8, { persistent: true })
         },
@@ -261,7 +261,7 @@ export namespace WaterHeaterMode {
              *
              * On receipt of this command the device shall respond with a ChangeToModeResponse command.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.10.7.1
+             * @see {@link MatterSpecification.v141.Cluster} § 1.10.7.1
              */
             changeToMode: Command(0x0, ModeBase.TlvChangeToModeRequest, 0x1, ModeBase.TlvChangeToModeResponse)
         },
@@ -285,7 +285,7 @@ export namespace WaterHeaterMode {
      * WaterHeaterModeCluster supports optional features that you can enable with the WaterHeaterModeCluster.with()
      * factory method.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 9.6
+     * @see {@link MatterSpecification.v141.Cluster} § 9.6
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}