@matter/types 0.11.9-alpha.0-20241205-ccf69a00a → 0.11.9-alpha.0-20241207-b604cfa44

package/src/clusters/dishwasher-mode.ts

@@ -10,8 +10,12 @@ import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
 import { FixedAttribute, Attribute, WritableAttribute, Command, TlvNoResponse } from "../cluster/Cluster.js";
 import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvUInt8, TlvEnum } from "../tlv/TlvNumber.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { ModeBase } from "./mode-base.js";
-import { TlvUInt8 } from "../tlv/TlvNumber.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
@@ -53,9 +57,190 @@ export namespace DishwasherMode {
          *
          * @see {@link MatterSpecification.v13.Cluster} § 8.3.6.1.3
          */
-        Light = 16386
+        Light = 16386,
+
+        /**
+         * The device decides which options, features and setting values to use.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Auto = 0,
+
+        /**
+         * The mode of the device is optimizing for faster completion.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quick = 1,
+
+        /**
+         * The device is silent or barely audible while in this mode.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quiet = 2,
+
+        /**
+         * Either the mode is inherently low noise or the device optimizes for that.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        LowNoise = 3,
+
+        /**
+         * The device is optimizing for lower energy usage in this mode. Sometimes called "Eco mode".
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        LowEnergy = 4,
+
+        /**
+         * A mode suitable for use during vacations or other extended absences.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Vacation = 5,
+
+        /**
+         * The mode uses the lowest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Min = 6,
+
+        /**
+         * The mode uses the highest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Max = 7,
+
+        /**
+         * The mode is recommended or suitable for use during night time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Night = 8,
+
+        /**
+         * The mode is recommended or suitable for use during day time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Day = 9
     }
 
+    /**
+     * 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
+     */
+    export const TlvModeTagStruct = TlvObject({
+        /**
+         * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+         * 1.10.8, “Mode Namespace”).
+         *
+         * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+         *
+         * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+         * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+         * 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
+         */
+        mfgCode: TlvOptionalField(0, TlvVendorId),
+
+        /**
+         * 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
+         */
+        value: TlvField(1, TlvEnum<ModeTag>())
+    });
+
+    /**
+     * 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
+     */
+    export interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {}
+
+    /**
+     * 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.
+     *
+     * At least one entry in the SupportedModes attribute shall include the Normal mode tag in the ModeTags field list.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 8.3.4.1
+     */
+    export const TlvModeOption = TlvObject({
+        /**
+         * This field shall indicate readable text that describes the mode option, so that a client can provide it to
+         * 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
+         */
+        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
+         */
+        mode: TlvField(1, TlvUInt8),
+
+        /**
+         * This field shall contain a list of tags that are associated with the mode option. This may 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.
+         *
+         * The standard mode tags are defined in this cluster specification. For the derived cluster instances, if the
+         * specification of the derived cluster defines a namespace, the set of standard mode tags also includes the
+         * mode tag values from that namespace.
+         *
+         * Mode tags can help clients look for options that meet certain criteria, render the user interface, use
+         *
+         * the mode in an automation, or to craft help text their voice-driven interfaces. A mode tag shall be either a
+         * standard tag or a manufacturer specific tag, as defined in each ModeTagStruct list entry.
+         *
+         * A mode option may have more than one mode tag. A mode option may be associated with a mixture of standard
+         * and manufacturer specific mode tags. A mode option shall be associated with at least one standard mode tag.
+         *
+         * A few examples are provided below.
+         *
+         *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
+         *     seeking the mode for either High or Max will find the same mode in this case.
+         *
+         *   • A mode that includes a LowEnergy tag can be displayed by the client using a widget icon that shows a
+         *     green leaf.
+         *
+         *   • A mode that includes a LowNoise tag may be used by the client when the user wishes for a lower level of
+         *     audible sound, less likely to disturb the household’s activities.
+         *
+         *   • A mode that includes a LowEnergy tag (standard, defined in this cluster specification) and also a
+         *     Delicate tag (standard, defined in the namespace of a Laundry Mode derived cluster).
+         *
+         *   • 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
+         */
+        modeTags: TlvField(2, TlvArray(TlvModeTagStruct, { maxLength: 8 }))
+    });
+
+    /**
+     * 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.
+     *
+     * At least one entry in the SupportedModes attribute shall include the Normal mode tag in the ModeTags field list.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 8.3.4.1
+     */
+    export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
+
     /**
      * These elements and properties are present in all DishwasherMode clusters.
      */
@@ -82,7 +267,7 @@ export namespace DishwasherMode {
              */
             supportedModes: FixedAttribute(
                 0x0,
-                TlvArray(ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 }),
+                TlvArray(TlvModeOption, { minLength: 2, maxLength: 255 }),
                 { default: [] }
             ),
 

package/src/clusters/door-lock.ts

@@ -2124,7 +2124,87 @@ export namespace DoorLock {
         pinCodeChanged: BitFlag(1),
         pinAdded: BitFlag(2),
         pinCleared: BitFlag(3),
-        pinChanged: BitFlag(4)
+        pinChanged: BitFlag(4),
+
+        /**
+         * State of bit 0
+         */
+        bit0: BitFlag(0),
+
+        /**
+         * State of bit 1
+         */
+        bit1: BitFlag(1),
+
+        /**
+         * State of bit 2
+         */
+        bit2: BitFlag(2),
+
+        /**
+         * State of bit 3
+         */
+        bit3: BitFlag(3),
+
+        /**
+         * State of bit 4
+         */
+        bit4: BitFlag(4),
+
+        /**
+         * State of bit 5
+         */
+        bit5: BitFlag(5),
+
+        /**
+         * State of bit 6
+         */
+        bit6: BitFlag(6),
+
+        /**
+         * State of bit 7
+         */
+        bit7: BitFlag(7),
+
+        /**
+         * State of bit 8
+         */
+        bit8: BitFlag(8),
+
+        /**
+         * State of bit 9
+         */
+        bit9: BitFlag(9),
+
+        /**
+         * State of bit 10
+         */
+        bit10: BitFlag(10),
+
+        /**
+         * State of bit 11
+         */
+        bit11: BitFlag(11),
+
+        /**
+         * State of bit 12
+         */
+        bit12: BitFlag(12),
+
+        /**
+         * State of bit 13
+         */
+        bit13: BitFlag(13),
+
+        /**
+         * State of bit 14
+         */
+        bit14: BitFlag(14),
+
+        /**
+         * State of bit 15
+         */
+        bit15: BitFlag(15)
     };
 
     /**
@@ -2138,7 +2218,87 @@ export namespace DoorLock {
         pinCleared: BitFlag(3),
         pinChanged: BitFlag(4),
         rfidCodeAdded: BitFlag(5),
-        rfidCodeCleared: BitFlag(6)
+        rfidCodeCleared: BitFlag(6),
+
+        /**
+         * State of bit 0
+         */
+        bit0: BitFlag(0),
+
+        /**
+         * State of bit 1
+         */
+        bit1: BitFlag(1),
+
+        /**
+         * State of bit 2
+         */
+        bit2: BitFlag(2),
+
+        /**
+         * State of bit 3
+         */
+        bit3: BitFlag(3),
+
+        /**
+         * State of bit 4
+         */
+        bit4: BitFlag(4),
+
+        /**
+         * State of bit 5
+         */
+        bit5: BitFlag(5),
+
+        /**
+         * State of bit 6
+         */
+        bit6: BitFlag(6),
+
+        /**
+         * State of bit 7
+         */
+        bit7: BitFlag(7),
+
+        /**
+         * State of bit 8
+         */
+        bit8: BitFlag(8),
+
+        /**
+         * State of bit 9
+         */
+        bit9: BitFlag(9),
+
+        /**
+         * State of bit 10
+         */
+        bit10: BitFlag(10),
+
+        /**
+         * State of bit 11
+         */
+        bit11: BitFlag(11),
+
+        /**
+         * State of bit 12
+         */
+        bit12: BitFlag(12),
+
+        /**
+         * State of bit 13
+         */
+        bit13: BitFlag(13),
+
+        /**
+         * State of bit 14
+         */
+        bit14: BitFlag(14),
+
+        /**
+         * State of bit 15
+         */
+        bit15: BitFlag(15)
     };
 
     /**
@@ -2146,7 +2306,91 @@ export namespace DoorLock {
      *
      * @see {@link MatterSpecification.v13.Cluster} § 5.2.9.47
      */
-    export const RfidProgrammingEventMask = { unknown: BitFlag(0), idAdded: BitFlag(5), idCleared: BitFlag(6) };
+    export const RfidProgrammingEventMask = {
+        unknown: BitFlag(0),
+        idAdded: BitFlag(5),
+        idCleared: BitFlag(6),
+
+        /**
+         * State of bit 0
+         */
+        bit0: BitFlag(0),
+
+        /**
+         * State of bit 1
+         */
+        bit1: BitFlag(1),
+
+        /**
+         * State of bit 2
+         */
+        bit2: BitFlag(2),
+
+        /**
+         * State of bit 3
+         */
+        bit3: BitFlag(3),
+
+        /**
+         * State of bit 4
+         */
+        bit4: BitFlag(4),
+
+        /**
+         * State of bit 5
+         */
+        bit5: BitFlag(5),
+
+        /**
+         * State of bit 6
+         */
+        bit6: BitFlag(6),
+
+        /**
+         * State of bit 7
+         */
+        bit7: BitFlag(7),
+
+        /**
+         * State of bit 8
+         */
+        bit8: BitFlag(8),
+
+        /**
+         * State of bit 9
+         */
+        bit9: BitFlag(9),
+
+        /**
+         * State of bit 10
+         */
+        bit10: BitFlag(10),
+
+        /**
+         * State of bit 11
+         */
+        bit11: BitFlag(11),
+
+        /**
+         * State of bit 12
+         */
+        bit12: BitFlag(12),
+
+        /**
+         * State of bit 13
+         */
+        bit13: BitFlag(13),
+
+        /**
+         * State of bit 14
+         */
+        bit14: BitFlag(14),
+
+        /**
+         * State of bit 15
+         */
+        bit15: BitFlag(15)
+    };
 
     /**
      * Input to the DoorLock setUserStatus command

package/src/clusters/energy-evse-mode.ts

@@ -15,10 +15,14 @@ import {
     Command,
     TlvNoResponse
 } from "../cluster/Cluster.js";
-import { TlvUInt8 } from "../tlv/TlvNumber.js";
+import { TlvUInt8, TlvEnum } from "../tlv/TlvNumber.js";
 import { TlvNullable } from "../tlv/TlvNullable.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
 import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { ModeBase } from "./mode-base.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
@@ -64,9 +68,184 @@ export namespace EnergyEvseMode {
          *
          * @see {@link MatterSpecification.v13.Cluster} § 9.4.4.1.3
          */
-        SolarCharging = 16386
+        SolarCharging = 16386,
+
+        /**
+         * The device decides which options, features and setting values to use.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Auto = 0,
+
+        /**
+         * The mode of the device is optimizing for faster completion.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quick = 1,
+
+        /**
+         * The device is silent or barely audible while in this mode.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Quiet = 2,
+
+        /**
+         * Either the mode is inherently low noise or the device optimizes for that.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        LowNoise = 3,
+
+        /**
+         * The device is optimizing for lower energy usage in this mode. Sometimes called "Eco mode".
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        LowEnergy = 4,
+
+        /**
+         * A mode suitable for use during vacations or other extended absences.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Vacation = 5,
+
+        /**
+         * The mode uses the lowest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Min = 6,
+
+        /**
+         * The mode uses the highest available setting value.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Max = 7,
+
+        /**
+         * The mode is recommended or suitable for use during night time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Night = 8,
+
+        /**
+         * The mode is recommended or suitable for use during day time.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.8
+         */
+        Day = 9
     }
 
+    /**
+     * 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
+     */
+    export const TlvModeTagStruct = TlvObject({
+        /**
+         * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+         * 1.10.8, “Mode Namespace”).
+         *
+         * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+         *
+         * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+         * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+         * 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
+         */
+        mfgCode: TlvOptionalField(0, TlvVendorId),
+
+        /**
+         * 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
+         */
+        value: TlvField(1, TlvEnum<ModeTag>())
+    });
+
+    /**
+     * 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
+     */
+    export interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {}
+
+    /**
+     * This is a struct representing a possible mode of the server.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2
+     */
+    export const TlvModeOption = TlvObject({
+        /**
+         * This field shall indicate readable text that describes the mode option, so that a client can provide it to
+         * 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
+         */
+        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
+         */
+        mode: TlvField(1, TlvUInt8),
+
+        /**
+         * This field shall contain a list of tags that are associated with the mode option. This may 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.
+         *
+         * The standard mode tags are defined in this cluster specification. For the derived cluster instances, if the
+         * specification of the derived cluster defines a namespace, the set of standard mode tags also includes the
+         * mode tag values from that namespace.
+         *
+         * Mode tags can help clients look for options that meet certain criteria, render the user interface, use
+         *
+         * the mode in an automation, or to craft help text their voice-driven interfaces. A mode tag shall be either a
+         * standard tag or a manufacturer specific tag, as defined in each ModeTagStruct list entry.
+         *
+         * A mode option may have more than one mode tag. A mode option may be associated with a mixture of standard
+         * and manufacturer specific mode tags. A mode option shall be associated with at least one standard mode tag.
+         *
+         * A few examples are provided below.
+         *
+         *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
+         *     seeking the mode for either High or Max will find the same mode in this case.
+         *
+         *   • A mode that includes a LowEnergy tag can be displayed by the client using a widget icon that shows a
+         *     green leaf.
+         *
+         *   • A mode that includes a LowNoise tag may be used by the client when the user wishes for a lower level of
+         *     audible sound, less likely to disturb the household’s activities.
+         *
+         *   • A mode that includes a LowEnergy tag (standard, defined in this cluster specification) and also a
+         *     Delicate tag (standard, defined in the namespace of a Laundry Mode derived cluster).
+         *
+         *   • 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
+         */
+        modeTags: TlvField(2, TlvArray(TlvModeTagStruct, { maxLength: 8 }))
+    });
+
+    /**
+     * This is a struct representing a possible mode of the server.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2
+     */
+    export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
+
     /**
      * A EnergyEvseModeCluster supports these elements if it supports feature OnOff.
      */
@@ -116,7 +295,7 @@ export namespace EnergyEvseMode {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.10.6.2
              */
-            supportedModes: FixedAttribute(0x0, TlvArray(ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 })),
+            supportedModes: FixedAttribute(0x0, TlvArray(TlvModeOption, { minLength: 2, maxLength: 255 })),
 
             /**
              * Indicates the current mode of the server.

package/src/clusters/fan-control.ts

@@ -213,6 +213,9 @@ export namespace FanControl {
          */
         High = 3,
 
+        /**
+         * @deprecated
+         */
         On = 4,
 
         /**
@@ -222,6 +225,8 @@ export namespace FanControl {
 
         /**
          * Fan is using smart mode
+         *
+         * @deprecated
          */
         Smart = 6
     }