@matter/types 0.16.0-alpha.0-20251022-5a69ce65a → 0.16.0-alpha.0-20251027-17770fb28

package/dist/cjs/clusters/operational-state.d.ts

@@ -60,9 +60,8 @@ export declare namespace OperationalState {
          */
         operationalStateId: import("../tlv/TlvObject.js").FieldType<OperationalStateEnum>;
         /**
-         * 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.
+         * This field is present when the OperationalStateID is from the set reserved for Manufacturer Specific States.
+         * If present, this shall contain a human-readable description of the operational state.
          *
          * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.2.2
          */
@@ -125,10 +124,8 @@ export declare namespace OperationalState {
          */
         errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+         * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+         * present, this shall contain a human-readable description of the error state.
          *
          * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
          */
@@ -159,7 +156,7 @@ export declare namespace OperationalState {
     const TlvOperationalCommandResponse: import("../tlv/TlvObject.js").ObjectSchema<{
         /**
          * 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
+         * of the attempted command, the ErrorStateID shall be populated with NoError. See the individual command
          * sections for additional specific requirements on population.
          *
          * @see {@link MatterSpecification.v141.Cluster} § 1.14.6.5.1
@@ -172,10 +169,8 @@ export declare namespace OperationalState {
              */
             errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+             * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+             * present, this shall contain a human-readable description of the error state.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
              */
@@ -215,10 +210,8 @@ export declare namespace OperationalState {
              */
             errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+             * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+             * present, this shall contain a human-readable description of the error state.
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
              */
@@ -361,9 +354,8 @@ export declare namespace OperationalState {
                  */
                 operationalStateId: import("../tlv/TlvObject.js").FieldType<OperationalStateEnum>;
                 /**
-                 * 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.
+                 * This field is present when the OperationalStateID is from the set reserved for Manufacturer Specific States.
+                 * If present, this shall contain a human-readable description of the operational state.
                  *
                  * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.2.2
                  */
@@ -378,8 +370,8 @@ export declare namespace OperationalState {
             readonly operationalState: Attribute<OperationalStateEnum, any>;
             /**
              * This attribute shall specify the details of any current error condition being experienced on the device
-             * when the OperationalState attribute is populated with Error. Please see ErrorStateStruct for general
-             * requirements on the population of this attribute.
+             * when the OperationalState attribute is populated with Error. See Section 1.14.4.4, “ErrorStateStruct
+             * Type” for general requirements on the population of this attribute.
              *
              * When there is no error detected, this shall have an ErrorStateID of NoError.
              *
@@ -393,10 +385,8 @@ export declare namespace OperationalState {
                  */
                 errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+                 * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+                 * present, this shall contain a human-readable description of the error state.
                  *
                  * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
                  */
@@ -454,7 +444,7 @@ export declare namespace OperationalState {
             readonly pause: OptionalCommand<void, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * 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
+                 * of the attempted command, the ErrorStateID shall be populated with NoError. See the individual command
                  * sections for additional specific requirements on population.
                  *
                  * @see {@link MatterSpecification.v141.Cluster} § 1.14.6.5.1
@@ -467,10 +457,8 @@ export declare namespace OperationalState {
                      */
                     errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+                     * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+                     * present, this shall contain a human-readable description of the error state.
                      *
                      * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
                      */
@@ -511,7 +499,7 @@ export declare namespace OperationalState {
             readonly stop: OptionalCommand<void, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * 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
+                 * of the attempted command, the ErrorStateID shall be populated with NoError. See the individual command
                  * sections for additional specific requirements on population.
                  *
                  * @see {@link MatterSpecification.v141.Cluster} § 1.14.6.5.1
@@ -524,10 +512,8 @@ export declare namespace OperationalState {
                      */
                     errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+                     * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+                     * present, this shall contain a human-readable description of the error state.
                      *
                      * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
                      */
@@ -570,7 +556,7 @@ export declare namespace OperationalState {
             readonly start: OptionalCommand<void, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * 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
+                 * of the attempted command, the ErrorStateID shall be populated with NoError. See the individual command
                  * sections for additional specific requirements on population.
                  *
                  * @see {@link MatterSpecification.v141.Cluster} § 1.14.6.5.1
@@ -583,10 +569,8 @@ export declare namespace OperationalState {
                      */
                     errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+                     * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+                     * present, this shall contain a human-readable description of the error state.
                      *
                      * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
                      */
@@ -644,7 +628,7 @@ export declare namespace OperationalState {
             readonly resume: OptionalCommand<void, import("../tlv/TlvObject.js").TypeFromFields<{
                 /**
                  * 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
+                 * of the attempted command, the ErrorStateID shall be populated with NoError. See the individual command
                  * sections for additional specific requirements on population.
                  *
                  * @see {@link MatterSpecification.v141.Cluster} § 1.14.6.5.1
@@ -657,10 +641,8 @@ export declare namespace OperationalState {
                      */
                     errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+                     * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+                     * present, this shall contain a human-readable description of the error state.
                      *
                      * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
                      */
@@ -694,10 +676,8 @@ export declare namespace OperationalState {
                      */
                     errorStateId: import("../tlv/TlvObject.js").FieldType<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".
+                     * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+                     * present, this shall contain a human-readable description of the error state.
                      *
                      * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
                      */

package/dist/cjs/clusters/operational-state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operational-state.d.ts","sourceRoot":"","sources":["../../../src/clusters/operational-state.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAM5G,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,gBAAgB,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAY,oBAAoB;QAC5B;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,MAAM,IAAI;QAEV;;WAEG;QACH,KAAK,IAAI;KACZ;IAED;;;;OAIG;IACI,MAAM,yBAAyB;QAClC;;;;WAIG;;QAGH;;;;;;WAMG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,sBAAuB,SAAQ,cAAc,CAAC,OAAO,yBAAyB,CAAC;KAAG;IAEnG;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAY,UAAU;QAClB;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,qBAAqB,IAAI;QAEzB;;WAEG;QACH,yBAAyB,IAAI;QAE7B;;WAEG;QACH,qBAAqB,IAAI;KAC5B;IAED;;OAEG;IACI,MAAM,mBAAmB;QAC5B;;;;WAIG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;WAMG;;MAEL,CAAC;IAEH;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,cAAc,CAAC,OAAO,mBAAmB,CAAC;KAAG;IAEvF;;;;;;;;OAQG;IACI,MAAM,6BAA6B;QACtC;;;;;;WAMG;;YAhDH;;;;eAIG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;eAMG;;;MA2BL,CAAC;IAEH;;;;;;;;OAQG;IACH,UAAiB,0BAA2B,SAAQ,cAAc,CAAC,OAAO,6BAA6B,CAAC;KAAG;IAE3G;;;;OAIG;IACI,MAAM,wBAAwB;;YApEjC;;;;eAIG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;eAMG;;;MA6C4F,CAAC;IAEpG;;;;OAIG;IACH,UAAiB,qBAAsB,SAAQ,cAAc,CAAC,OAAO,wBAAwB,CAAC;KAAG;IAEjG;;;;OAIG;IACI,MAAM,2BAA2B;QACpC;;;;;WAKG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;WAMG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,wBAAyB,SAAQ,cAAc,CAAC,OAAO,2BAA2B,CAAC;KAAG;IAEvG;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;;;;;;eAUG;;YAGH;;;;;;;;;eASG;;YAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA8BG;;YAGH;;;;;;;;;;;eAWG;;gBA3QP;;;;mBAIG;;gBAGH;;;;;;mBAMG;;;YAiQC;;;;;eAKG;;YAGH;;;;;;;;eAQG;;gBAvNP;;;;mBAIG;;gBAGH;;;;;;;mBAOG;;gBAGH;;;;;;mBAMG;;;;;YAqMC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAsCG;;gBAxNP;;;;;;mBAMG;;oBAhDH;;;;uBAIG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;;;YA8OC;;;;;;;;;;;;;;;;;;;;;;eAsBG;;gBAjPP;;;;;;mBAMG;;oBAhDH;;;;uBAIG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;;;YAuQC;;;;;;;;;;;;;;;;;;;;;;;;eAwBG;;gBA5QP;;;;;;mBAMG;;oBAhDH;;;;uBAIG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;;;YAkSC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAuCG;;gBAtTP;;;;;;mBAMG;;oBAhDH;;;;uBAIG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;;;;;YA8UC;;;;;;;eAOG;;;oBA5WP;;;;uBAIG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;;uBAMG;;;;YAwVC;;;;;;;;;;;;eAYG;;gBAxSP;;;;;mBAKG;;gBAGH;;;;;;;mBAOG;;gBAGH;;;;;;mBAMG;;;;UAmRL,CAAC;IAEH;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,OAAO,CAAC;AAC/D,eAAO,MAAM,uBAAuB,0BAA2B,CAAC"}
+{"version":3,"file":"operational-state.d.ts","sourceRoot":"","sources":["../../../src/clusters/operational-state.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAM5G,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,gBAAgB,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAY,oBAAoB;QAC5B;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,MAAM,IAAI;QAEV;;WAEG;QACH,KAAK,IAAI;KACZ;IAED;;;;OAIG;IACI,MAAM,yBAAyB;QAClC;;;;WAIG;;QAGH;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,sBAAuB,SAAQ,cAAc,CAAC,OAAO,yBAAyB,CAAC;KAAG;IAEnG;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAY,UAAU;QAClB;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,qBAAqB,IAAI;QAEzB;;WAEG;QACH,yBAAyB,IAAI;QAE7B;;WAEG;QACH,qBAAqB,IAAI;KAC5B;IAED;;OAEG;IACI,MAAM,mBAAmB;QAC5B;;;;WAIG;;QAGH;;;;;WAKG;;QAGH;;;;;;WAMG;;MAEL,CAAC;IAEH;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,cAAc,CAAC,OAAO,mBAAmB,CAAC;KAAG;IAEvF;;;;;;;;OAQG;IACI,MAAM,6BAA6B;QACtC;;;;;;WAMG;;YA9CH;;;;eAIG;;YAGH;;;;;eAKG;;YAGH;;;;;;eAMG;;;MA2BL,CAAC;IAEH;;;;;;;;OAQG;IACH,UAAiB,0BAA2B,SAAQ,cAAc,CAAC,OAAO,6BAA6B,CAAC;KAAG;IAE3G;;;;OAIG;IACI,MAAM,wBAAwB;;YAlEjC;;;;eAIG;;YAGH;;;;;eAKG;;YAGH;;;;;;eAMG;;;MA6C4F,CAAC;IAEpG;;;;OAIG;IACH,UAAiB,qBAAsB,SAAQ,cAAc,CAAC,OAAO,wBAAwB,CAAC;KAAG;IAEjG;;;;OAIG;IACI,MAAM,2BAA2B;QACpC;;;;;WAKG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;WAMG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,wBAAyB,SAAQ,cAAc,CAAC,OAAO,2BAA2B,CAAC;KAAG;IAEvG;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;;;;;;eAUG;;YAGH;;;;;;;;;eASG;;YAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA8BG;;YAGH;;;;;;;;;;;eAWG;;gBAxQP;;;;mBAIG;;gBAGH;;;;;mBAKG;;;YA+PC;;;;;eAKG;;YAGH;;;;;;;;eAQG;;gBArNP;;;;mBAIG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;mBAMG;;;;;YAqMC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAsCG;;gBAxNP;;;;;;mBAMG;;oBA9CH;;;;uBAIG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;;;YA8OC;;;;;;;;;;;;;;;;;;;;;;eAsBG;;gBAjPP;;;;;;mBAMG;;oBA9CH;;;;uBAIG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;;;YAuQC;;;;;;;;;;;;;;;;;;;;;;;;eAwBG;;gBA5QP;;;;;;mBAMG;;oBA9CH;;;;uBAIG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;;;YAkSC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAuCG;;gBAtTP;;;;;;mBAMG;;oBA9CH;;;;uBAIG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;;;;;YA8UC;;;;;;;eAOG;;;oBA1WP;;;;uBAIG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;;;YAwVC;;;;;;;;;;;;eAYG;;gBAxSP;;;;;mBAKG;;gBAGH;;;;;;;mBAOG;;gBAGH;;;;;;mBAMG;;;;UAmRL,CAAC;IAEH;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,OAAO,CAAC;AAC/D,eAAO,MAAM,uBAAuB,0BAA2B,CAAC"}

package/dist/cjs/clusters/operational-state.js

@@ -54,9 +54,8 @@ var OperationalState;
      */
     operationalStateId: (0, import_TlvObject.TlvField)(0, (0, import_TlvNumber.TlvEnum)()),
     /**
-     * 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.
+     * This field is present when the OperationalStateID is from the set reserved for Manufacturer Specific States.
+     * If present, this shall contain a human-readable description of the operational state.
      *
      * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.2.2
      */
@@ -77,10 +76,8 @@ var OperationalState;
      */
     errorStateId: (0, import_TlvObject.TlvField)(0, (0, import_TlvNumber.TlvEnum)()),
     /**
-     * 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".
+     * This field is present when the ErrorStateID is from the set reserved for Manufacturer Specific errors. If
+     * present, this shall contain a human-readable description of the error state.
      *
      * @see {@link MatterSpecification.v141.Cluster} § 1.14.4.4.2
      */
@@ -97,7 +94,7 @@ var OperationalState;
   OperationalState2.TlvOperationalCommandResponse = (0, import_TlvObject.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
+     * of the attempted command, the ErrorStateID shall be populated with NoError. See the individual command
      * sections for additional specific requirements on population.
      *
      * @see {@link MatterSpecification.v141.Cluster} § 1.14.6.5.1
@@ -213,8 +210,8 @@ var OperationalState;
       operationalState: (0, import_Cluster.Attribute)(4, (0, import_TlvNumber.TlvEnum)()),
       /**
        * This attribute shall specify the details of any current error condition being experienced on the device
-       * when the OperationalState attribute is populated with Error. Please see ErrorStateStruct for general
-       * requirements on the population of this attribute.
+       * when the OperationalState attribute is populated with Error. See Section 1.14.4.4, “ErrorStateStruct
+       * Type” for general requirements on the population of this attribute.
        *
        * When there is no error detected, this shall have an ErrorStateID of NoError.
        *

package/dist/cjs/clusters/operational-state.js.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../../src/clusters/operational-state.ts"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,4BAA+B;AAC/B,qBAAoF;AACpF,sBAAyB;AACzB,uBAA0B;AAC1B,yBAA4B;AAC5B,uBAA6C;AAC7C,uBAAsD;AAEtD,4BAA+B;AAC/B,sBAAyB;AAEzB,6BAAgC;AAnBhC;AAAA;AAAA;AAAA;AAAA;AAqBO,IAAU;AAAA,CAAV,CAAUA,sBAAV;AAqBI,MAAK;AAAL,IAAKC,0BAAL;AAIH,IAAAA,4CAAA,aAAU,KAAV;AAKA,IAAAA,4CAAA,aAAU,KAAV;AAKA,IAAAA,4CAAA,YAAS,KAAT;AAKA,IAAAA,4CAAA,WAAQ,KAAR;AAAA,KAnBQ,uBAAAD,kBAAA,yBAAAA,kBAAA;AA2BL,EAAMA,kBAAA,gCAA4B,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM/C,wBAAoB,2BAAS,OAAG,0BAA8B,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAS/D,2BAAuB,mCAAiB,GAAG,2BAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA,EACjF,CAAC;AA8BM,MAAK;AAAL,IAAKE,gBAAL;AAIH,IAAAA,wBAAA,aAAU,KAAV;AAKA,IAAAA,wBAAA,2BAAwB,KAAxB;AAKA,IAAAA,wBAAA,+BAA4B,KAA5B;AAKA,IAAAA,wBAAA,2BAAwB,KAAxB;AAAA,KAnBQ,aAAAF,kBAAA,eAAAA,kBAAA;AAyBL,EAAMA,kBAAA,0BAAsB,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMzC,kBAAc,2BAAS,OAAG,0BAAoB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAU/C,qBAAiB,mCAAiB,GAAG,2BAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASvE,uBAAmB,mCAAiB,GAAG,2BAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA,EAC7E,CAAC;AAgBM,EAAMA,kBAAA,oCAAgC,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,0BAAsB,2BAAS,GAAGA,kBAAA,mBAAmB;AAAA,EACzD,CAAC;AAkBM,EAAMA,kBAAA,+BAA2B,4BAAU,EAAE,gBAAY,2BAAS,GAAGA,kBAAA,mBAAmB,EAAE,CAAC;AAc3F,EAAMA,kBAAA,kCAA8B,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjD,yBAAqB,2BAAS,GAAG,yBAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUzC,0BAAsB,mCAAiB,OAAG,gCAAY,0BAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAShE,gBAAY,mCAAiB,OAAG,gCAAY,0BAAS,CAAC;AAAA,EAC1D,CAAC;AAYM,EAAMA,kBAAA,sBAAkB,sCAAe;AAAA,IAC1C,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAYR,eAAW,0BAAU,OAAK,oCAAY,0BAAS,4BAAW,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAY7E,kBAAc,0BAAU,OAAK,gCAAY,yBAAQ,CAAC;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,MAiClD,mBAAe,kCAAkB,OAAK,gCAAY,2BAAU,MAAM,EAAE,KAAK,OAAO,CAAC,CAAC,GAAG,EAAE,SAAS,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MActG,0BAAsB,0BAAU,OAAK,0BAASA,kBAAA,yBAAyB,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQzF,sBAAkB,0BAAU,OAAK,0BAA8B,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAWhE,sBAAkB,0BAAU,GAAKA,kBAAA,mBAAmB;AAAA,IACxD;AAAA,IAEA,UAAU;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;AAAA;AAAA;AAAA,MAwCN,WAAO,gCAAgB,GAAK,sCAAgB,GAAKA,kBAAA,6BAA6B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAyB9E,UAAM,gCAAgB,GAAK,sCAAgB,GAAKA,kBAAA,6BAA6B;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,MA2B7E,WAAO,gCAAgB,GAAK,sCAAgB,GAAKA,kBAAA,6BAA6B;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;AAAA;AAAA;AAAA;AAAA,MA0C9E,YAAQ,gCAAgB,GAAK,sCAAgB,GAAKA,kBAAA,6BAA6B;AAAA,IACnF;AAAA,IAEA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASJ,sBAAkB,sBAAM,GAAK,yBAAS,UAAUA,kBAAA,wBAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAexE,yBAAqB,8BAAc,GAAK,yBAAS,MAAMA,kBAAA,2BAA2B;AAAA,IACtF;AAAA,EACJ,CAAC;AA0BM,EAAMA,kBAAA,UAAmBA,kBAAA;AACzB,EAAMA,kBAAA,WAAWA,kBAAA;AAAA,GAjhBX;AAqhBV,MAAM,0BAA0B,iBAAiB;AACxD,uCAAgB,SAAS,iBAAiB,QAAQ;",
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,4BAA+B;AAC/B,qBAAoF;AACpF,sBAAyB;AACzB,uBAA0B;AAC1B,yBAA4B;AAC5B,uBAA6C;AAC7C,uBAAsD;AAEtD,4BAA+B;AAC/B,sBAAyB;AAEzB,6BAAgC;AAnBhC;AAAA;AAAA;AAAA;AAAA;AAqBO,IAAU;AAAA,CAAV,CAAUA,sBAAV;AAqBI,MAAK;AAAL,IAAKC,0BAAL;AAIH,IAAAA,4CAAA,aAAU,KAAV;AAKA,IAAAA,4CAAA,aAAU,KAAV;AAKA,IAAAA,4CAAA,YAAS,KAAT;AAKA,IAAAA,4CAAA,WAAQ,KAAR;AAAA,KAnBQ,uBAAAD,kBAAA,yBAAAA,kBAAA;AA2BL,EAAMA,kBAAA,gCAA4B,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM/C,wBAAoB,2BAAS,OAAG,0BAA8B,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ/D,2BAAuB,mCAAiB,GAAG,2BAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA,EACjF,CAAC;AA8BM,MAAK;AAAL,IAAKE,gBAAL;AAIH,IAAAA,wBAAA,aAAU,KAAV;AAKA,IAAAA,wBAAA,2BAAwB,KAAxB;AAKA,IAAAA,wBAAA,+BAA4B,KAA5B;AAKA,IAAAA,wBAAA,2BAAwB,KAAxB;AAAA,KAnBQ,aAAAF,kBAAA,eAAAA,kBAAA;AAyBL,EAAMA,kBAAA,0BAAsB,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMzC,kBAAc,2BAAS,OAAG,0BAAoB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ/C,qBAAiB,mCAAiB,GAAG,2BAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASvE,uBAAmB,mCAAiB,GAAG,2BAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA,EAC7E,CAAC;AAgBM,EAAMA,kBAAA,oCAAgC,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,0BAAsB,2BAAS,GAAGA,kBAAA,mBAAmB;AAAA,EACzD,CAAC;AAkBM,EAAMA,kBAAA,+BAA2B,4BAAU,EAAE,gBAAY,2BAAS,GAAGA,kBAAA,mBAAmB,EAAE,CAAC;AAc3F,EAAMA,kBAAA,kCAA8B,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjD,yBAAqB,2BAAS,GAAG,yBAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUzC,0BAAsB,mCAAiB,OAAG,gCAAY,0BAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAShE,gBAAY,mCAAiB,OAAG,gCAAY,0BAAS,CAAC;AAAA,EAC1D,CAAC;AAYM,EAAMA,kBAAA,sBAAkB,sCAAe;AAAA,IAC1C,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAYR,eAAW,0BAAU,OAAK,oCAAY,0BAAS,4BAAW,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAY7E,kBAAc,0BAAU,OAAK,gCAAY,yBAAQ,CAAC;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,MAiClD,mBAAe,kCAAkB,OAAK,gCAAY,2BAAU,MAAM,EAAE,KAAK,OAAO,CAAC,CAAC,GAAG,EAAE,SAAS,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MActG,0BAAsB,0BAAU,OAAK,0BAASA,kBAAA,yBAAyB,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQzF,sBAAkB,0BAAU,OAAK,0BAA8B,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAWhE,sBAAkB,0BAAU,GAAKA,kBAAA,mBAAmB;AAAA,IACxD;AAAA,IAEA,UAAU;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;AAAA;AAAA;AAAA,MAwCN,WAAO,gCAAgB,GAAK,sCAAgB,GAAKA,kBAAA,6BAA6B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAyB9E,UAAM,gCAAgB,GAAK,sCAAgB,GAAKA,kBAAA,6BAA6B;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,MA2B7E,WAAO,gCAAgB,GAAK,sCAAgB,GAAKA,kBAAA,6BAA6B;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;AAAA;AAAA;AAAA;AAAA,MA0C9E,YAAQ,gCAAgB,GAAK,sCAAgB,GAAKA,kBAAA,6BAA6B;AAAA,IACnF;AAAA,IAEA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASJ,sBAAkB,sBAAM,GAAK,yBAAS,UAAUA,kBAAA,wBAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAexE,yBAAqB,8BAAc,GAAK,yBAAS,MAAMA,kBAAA,2BAA2B;AAAA,IACtF;AAAA,EACJ,CAAC;AA0BM,EAAMA,kBAAA,UAAmBA,kBAAA;AACzB,EAAMA,kBAAA,WAAWA,kBAAA;AAAA,GA9gBX;AAkhBV,MAAM,0BAA0B,iBAAiB;AACxD,uCAAgB,SAAS,iBAAiB,QAAQ;",
   "names": ["OperationalState", "OperationalStateEnum", "ErrorState"]
 }

package/dist/cjs/clusters/ota-software-update-provider.d.ts

@@ -127,6 +127,8 @@ export declare namespace OtaSoftwareUpdateProvider {
          * whereby strictly correct additional MetadataForProvider is expected to fulfill the OTA Software Update
          * process.
          *
+         * ### Usage of the QueryImage Command
+         *
          * OTA Requestors shall send a QueryImage command to the OTA Provider to determine the availability of a new
          * Software Image.
          *
@@ -219,7 +221,8 @@ export declare namespace OtaSoftwareUpdateProvider {
          * Requestors to follow this value to their best capability, however, a restarting Node may come back sooner,
          * due to having lost track of this state response.
          *
-         * The DelayedActionTime field shall only be present if the Status field is set to Busy.
+         * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
+         * “QueryImageResponse Command”.
          *
          * See Section 11.20.3.2, “Querying the OTA Provider” for details about the rules regarding this field.
          *
@@ -227,10 +230,11 @@ export declare namespace OtaSoftwareUpdateProvider {
          */
         delayedActionTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
         /**
-         * This field, when present, shall contain a URI where the OTA Requestor SHOULD download a Software Image. The
+         * This field, when present, shall contain a URI where the OTA Requestor SHOULD download a Soft ware Image. The
          * syntax of the ImageURI field shall follow the URI syntax as specified in RFC 3986.
          *
-         * This field shall be present if it appears in a QueryImageResponse with a Status of UpdateAvailable.
+         * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
+         * “QueryImageResponse Command”.
          *
          * If the ImageURI specifies a BDX Protocol bdx: scheme, then the following rules describe the location to be
          * used for download:
@@ -327,10 +331,10 @@ export declare namespace OtaSoftwareUpdateProvider {
          */
         imageUri: import("../tlv/TlvObject.js").OptionalFieldType<string>;
         /**
-         * This field indicates the version of the image being provided to the OTA Requestor by the OTA Provider when
-         * the Status is UpdateAvailable.
+         * This field indicates the version of the image being provided to the OTA Requestor by the OTA Provider.
          *
-         * This field shall be present if it appears in a QueryImageResponse with a Status of UpdateAvailable.
+         * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
+         * “QueryImageResponse Command”.
          *
          * See Section 11.20.3.2, “Querying the OTA Provider” for additional details about the flow and acceptable
          * values.
@@ -339,10 +343,11 @@ export declare namespace OtaSoftwareUpdateProvider {
          */
         softwareVersion: import("../tlv/TlvObject.js").OptionalFieldType<number>;
         /**
-         * This field provides a string version of the image being provided to the OTA Requestor by the OTA Provider
-         * when the Status is UpdateAvailable.
+         * This field provides a string version of the image being provided to the OTA Requestor by the OTA Provider.
+         *
+         * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
          *
-         * This field shall be present if it appears in a QueryImageResponse with a Status of UpdateAvailable.
+         * “QueryImageResponse Command”.
          *
          * See Section 11.20.3.2, “Querying the OTA Provider” for additional details about the flow and acceptable
          * values.
@@ -351,7 +356,8 @@ export declare namespace OtaSoftwareUpdateProvider {
          */
         softwareVersionString: import("../tlv/TlvObject.js").OptionalFieldType<string>;
         /**
-         * This optional field shall be present when the Status field contains UpdateAvailable.
+         * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
+         * “QueryImageResponse Command”.
          *
          * See Section 11.20.3.6.1, “UpdateToken usage” for additional details about the generation and usage of
          * UpdateToken.
@@ -411,9 +417,13 @@ export declare namespace OtaSoftwareUpdateProvider {
          * Software Image which the OTA Requestor is ready to start applying. The OTA Provider may use this new version
          * to track or record Software Image application by OTA Requestors.
          *
+         * ### When Generated
+         *
          * The ApplyUpdateRequest Command shall be invoked by an OTA Requestor once it is ready to apply a previously
          * downloaded Software Image.
          *
+         * ### Effect on Receipt
+         *
          * Upon receipt of this command the OTA Provider shall respond with an Action field consistent with the next
          * action the OTA Requestor should take, including any possible time delay.
          *
@@ -424,6 +434,8 @@ export declare namespace OtaSoftwareUpdateProvider {
          * See Section 11.20.3.6, “Applying a software update” for a description of the flow in response to an OTA
          * Provider receiving an invocation of this command.
          *
+         * ### Handling Error Cases
+         *
          * See Section 11.20.3.6, “Applying a software update” for all error-handling information.
          *
          * @see {@link MatterSpecification.v141.Core} § 11.20.6.5.3.2
@@ -501,10 +513,12 @@ export declare namespace OtaSoftwareUpdateProvider {
          * attribute in the invoking OTA Requestor’s Basic Information Cluster, and SHOULD be consistent with the value
          * representing a new version running on the Node invoking the command.
          *
+         * ### When Generated
+         *
          * The NotifyUpdateApplied command SHOULD be invoked in the following two circumstances:
          *
          *   1. An OTA Requestor has just successfully applied a Software Image it had obtained from a previous
-         *      QueryImage response.
+         *      QueryImageResponse.
          *
          *   2. An OTA Requestor has just successfully applied a Software Image it had obtained through means different
          *      than those of this Cluster.
@@ -517,6 +531,8 @@ export declare namespace OtaSoftwareUpdateProvider {
          * This command shall be considered optional and shall NOT result in reduced availability of the OTA Provider
          * functionality if OTA Requestors never invoke this command.
          *
+         * ### Effect on Receipt
+         *
          * An OTA Provider receiving an invocation of this command may log it internally.
          *
          * On receiving this command, an OTA Provider may use the information to update its bookkeeping of cached
@@ -634,6 +650,8 @@ export declare namespace OtaSoftwareUpdateProvider {
                  * whereby strictly correct additional MetadataForProvider is expected to fulfill the OTA Software Update
                  * process.
                  *
+                 * ### Usage of the QueryImage Command
+                 *
                  * OTA Requestors shall send a QueryImage command to the OTA Provider to determine the availability of a new
                  * Software Image.
                  *
@@ -660,7 +678,8 @@ export declare namespace OtaSoftwareUpdateProvider {
                  * Requestors to follow this value to their best capability, however, a restarting Node may come back sooner,
                  * due to having lost track of this state response.
                  *
-                 * The DelayedActionTime field shall only be present if the Status field is set to Busy.
+                 * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
+                 * “QueryImageResponse Command”.
                  *
                  * See Section 11.20.3.2, “Querying the OTA Provider” for details about the rules regarding this field.
                  *
@@ -668,10 +687,11 @@ export declare namespace OtaSoftwareUpdateProvider {
                  */
                 delayedActionTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
                 /**
-                 * This field, when present, shall contain a URI where the OTA Requestor SHOULD download a Software Image. The
+                 * This field, when present, shall contain a URI where the OTA Requestor SHOULD download a Soft ware Image. The
                  * syntax of the ImageURI field shall follow the URI syntax as specified in RFC 3986.
                  *
-                 * This field shall be present if it appears in a QueryImageResponse with a Status of UpdateAvailable.
+                 * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
+                 * “QueryImageResponse Command”.
                  *
                  * If the ImageURI specifies a BDX Protocol bdx: scheme, then the following rules describe the location to be
                  * used for download:
@@ -768,10 +788,10 @@ export declare namespace OtaSoftwareUpdateProvider {
                  */
                 imageUri: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                 /**
-                 * This field indicates the version of the image being provided to the OTA Requestor by the OTA Provider when
-                 * the Status is UpdateAvailable.
+                 * This field indicates the version of the image being provided to the OTA Requestor by the OTA Provider.
                  *
-                 * This field shall be present if it appears in a QueryImageResponse with a Status of UpdateAvailable.
+                 * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
+                 * “QueryImageResponse Command”.
                  *
                  * See Section 11.20.3.2, “Querying the OTA Provider” for additional details about the flow and acceptable
                  * values.
@@ -780,10 +800,11 @@ export declare namespace OtaSoftwareUpdateProvider {
                  */
                 softwareVersion: import("../tlv/TlvObject.js").OptionalFieldType<number>;
                 /**
-                 * This field provides a string version of the image being provided to the OTA Requestor by the OTA Provider
-                 * when the Status is UpdateAvailable.
+                 * This field provides a string version of the image being provided to the OTA Requestor by the OTA Provider.
+                 *
+                 * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
                  *
-                 * This field shall be present if it appears in a QueryImageResponse with a Status of UpdateAvailable.
+                 * “QueryImageResponse Command”.
                  *
                  * See Section 11.20.3.2, “Querying the OTA Provider” for additional details about the flow and acceptable
                  * values.
@@ -792,7 +813,8 @@ export declare namespace OtaSoftwareUpdateProvider {
                  */
                 softwareVersionString: import("../tlv/TlvObject.js").OptionalFieldType<string>;
                 /**
-                 * This optional field shall be present when the Status field contains UpdateAvailable.
+                 * Beware, this field is conditionally present based on the conformance listed in Section 11.20.6.5.2,
+                 * “QueryImageResponse Command”.
                  *
                  * See Section 11.20.3.6.1, “UpdateToken usage” for additional details about the generation and usage of
                  * UpdateToken.
@@ -845,9 +867,13 @@ export declare namespace OtaSoftwareUpdateProvider {
                  * Software Image which the OTA Requestor is ready to start applying. The OTA Provider may use this new version
                  * to track or record Software Image application by OTA Requestors.
                  *
+                 * ### When Generated
+                 *
                  * The ApplyUpdateRequest Command shall be invoked by an OTA Requestor once it is ready to apply a previously
                  * downloaded Software Image.
                  *
+                 * ### Effect on Receipt
+                 *
                  * Upon receipt of this command the OTA Provider shall respond with an Action field consistent with the next
                  * action the OTA Requestor should take, including any possible time delay.
                  *
@@ -858,6 +884,8 @@ export declare namespace OtaSoftwareUpdateProvider {
                  * See Section 11.20.3.6, “Applying a software update” for a description of the flow in response to an OTA
                  * Provider receiving an invocation of this command.
                  *
+                 * ### Handling Error Cases
+                 *
                  * See Section 11.20.3.6, “Applying a software update” for all error-handling information.
                  *
                  * @see {@link MatterSpecification.v141.Core} § 11.20.6.5.3.2
@@ -897,10 +925,12 @@ export declare namespace OtaSoftwareUpdateProvider {
                  * attribute in the invoking OTA Requestor’s Basic Information Cluster, and SHOULD be consistent with the value
                  * representing a new version running on the Node invoking the command.
                  *
+                 * ### When Generated
+                 *
                  * The NotifyUpdateApplied command SHOULD be invoked in the following two circumstances:
                  *
                  *   1. An OTA Requestor has just successfully applied a Software Image it had obtained from a previous
-                 *      QueryImage response.
+                 *      QueryImageResponse.
                  *
                  *   2. An OTA Requestor has just successfully applied a Software Image it had obtained through means different
                  *      than those of this Cluster.
@@ -913,6 +943,8 @@ export declare namespace OtaSoftwareUpdateProvider {
                  * This command shall be considered optional and shall NOT result in reduced availability of the OTA Provider
                  * functionality if OTA Requestors never invoke this command.
                  *
+                 * ### Effect on Receipt
+                 *
                  * An OTA Provider receiving an invocation of this command may log it internally.
                  *
                  * On receiving this command, an OTA Provider may use the information to update its bookkeeping of cached

package/dist/cjs/clusters/ota-software-update-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ota-software-update-provider.d.ts","sourceRoot":"","sources":["../../../src/clusters/ota-software-update-provider.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAiB,MAAM,uBAAuB,CAAC;AAO/D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,MAAM,IAAI,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,yBAAyB,CAAC;IACvC;;;;;OAKG;IACH,KAAY,gBAAgB;QACxB;;WAEG;QACH,cAAc,IAAI;QAElB;;WAEG;QACH,eAAe,IAAI;QAEnB;;WAEG;QACH,KAAK,IAAI;QAET;;WAEG;QACH,cAAc,IAAI;KACrB;IAED;;;;OAIG;IACI,MAAM,oBAAoB;QAC7B;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;;;WAMG;;QAGH;;;;;;;;;;;;;;;;WAgBG;;QAGH;;;;;WAKG;;QAGH;;;;;;WAMG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,iBAAkB,SAAQ,cAAc,CAAC,OAAO,oBAAoB,CAAC;KAAG;IAEzF;;;;OAIG;IACH,KAAY,MAAM;QACd;;WAEG;QACH,eAAe,IAAI;QAEnB;;WAEG;QACH,IAAI,IAAI;QAER;;WAEG;QACH,YAAY,IAAI;QAEhB;;WAEG;QACH,4BAA4B,IAAI;KACnC;IAED;;;;OAIG;IACH,MAAa,oBAAqB,SAAQ,mBAAmB;oBAErD,OAAO,SAA4D,EACnE,IAAI,eAAuB,EAC3B,WAAW,SAAyB;KAI3C;IAED;;;;OAIG;IACH,MAAa,SAAU,SAAQ,mBAAmB;oBAE1C,OAAO,SAAuE,EAC9E,IAAI,eAAuB,EAC3B,WAAW,SAAc;KAIhC;IAED;;;;OAIG;IACH,MAAa,iBAAkB,SAAQ,mBAAmB;oBAElD,OAAO,SAA2F,EAClG,IAAI,eAAuB,EAC3B,WAAW,SAAsB;KAIxC;IAED;;;;OAIG;IACH,MAAa,iCAAkC,SAAQ,mBAAmB;oBAElE,OAAO,SAAwF,EAC/F,IAAI,eAAuB,EAC3B,WAAW,SAAsC;KAIxD;IAED;;OAEG;IACI,MAAM,qBAAqB;QAC9B;;;;;;;WAOG;;QAGH;;;;;;;;;;;;WAYG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkGG;;QAGH;;;;;;;;;;WAUG;;QAGH;;;;;;;;;;WAUG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;;;;WASG;;QAGH;;;;;;;;;;;;;;WAcG;;MAEL,CAAC;IAEH;;OAEG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;;;OAIG;IACI,MAAM,qBAAqB;QAC9B;;;;;;WAMG;;QAGH;;;;;;;;;;;;;;;;;;;;;WAqBG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;;;;OAKG;IACH,KAAY,iBAAiB;QACzB;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,eAAe,IAAI;QAEnB;;WAEG;QACH,WAAW,IAAI;KAClB;IAED;;OAEG;IACI,MAAM,sBAAsB;QAC/B;;;;;;WAMG;;QAGH;;;;;;;WAOG;;MAEL,CAAC;IAEH;;OAEG;IACH,UAAiB,mBAAoB,SAAQ,cAAc,CAAC,OAAO,sBAAsB,CAAC;KAAG;IAE7F;;;;OAIG;IACI,MAAM,6BAA6B;QACtC;;;;WAIG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,0BAA2B,SAAQ,cAAc,CAAC,OAAO,6BAA6B,CAAC;KAAG;IAE3G;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;eAKG;;gBAnjBP;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;mBAMG;;gBAGH;;;;;;;;;;;;;;;;mBAgBG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;mBAMG;;gBAGH;;;;;;;mBAOG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA6BG;;;gBAsGH;;;;;;;mBAOG;;gBAGH;;;;;;;;;;;;mBAYG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAkGG;;gBAGH;;;;;;;;;;mBAUG;;gBAGH;;;;;;;;;;mBAUG;;gBAGH;;;;;;;mBAOG;;gBAGH;;;;;;;;;mBASG;;gBAGH;;;;;;;;;;;;;;mBAcG;;;YAgLC;;eAEG;;gBAnKP;;;;;;mBAMG;;gBAGH;;;;;;;;;;;;;;;;;;;;;mBAqBG;;;gBAsCH;;;;;;mBAMG;;gBAGH;;;;;;;mBAOG;;;YAkFC;;eAEG;;gBArEP;;;;mBAIG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA2BG;;;;UAsCL,CAAC;IAEH;;OAEG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,gCAAgC,GAAG,yBAAyB,CAAC,OAAO,CAAC;AACjF,eAAO,MAAM,gCAAgC,mCAAoC,CAAC"}
+{"version":3,"file":"ota-software-update-provider.d.ts","sourceRoot":"","sources":["../../../src/clusters/ota-software-update-provider.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAiB,MAAM,uBAAuB,CAAC;AAO/D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,MAAM,IAAI,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,yBAAyB,CAAC;IACvC;;;;;OAKG;IACH,KAAY,gBAAgB;QACxB;;WAEG;QACH,cAAc,IAAI;QAElB;;WAEG;QACH,eAAe,IAAI;QAEnB;;WAEG;QACH,KAAK,IAAI;QAET;;WAEG;QACH,cAAc,IAAI;KACrB;IAED;;;;OAIG;IACI,MAAM,oBAAoB;QAC7B;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;;;WAMG;;QAGH;;;;;;;;;;;;;;;;WAgBG;;QAGH;;;;;WAKG;;QAGH;;;;;;WAMG;;QAGH;;;;;;;WAOG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,iBAAkB,SAAQ,cAAc,CAAC,OAAO,oBAAoB,CAAC;KAAG;IAEzF;;;;OAIG;IACH,KAAY,MAAM;QACd;;WAEG;QACH,eAAe,IAAI;QAEnB;;WAEG;QACH,IAAI,IAAI;QAER;;WAEG;QACH,YAAY,IAAI;QAEhB;;WAEG;QACH,4BAA4B,IAAI;KACnC;IAED;;;;OAIG;IACH,MAAa,oBAAqB,SAAQ,mBAAmB;oBAErD,OAAO,SAA4D,EACnE,IAAI,eAAuB,EAC3B,WAAW,SAAyB;KAI3C;IAED;;;;OAIG;IACH,MAAa,SAAU,SAAQ,mBAAmB;oBAE1C,OAAO,SAAuE,EAC9E,IAAI,eAAuB,EAC3B,WAAW,SAAc;KAIhC;IAED;;;;OAIG;IACH,MAAa,iBAAkB,SAAQ,mBAAmB;oBAElD,OAAO,SAA2F,EAClG,IAAI,eAAuB,EAC3B,WAAW,SAAsB;KAIxC;IAED;;;;OAIG;IACH,MAAa,iCAAkC,SAAQ,mBAAmB;oBAElE,OAAO,SAAwF,EAC/F,IAAI,eAAuB,EAC3B,WAAW,SAAsC;KAIxD;IAED;;OAEG;IACI,MAAM,qBAAqB;QAC9B;;;;;;;WAOG;;QAGH;;;;;;;;;;;;;WAaG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmGG;;QAGH;;;;;;;;;;WAUG;;QAGH;;;;;;;;;;;WAWG;;QAGH;;;;;;;;WAQG;;QAGH;;;;;;;;;WASG;;QAGH;;;;;;;;;;;;;;WAcG;;MAEL,CAAC;IAEH;;OAEG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;;;OAIG;IACI,MAAM,qBAAqB;QAC9B;;;;;;WAMG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;;;;OAKG;IACH,KAAY,iBAAiB;QACzB;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,eAAe,IAAI;QAEnB;;WAEG;QACH,WAAW,IAAI;KAClB;IAED;;OAEG;IACI,MAAM,sBAAsB;QAC/B;;;;;;WAMG;;QAGH;;;;;;;WAOG;;MAEL,CAAC;IAEH;;OAEG;IACH,UAAiB,mBAAoB,SAAQ,cAAc,CAAC,OAAO,sBAAsB,CAAC;KAAG;IAE7F;;;;OAIG;IACI,MAAM,6BAA6B;QACtC;;;;WAIG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,0BAA2B,SAAQ,cAAc,CAAC,OAAO,6BAA6B,CAAC;KAAG;IAE3G;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;eAKG;;gBAnkBP;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;mBAMG;;gBAGH;;;;;;;;;;;;;;;;mBAgBG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;mBAMG;;gBAGH;;;;;;;mBAOG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA+BG;;;gBAsGH;;;;;;;mBAOG;;gBAGH;;;;;;;;;;;;;mBAaG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAmGG;;gBAGH;;;;;;;;;;mBAUG;;gBAGH;;;;;;;;;;;mBAWG;;gBAGH;;;;;;;;mBAQG;;gBAGH;;;;;;;;;mBASG;;gBAGH;;;;;;;;;;;;;;mBAcG;;;YA0LC;;eAEG;;gBA7KP;;;;;;mBAMG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA2BG;;;gBAsCH;;;;;;mBAMG;;gBAGH;;;;;;;mBAOG;;;YAsFC;;eAEG;;gBAzEP;;;;mBAIG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA+BG;;;;UAsCL,CAAC;IAEH;;OAEG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,gCAAgC,GAAG,yBAAyB,CAAC,OAAO,CAAC;AACjF,eAAO,MAAM,gCAAgC,mCAAoC,CAAC"}