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

package/src/clusters/rvc-clean-mode.ts

@@ -10,8 +10,12 @@ import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
 import { BitFlag } from "../schema/BitmapSchema.js";
 import { FixedAttribute, Attribute, 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";
 
@@ -33,13 +37,6 @@ export namespace RvcCleanMode {
         OnOff = "OnOff"
     }
 
-    export enum ModeChangeStatus {
-        /**
-         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.1
-         */
-        CleaningInProgress = 64
-    }
-
     export enum ModeTag {
         /**
          * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2
@@ -58,7 +55,227 @@ export namespace RvcCleanMode {
          *
          * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.2.3
          */
-        Mop = 16386
+        Mop = 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 Vacuum and/or the Mop mode tag in the
+     * ModeTags field list.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 7.3.5.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 Vacuum and/or the Mop mode tag in the
+     * ModeTags field list.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 7.3.5.1
+     */
+    export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
+
+    export enum ModeChangeStatus {
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 7.3.7.1
+         */
+        CleaningInProgress = 64,
+
+        /**
+         * 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.v13.Cluster} § 1.10.7.2.1.2
+         */
+        Success = 0,
+
+        /**
+         * The value of the NewMode field doesn’t match any entries in the SupportedMode attribute.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.2.1.2
+         */
+        UnsupportedMode = 1,
+
+        /**
+         * Generic failure code, indicating that switching to the mode indicated by the NewMode field is not allowed or
+         * not possible.
+         *
+         * @see {@link MatterSpecification.v13.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.v13.Cluster} § 1.10.7.2.1.2
+         */
+        InvalidInMode = 3
     }
 
     /**
@@ -87,7 +304,7 @@ export namespace RvcCleanMode {
              */
             supportedModes: FixedAttribute(
                 0x0,
-                TlvArray(ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 }),
+                TlvArray(TlvModeOption, { minLength: 2, maxLength: 255 }),
                 { default: [] }
             ),
 

package/src/clusters/rvc-operational-state.ts

@@ -18,9 +18,11 @@ import {
 import { TlvArray } from "../tlv/TlvArray.js";
 import { TlvString } from "../tlv/TlvString.js";
 import { TlvNullable } from "../tlv/TlvNullable.js";
-import { TlvUInt8, TlvUInt32 } from "../tlv/TlvNumber.js";
-import { OperationalState as OperationalStateNamespace } from "./operational-state.js";
+import { TlvUInt8, TlvUInt32, TlvEnum } from "../tlv/TlvNumber.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { TlvNoArguments } from "../tlv/TlvNoArguments.js";
+import { OperationalState as OperationalStateNamespace } from "./operational-state.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
@@ -62,6 +64,36 @@ export namespace RvcOperationalState {
         Docked = 66
     }
 
+    /**
+     * The OperationalStateStruct is used to indicate a possible state of the device.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2
+     */
+    export const TlvOperationalStateStruct = TlvObject({
+        /**
+         * This shall be populated with a value from the OperationalStateEnum.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2.1
+         */
+        operationalStateId: TlvField(0, TlvEnum<OperationalState>()),
+
+        /**
+         * This field shall be present if the OperationalStateID is from the set reserved for Manufacturer Specific
+         * States, otherwise it shall NOT be present. If present, this shall contain a human-readable description of
+         * the operational state.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2.2
+         */
+        operationalStateLabel: TlvOptionalField(1, TlvString.bound({ maxLength: 64 }))
+    });
+
+    /**
+     * The OperationalStateStruct is used to indicate a possible state of the device.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.2
+     */
+    export interface OperationalStateStruct extends TypeFromSchema<typeof TlvOperationalStateStruct> {}
+
     /**
      * The values defined herein are applicable to this derived cluster of Operational State only and are additional to
      * the set of values defined in Operational State itself.
@@ -110,6 +142,79 @@ export namespace RvcOperationalState {
         MopCleaningPadMissing = 71
     }
 
+    /**
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4
+     */
+    export const TlvErrorStateStruct = TlvObject({
+        /**
+         * This shall be populated with a value from the ErrorStateEnum.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.1
+         */
+        errorStateId: TlvField(0, TlvEnum<ErrorState>()),
+
+        /**
+         * This field shall be present if the ErrorStateID is from the set reserved for Manufacturer Specific Errors,
+         * otherwise it shall NOT be present. If present, this shall contain a human-readable description of the
+         * ErrorStateID; e.g. for a manufacturer specific ErrorStateID of "0x80" the ErrorStateLabel may contain "My
+         * special error".
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.2
+         */
+        errorStateLabel: TlvOptionalField(1, TlvString.bound({ maxLength: 64 })),
+
+        /**
+         * This shall be a human-readable string that provides details about the error condition. As an example, if the
+         * ErrorStateID indicates that the device is a Robotic Vacuum that is stuck, the ErrorStateDetails contains
+         * "left wheel blocked".
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4.3
+         */
+        errorStateDetails: TlvOptionalField(2, TlvString.bound({ maxLength: 64 }))
+    });
+
+    /**
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.4.4
+     */
+    export interface ErrorStateStruct extends TypeFromSchema<typeof TlvErrorStateStruct> {}
+
+    /**
+     * Input to the RvcOperationalState operationalCommandResponse command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 7.4.5
+     */
+    export const TlvOperationalCommandResponse = TlvObject({
+        /**
+         * This shall indicate the success or otherwise of the attempted command invocation. On a successful invocation
+         * of the attempted command, the ErrorStateID shall be populated with NoError. Please see the individual
+         * command sections for additional specific requirements on population.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.5.1
+         */
+        commandResponseState: TlvField(0, TlvErrorStateStruct)
+    });
+
+    /**
+     * Input to the RvcOperationalState operationalCommandResponse command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 7.4.5
+     */
+    export interface OperationalCommandResponse extends TypeFromSchema<typeof TlvOperationalCommandResponse> {}
+
+    /**
+     * Body of the RvcOperationalState operationalError event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+     */
+    export const TlvOperationalErrorEvent = TlvObject({ errorState: TlvField(0, TlvErrorStateStruct) });
+
+    /**
+     * Body of the RvcOperationalState operationalError event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+     */
+    export interface OperationalErrorEvent extends TypeFromSchema<typeof TlvOperationalErrorEvent> {}
+
     /**
      * @see {@link Cluster}
      */
@@ -176,11 +281,7 @@ export namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.4
              */
-            operationalStateList: Attribute(
-                0x3,
-                TlvArray(OperationalStateNamespace.TlvOperationalStateStruct),
-                { default: [] }
-            ),
+            operationalStateList: Attribute(0x3, TlvArray(TlvOperationalStateStruct), { default: [] }),
 
             /**
              * This attribute specifies the current operational state of a device. This shall be populated with a valid
@@ -188,7 +289,7 @@ export namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.5
              */
-            operationalState: Attribute(0x4, TlvUInt8),
+            operationalState: Attribute(0x4, TlvEnum<OperationalState>()),
 
             /**
              * This attribute shall specify the details of any current error condition being experienced on the device
@@ -199,7 +300,7 @@ export namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.6
              */
-            operationalError: Attribute(0x5, OperationalStateNamespace.TlvErrorState)
+            operationalError: Attribute(0x5, TlvErrorStateStruct)
         },
 
         commands: {
@@ -223,7 +324,7 @@ export namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 7.4.5.1
              */
-            goHome: OptionalCommand(0x80, TlvNoArguments, 0x4, OperationalStateNamespace.TlvOperationalCommandResponse)
+            goHome: OptionalCommand(0x80, TlvNoArguments, 0x4, TlvOperationalCommandResponse)
         },
 
         events: {
@@ -235,7 +336,7 @@ export namespace RvcOperationalState {
              *
              * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
              */
-            operationalError: Event(0x0, EventPriority.Critical, OperationalStateNamespace.TlvOperationalErrorEvent),
+            operationalError: Event(0x0, EventPriority.Critical, TlvOperationalErrorEvent),
 
             /**
              * This event is generated when the overall operation ends, successfully or otherwise. For example, the