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

package/dist/esm/clusters/dishwasher-mode.js

@@ -7,8 +7,11 @@ 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 { ModeBase } from "./mode-base.js";
-import { TlvUInt8 } from "../tlv/TlvNumber.js";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 var DishwasherMode;
 ((DishwasherMode2) => {
@@ -21,7 +24,93 @@ var DishwasherMode;
     ModeTag2[ModeTag2["Normal"] = 16384] = "Normal";
     ModeTag2[ModeTag2["Heavy"] = 16385] = "Heavy";
     ModeTag2[ModeTag2["Light"] = 16386] = "Light";
+    ModeTag2[ModeTag2["Auto"] = 0] = "Auto";
+    ModeTag2[ModeTag2["Quick"] = 1] = "Quick";
+    ModeTag2[ModeTag2["Quiet"] = 2] = "Quiet";
+    ModeTag2[ModeTag2["LowNoise"] = 3] = "LowNoise";
+    ModeTag2[ModeTag2["LowEnergy"] = 4] = "LowEnergy";
+    ModeTag2[ModeTag2["Vacation"] = 5] = "Vacation";
+    ModeTag2[ModeTag2["Min"] = 6] = "Min";
+    ModeTag2[ModeTag2["Max"] = 7] = "Max";
+    ModeTag2[ModeTag2["Night"] = 8] = "Night";
+    ModeTag2[ModeTag2["Day"] = 9] = "Day";
   })(ModeTag = DishwasherMode2.ModeTag || (DishwasherMode2.ModeTag = {}));
+  DishwasherMode2.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())
+  });
+  DishwasherMode2.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(DishwasherMode2.TlvModeTagStruct, { maxLength: 8 }))
+  });
   DishwasherMode2.Base = MutableCluster.Component({
     id: 89,
     name: "DishwasherMode",
@@ -43,7 +132,7 @@ var DishwasherMode;
        */
       supportedModes: FixedAttribute(
         0,
-        TlvArray(ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 }),
+        TlvArray(DishwasherMode2.TlvModeOption, { minLength: 2, maxLength: 255 }),
         { default: [] }
       ),
       /**

package/dist/esm/clusters/dishwasher-mode.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../../src/clusters/dishwasher-mode.ts"],
-  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B,SAAS,eAAe;AACxB,SAAS,gBAAgB,WAAW,mBAAmB,SAAS,qBAAqB;AACrF,SAAS,gBAAgB;AACzB,SAAS,gBAAgB;AACzB,SAAS,gBAAgB;AAEzB,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,oBAAV;AAMI,MAAK;AAAL,IAAKC,aAAL;AASH,IAAAA,SAAA,WAAQ;AAAA,KATA,UAAAD,gBAAA,YAAAA,gBAAA;AAYL,MAAK;AAAL,IAAKE,aAAL;AAMH,IAAAA,kBAAA,YAAS,SAAT;AAOA,IAAAA,kBAAA,WAAQ,SAAR;AAOA,IAAAA,kBAAA,WAAQ,SAAR;AAAA,KApBQ,UAAAF,gBAAA,YAAAA,gBAAA;AA0BL,EAAMA,gBAAA,OAAO,eAAe,UAAU;AAAA,IACzC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASN,OAAO,QAAQ,CAAC;AAAA,IACpB;AAAA,IAEA,YAAY;AAAA;AAAA;AAAA;AAAA,MAIR,gBAAgB;AAAA,QACZ;AAAA,QACA,SAAS,SAAS,eAAe,EAAE,WAAW,GAAG,WAAW,IAAI,CAAC;AAAA,QACjE,EAAE,SAAS,CAAC,EAAE;AAAA,MAClB;AAAA;AAAA;AAAA;AAAA,MAKA,aAAa,UAAU,GAAK,UAAU,EAAE,OAAO,MAAM,YAAY,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASvE,aAAa,kBAAkB,GAAK,UAAU,EAAE,YAAY,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA,MAKlE,QAAQ,kBAAkB,GAAK,UAAU,EAAE,YAAY,KAAK,CAAC;AAAA,IACjE;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQN,cAAc,QAAQ,GAAK,SAAS,wBAAwB,GAAK,aAAa;AAAA,IAClF;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,YAAY,eAAe,WAAW;AAAA,EAC1C,CAAC;AAKM,EAAMA,gBAAA,kBAAkB,eAAeA,gBAAA,IAAI;AAa3C,EAAMA,gBAAA,UAAmBA,gBAAA;AACzB,EAAMA,gBAAA,WAAWA,gBAAA;AAAA,GA9HX;AAkIV,MAAM,wBAAwB,eAAe;AACpD,gBAAgB,SAAS,eAAe,QAAQ;",
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B,SAAS,eAAe;AACxB,SAAS,gBAAgB,WAAW,mBAAmB,SAAS,qBAAqB;AACrF,SAAS,gBAAgB;AACzB,SAAS,UAAU,kBAAkB,iBAAiB;AACtD,SAAS,iBAAiB;AAC1B,SAAS,UAAU,eAAe;AAClC,SAAS,mBAAmB;AAE5B,SAAS,gBAAgB;AAEzB,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,oBAAV;AAMI,MAAK;AAAL,IAAKC,aAAL;AASH,IAAAA,SAAA,WAAQ;AAAA,KATA,UAAAD,gBAAA,YAAAA,gBAAA;AAYL,MAAK;AAAL,IAAKE,aAAL;AAMH,IAAAA,kBAAA,YAAS,SAAT;AAOA,IAAAA,kBAAA,WAAQ,SAAR;AAOA,IAAAA,kBAAA,WAAQ,SAAR;AAOA,IAAAA,kBAAA,UAAO,KAAP;AAOA,IAAAA,kBAAA,WAAQ,KAAR;AAOA,IAAAA,kBAAA,WAAQ,KAAR;AAOA,IAAAA,kBAAA,cAAW,KAAX;AAOA,IAAAA,kBAAA,eAAY,KAAZ;AAOA,IAAAA,kBAAA,cAAW,KAAX;AAOA,IAAAA,kBAAA,SAAM,KAAN;AAOA,IAAAA,kBAAA,SAAM,KAAN;AAOA,IAAAA,kBAAA,WAAQ,KAAR;AAOA,IAAAA,kBAAA,SAAM,KAAN;AAAA,KA1FQ,UAAAF,gBAAA,YAAAA,gBAAA;AAkGL,EAAMA,gBAAA,mBAAmB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IActC,SAAS,iBAAiB,GAAG,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQxC,OAAO,SAAS,GAAG,QAAiB,CAAC;AAAA,EACzC,CAAC;AAiBM,EAAMA,gBAAA,gBAAgB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnC,OAAO,SAAS,GAAG,UAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrD,MAAM,SAAS,GAAG,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAsC1B,UAAU,SAAS,GAAG,SAASA,gBAAA,kBAAkB,EAAE,WAAW,EAAE,CAAC,CAAC;AAAA,EACtE,CAAC;AAeM,EAAMA,gBAAA,OAAO,eAAe,UAAU;AAAA,IACzC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASN,OAAO,QAAQ,CAAC;AAAA,IACpB;AAAA,IAEA,YAAY;AAAA;AAAA;AAAA;AAAA,MAIR,gBAAgB;AAAA,QACZ;AAAA,QACA,SAASA,gBAAA,eAAe,EAAE,WAAW,GAAG,WAAW,IAAI,CAAC;AAAA,QACxD,EAAE,SAAS,CAAC,EAAE;AAAA,MAClB;AAAA;AAAA;AAAA;AAAA,MAKA,aAAa,UAAU,GAAK,UAAU,EAAE,OAAO,MAAM,YAAY,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASvE,aAAa,kBAAkB,GAAK,UAAU,EAAE,YAAY,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA,MAKlE,QAAQ,kBAAkB,GAAK,UAAU,EAAE,YAAY,KAAK,CAAC;AAAA,IACjE;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQN,cAAc,QAAQ,GAAK,SAAS,wBAAwB,GAAK,aAAa;AAAA,IAClF;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,YAAY,eAAe,WAAW;AAAA,EAC1C,CAAC;AAKM,EAAMA,gBAAA,kBAAkB,eAAeA,gBAAA,IAAI;AAa3C,EAAMA,gBAAA,UAAmBA,gBAAA;AACzB,EAAMA,gBAAA,WAAWA,gBAAA;AAAA,GAnTX;AAuTV,MAAM,wBAAwB,eAAe;AACpD,gBAAgB,SAAS,eAAe,QAAQ;",
   "names": ["DishwasherMode", "Feature", "ModeTag"]
 }