@matter/types 0.13.0-alpha.0-20250329-cd36948da → 0.13.0-alpha.0-20250330-df5a17eba

package/dist/esm/clusters/ota-software-update-requestor.js

@@ -31,7 +31,7 @@ var OtaSoftwareUpdateRequestor;
      * This field shall contain the Node ID of the OTA Provider to contact within the Fabric identified by the
      * FabricIndex.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.4.4.1
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.4.4.1
      */
     providerNodeId: TlvField(1, TlvNodeId),
     /**
@@ -39,7 +39,7 @@ var OtaSoftwareUpdateRequestor;
      * Provider cluster server on the ProviderNodeID. This is provided to avoid having to do discovery of the
      * location of that endpoint by walking over all endpoints and checking their Descriptor Cluster.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.4.4.2
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.4.4.2
      */
     endpoint: TlvField(2, TlvEndpointNumber),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -67,20 +67,20 @@ var OtaSoftwareUpdateRequestor;
      * This field shall contain the Node ID of a Node implementing the OTA Provider cluster server, on the accessing
      * fabric.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.6.1.1
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.6.1.1
      */
     providerNodeId: TlvField(0, TlvNodeId),
     /**
      * This field shall contain the assigned Vendor ID of the Node invoking this command, as it would appear in that
      * Node’s Basic Information Cluster VendorID attribute.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.6.1.2
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.6.1.2
      */
     vendorId: TlvField(1, TlvVendorId),
     /**
      * This field shall contain a value expressing the reason for the announcement.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.6.1.3
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.6.1.3
      */
     announcementReason: TlvField(2, TlvEnum()),
     /**
@@ -93,7 +93,7 @@ var OtaSoftwareUpdateRequestor;
      * This field SHOULD only be included if the sending OTA Provider has knowledge that some recipient can make use
      * of it.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.6.1.4
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.6.1.4
      */
     metadataForNode: TlvOptionalField(3, TlvByteString.bound({ maxLength: 512 })),
     /**
@@ -134,7 +134,7 @@ var OtaSoftwareUpdateRequestor;
      * be useful in environments such as field trials or integration test environments to hint at additional
      * capabilities which OTA Requestors may use in a particular Vendor-specific context.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.6.1.5
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.6.1.5
      */
     endpoint: TlvField(4, TlvEndpointNumber),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -152,26 +152,26 @@ var OtaSoftwareUpdateRequestor;
      * This field shall be set to the state that preceded the transition causing this event to be generated, if such
      * a state existed. If no previous state exists, the value shall be Unknown.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.1.1
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.1.1
      */
     previousState: TlvField(0, TlvEnum()),
     /**
      * This field shall be set to the state now in effect through the transition causing this event to be generated.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.1.2
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.1.2
      */
     newState: TlvField(1, TlvEnum()),
     /**
      * This field shall be set to the reason why this event was generated.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.1.3
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.1.3
      */
     reason: TlvField(2, TlvEnum()),
     /**
      * This field shall be set to the target SoftwareVersion which is the subject of the operation, whenever the
      * NewState is Downloading, Applying or RollingBack. Otherwise TargetSoftwareVersion shall be null.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.1.4
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.1.4
      */
     targetSoftwareVersion: TlvField(3, TlvNullable(TlvUInt32))
   });
@@ -180,7 +180,7 @@ var OtaSoftwareUpdateRequestor;
      * This field shall be set to the same value as the one available in the Software Version attribute of the Basic
      * Information Cluster for the newly executing version.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.2.1
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.2.1
      */
     softwareVersion: TlvField(0, TlvUInt32),
     /**
@@ -189,7 +189,7 @@ var OtaSoftwareUpdateRequestor;
      * functional update that may impact aspects of the product reflected in the DeviceModel schema of the
      * Distributed Compliance Ledger.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.2.2
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.2.2
      */
     productId: TlvField(1, TlvUInt16)
   });
@@ -198,14 +198,14 @@ var OtaSoftwareUpdateRequestor;
      * This field shall be set to the value of the SoftwareVersion being downloaded, matching the SoftwareVersion
      * field of the QueryImageResponse that caused the failing download to take place.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.3.1
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.3.1
      */
     softwareVersion: TlvField(0, TlvUInt32),
     /**
      * This field shall be set to the number of bytes that have been downloaded during the failing transfer that
      * caused this event to be generated.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.3.2
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.3.2
      */
     bytesDownloaded: TlvField(1, TlvUInt64),
     /**
@@ -213,7 +213,7 @@ var OtaSoftwareUpdateRequestor;
      * failure occurred during the failing transfer that caused this event to be generated, unless the total length
      * of the transfer is unknown, in which case it shall be null.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.3.3
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.3.3
      */
     progressPercent: TlvField(2, TlvNullable(TlvUInt8.bound({ max: 100 }))),
     /**
@@ -221,7 +221,7 @@ var OtaSoftwareUpdateRequestor;
      * proximity to the failure that caused this event to be generated. Otherwise, it shall be null. This event
      * field may be used for debugging purposes and no uniform definition exists related to its meaning.
      *
-     * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.3.4
+     * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.3.4
      */
     platformCode: TlvField(3, TlvNullable(TlvInt64))
   });
@@ -241,7 +241,7 @@ var OtaSoftwareUpdateRequestor;
        * Provider Locations obtained using the AnnounceOTAProvider command shall NOT overwrite values set in the
        * DefaultOTAProviders attribute.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.20.7.5.1
+       * @see {@link MatterSpecification.v14.Core} § 11.20.7.5.1
        */
       defaultOtaProviders: WritableFabricScopedAttribute(
         0,
@@ -254,7 +254,7 @@ var OtaSoftwareUpdateRequestor;
        * of an internal battery. This field is merely informational for diagnostics purposes and shall NOT affect
        * the responses provided by an OTA Provider to an OTA Requestor.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.20.7.5.2
+       * @see {@link MatterSpecification.v14.Core} § 11.20.7.5.2
        */
       updatePossible: Attribute(1, TlvBoolean, { default: true }),
       /**
@@ -263,7 +263,7 @@ var OtaSoftwareUpdateRequestor;
        *
        * This field SHOULD be updated in a timely manner whenever OTA Requestor internal state updates.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.20.7.5.3
+       * @see {@link MatterSpecification.v14.Core} § 11.20.7.5.3
        */
       updateState: Attribute(2, TlvEnum(), { default: 0 /* Unknown */ }),
       /**
@@ -277,7 +277,7 @@ var OtaSoftwareUpdateRequestor;
        * This field may be updated infrequently. Some care SHOULD be taken by Nodes to avoid over- reporting
        * progress when this attribute is part of a subscription.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.20.7.5.4
+       * @see {@link MatterSpecification.v14.Core} § 11.20.7.5.4
        */
       updateStateProgress: Attribute(3, TlvNullable(TlvUInt8.bound({ max: 100 })), { default: null })
     },
@@ -289,7 +289,7 @@ var OtaSoftwareUpdateRequestor;
        *
        * If the accessing fabric index is 0, this command shall fail with an UNSUPPORTED_ACCESS status code.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.20.7.6.1
+       * @see {@link MatterSpecification.v14.Core} § 11.20.7.6.1
        */
       announceOtaProvider: OptionalCommand(
         0,
@@ -304,7 +304,7 @@ var OtaSoftwareUpdateRequestor;
        * This event shall be generated when a change of the UpdateState attribute occurs due to an OTA Requestor
        * moving through the states necessary to query for updates.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.1
+       * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.1
        */
       stateTransition: Event(0, EventPriority.Info, OtaSoftwareUpdateRequestor2.TlvStateTransitionEvent),
       /**
@@ -312,13 +312,13 @@ var OtaSoftwareUpdateRequestor;
        * software update. This event SHOULD be generated even if a software update was done using means outside of
        * this cluster.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.2
+       * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.2
        */
       versionApplied: Event(1, EventPriority.Critical, OtaSoftwareUpdateRequestor2.TlvVersionAppliedEvent),
       /**
        * This event shall be generated whenever an error occurs during OTA Requestor download operation.
        *
-       * @see {@link MatterSpecification.v13.Core} § 11.20.7.7.3
+       * @see {@link MatterSpecification.v14.Core} § 11.20.7.7.3
        */
       downloadError: Event(2, EventPriority.Info, OtaSoftwareUpdateRequestor2.TlvDownloadErrorEvent)
     }

package/dist/esm/clusters/oven-cavity-operational-state.d.ts

@@ -26,7 +26,7 @@ export declare namespace OvenCavityOperationalState {
              * A null value indicates that the device does not present phases during its operation. When this
              * attribute’s value is null, the CurrentPhase attribute shall also be set to null.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.1
              */
             readonly phaseList: Attribute<string[] | null, any>;
             /**
@@ -38,7 +38,7 @@ export declare namespace OvenCavityOperationalState {
              *
              * Null if the PhaseList attribute is null or if the PhaseList attribute is an empty list.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.2
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.2
              */
             readonly currentPhase: Attribute<number | null, any>;
             /**
@@ -70,7 +70,7 @@ export declare namespace OvenCavityOperationalState {
              * As this attribute is not being reported during a regular countdown, clients SHOULD NOT rely on the
              * reporting of this attribute in order to keep track of the remaining duration.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.3
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.3
              */
             readonly countdownTime: OptionalAttribute<number | null, any>;
             /**
@@ -83,7 +83,7 @@ export declare namespace OvenCavityOperationalState {
              * OperationalStateEnum. A device type requiring implementation of this cluster shall define the set of
              * states that are applicable to that specific device type.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.4
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.4
              */
             readonly operationalStateList: Attribute<import("../index.js").TypeFromFields<{
                 operationalStateId: import("../index.js").FieldType<OperationalState.OperationalStateEnum>;
@@ -93,7 +93,7 @@ export declare namespace OvenCavityOperationalState {
              * This attribute specifies the current operational state of a device. This shall be populated with a valid
              * OperationalStateID from the set of values in the OperationalStateList Attribute.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.5
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.5
              */
             readonly operationalState: Attribute<OperationalState.OperationalStateEnum, any>;
             /**
@@ -103,7 +103,7 @@ export declare namespace OvenCavityOperationalState {
              *
              * When there is no error detected, this shall have an ErrorStateID of NoError.
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.6
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.6
              */
             readonly operationalError: Attribute<import("../index.js").TypeFromFields<{
                 errorStateId: import("../index.js").FieldType<OperationalState.ErrorState>;
@@ -118,7 +118,7 @@ export declare namespace OvenCavityOperationalState {
              *
              * This event shall contain the following fields:
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.1
              */
             readonly operationalError: Event<import("../index.js").TypeFromFields<{
                 errorState: import("../index.js").FieldType<import("../index.js").TypeFromFields<{
@@ -138,7 +138,7 @@ export declare namespace OvenCavityOperationalState {
              *
              * This event shall contain the following fields:
              *
-             * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.2
+             * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.2
              */
             readonly operationCompletion: OptionalEvent<import("../index.js").TypeFromFields<{
                 completionErrorCode: import("../index.js").FieldType<number>;
@@ -151,7 +151,7 @@ export declare namespace OvenCavityOperationalState {
      * This cluster is derived from the Operational State cluster and provides an interface for monitoring the
      * operational state of an oven.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 8.10
+     * @see {@link MatterSpecification.v14.Cluster} § 8.10
      */
     interface Cluster extends Identity<typeof ClusterInstance> {
     }

package/dist/esm/clusters/oven-cavity-operational-state.js

@@ -27,7 +27,7 @@ var OvenCavityOperationalState;
        * A null value indicates that the device does not present phases during its operation. When this
        * attribute’s value is null, the CurrentPhase attribute shall also be set to null.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.1
        */
       phaseList: Attribute(0, TlvNullable(TlvArray(TlvString, { maxLength: 32 }))),
       /**
@@ -39,7 +39,7 @@ var OvenCavityOperationalState;
        *
        * Null if the PhaseList attribute is null or if the PhaseList attribute is an empty list.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.2
        */
       currentPhase: Attribute(1, TlvNullable(TlvUInt8)),
       /**
@@ -71,7 +71,7 @@ var OvenCavityOperationalState;
        * As this attribute is not being reported during a regular countdown, clients SHOULD NOT rely on the
        * reporting of this attribute in order to keep track of the remaining duration.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.3
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.3
        */
       countdownTime: OptionalAttribute(2, TlvNullable(TlvUInt32.bound({ max: 259200 })), { default: null }),
       /**
@@ -84,14 +84,14 @@ var OvenCavityOperationalState;
        * OperationalStateEnum. A device type requiring implementation of this cluster shall define the set of
        * states that are applicable to that specific device type.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.4
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.4
        */
       operationalStateList: Attribute(3, TlvArray(OperationalState.TlvOperationalStateStruct), { default: [] }),
       /**
        * This attribute specifies the current operational state of a device. This shall be populated with a valid
        * OperationalStateID from the set of values in the OperationalStateList Attribute.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.5
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.5
        */
       operationalState: Attribute(4, TlvEnum()),
       /**
@@ -101,7 +101,7 @@ var OvenCavityOperationalState;
        *
        * When there is no error detected, this shall have an ErrorStateID of NoError.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.6
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.5.6
        */
       operationalError: Attribute(5, OperationalState.TlvErrorStateStruct)
     },
@@ -112,7 +112,7 @@ var OvenCavityOperationalState;
        *
        * This event shall contain the following fields:
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.1
        */
       operationalError: Event(0, EventPriority.Critical, OperationalState.TlvOperationalErrorEvent),
       /**
@@ -126,7 +126,7 @@ var OvenCavityOperationalState;
        *
        * This event shall contain the following fields:
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.14.7.2
        */
       operationCompletion: OptionalEvent(1, EventPriority.Info, OperationalState.TlvOperationCompletionEvent)
     }