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

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

@@ -26,8 +26,11 @@ var import_MutableCluster = require("../cluster/mutation/MutableCluster.js");
 var import_BitmapSchema = require("../schema/BitmapSchema.js");
 var import_Cluster = require("../cluster/Cluster.js");
 var import_TlvArray = require("../tlv/TlvArray.js");
-var import_mode_base = require("./mode-base.js");
+var import_TlvObject = require("../tlv/TlvObject.js");
+var import_TlvString = require("../tlv/TlvString.js");
 var import_TlvNumber = require("../tlv/TlvNumber.js");
+var import_VendorId = require("../datatype/VendorId.js");
+var import_mode_base = require("./mode-base.js");
 var import_ClusterRegistry = require("../cluster/ClusterRegistry.js");
 /**
  * @license
@@ -45,7 +48,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 = (0, import_TlvObject.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: (0, import_TlvObject.TlvOptionalField)(0, import_VendorId.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: (0, import_TlvObject.TlvField)(1, (0, import_TlvNumber.TlvEnum)())
+  });
+  DishwasherMode2.TlvModeOption = (0, import_TlvObject.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: (0, import_TlvObject.TlvField)(0, import_TlvString.TlvString.bound({ maxLength: 64 })),
+    /**
+     * This field is used to identify the mode option.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.2
+     */
+    mode: (0, import_TlvObject.TlvField)(1, import_TlvNumber.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: (0, import_TlvObject.TlvField)(2, (0, import_TlvArray.TlvArray)(DishwasherMode2.TlvModeTagStruct, { maxLength: 8 }))
+  });
   DishwasherMode2.Base = import_MutableCluster.MutableCluster.Component({
     id: 89,
     name: "DishwasherMode",
@@ -67,7 +156,7 @@ var DishwasherMode;
        */
       supportedModes: (0, import_Cluster.FixedAttribute)(
         0,
-        (0, import_TlvArray.TlvArray)(import_mode_base.ModeBase.TlvModeOption, { minLength: 2, maxLength: 255 }),
+        (0, import_TlvArray.TlvArray)(DishwasherMode2.TlvModeOption, { minLength: 2, maxLength: 255 }),
         { default: [] }
       ),
       /**

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

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../../src/clusters/dishwasher-mode.ts"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,4BAA+B;AAC/B,0BAAwB;AACxB,qBAAqF;AACrF,sBAAyB;AACzB,uBAAyB;AACzB,uBAAyB;AAEzB,6BAAgC;AAfhC;AAAA;AAAA;AAAA;AAAA;AAiBO,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,qCAAe,UAAU;AAAA,IACzC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASN,WAAO,6BAAQ,CAAC;AAAA,IACpB;AAAA,IAEA,YAAY;AAAA;AAAA;AAAA;AAAA,MAIR,oBAAgB;AAAA,QACZ;AAAA,YACA,0BAAS,0BAAS,eAAe,EAAE,WAAW,GAAG,WAAW,IAAI,CAAC;AAAA,QACjE,EAAE,SAAS,CAAC,EAAE;AAAA,MAClB;AAAA;AAAA;AAAA;AAAA,MAKA,iBAAa,0BAAU,GAAK,2BAAU,EAAE,OAAO,MAAM,YAAY,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASvE,iBAAa,kCAAkB,GAAK,2BAAU,EAAE,YAAY,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA,MAKlE,YAAQ,kCAAkB,GAAK,2BAAU,EAAE,YAAY,KAAK,CAAC;AAAA,IACjE;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQN,kBAAc,wBAAQ,GAAK,0BAAS,wBAAwB,GAAK,4BAAa;AAAA,IAClF;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,YAAY,qCAAe,WAAW;AAAA,EAC1C,CAAC;AAKM,EAAMA,gBAAA,sBAAkB,sCAAeA,gBAAA,IAAI;AAa3C,EAAMA,gBAAA,UAAmBA,gBAAA;AACzB,EAAMA,gBAAA,WAAWA,gBAAA;AAAA,GA9HX;AAkIV,MAAM,wBAAwB,eAAe;AACpD,uCAAgB,SAAS,eAAe,QAAQ;",
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,4BAA+B;AAC/B,0BAAwB;AACxB,qBAAqF;AACrF,sBAAyB;AACzB,uBAAsD;AACtD,uBAA0B;AAC1B,uBAAkC;AAClC,sBAA4B;AAE5B,uBAAyB;AAEzB,6BAAgC;AAnBhC;AAAA;AAAA;AAAA;AAAA;AAqBO,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,uBAAmB,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IActC,aAAS,mCAAiB,GAAG,2BAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQxC,WAAO,2BAAS,OAAG,0BAAiB,CAAC;AAAA,EACzC,CAAC;AAiBM,EAAMA,gBAAA,oBAAgB,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnC,WAAO,2BAAS,GAAG,2BAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrD,UAAM,2BAAS,GAAG,yBAAQ;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,cAAU,2BAAS,OAAG,0BAASA,gBAAA,kBAAkB,EAAE,WAAW,EAAE,CAAC,CAAC;AAAA,EACtE,CAAC;AAeM,EAAMA,gBAAA,OAAO,qCAAe,UAAU;AAAA,IACzC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASN,WAAO,6BAAQ,CAAC;AAAA,IACpB;AAAA,IAEA,YAAY;AAAA;AAAA;AAAA;AAAA,MAIR,oBAAgB;AAAA,QACZ;AAAA,YACA,0BAASA,gBAAA,eAAe,EAAE,WAAW,GAAG,WAAW,IAAI,CAAC;AAAA,QACxD,EAAE,SAAS,CAAC,EAAE;AAAA,MAClB;AAAA;AAAA;AAAA;AAAA,MAKA,iBAAa,0BAAU,GAAK,2BAAU,EAAE,OAAO,MAAM,YAAY,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASvE,iBAAa,kCAAkB,GAAK,2BAAU,EAAE,YAAY,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA,MAKlE,YAAQ,kCAAkB,GAAK,2BAAU,EAAE,YAAY,KAAK,CAAC;AAAA,IACjE;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQN,kBAAc,wBAAQ,GAAK,0BAAS,wBAAwB,GAAK,4BAAa;AAAA,IAClF;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,YAAY,qCAAe,WAAW;AAAA,EAC1C,CAAC;AAKM,EAAMA,gBAAA,sBAAkB,sCAAeA,gBAAA,IAAI;AAa3C,EAAMA,gBAAA,UAAmBA,gBAAA;AACzB,EAAMA,gBAAA,WAAWA,gBAAA;AAAA,GAnTX;AAuTV,MAAM,wBAAwB,eAAe;AACpD,uCAAgB,SAAS,eAAe,QAAQ;",
   "names": ["DishwasherMode", "Feature", "ModeTag"]
 }