@matter/types 0.17.4 → 0.17.5-alpha.0-20260704-9ea70abfa

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

@@ -20,7 +20,7 @@ import type { VendorId } from "../datatype/VendorId.js";
  *
  * This cluster implements the Requestor role in the OTA process.
  *
- * @see {@link MatterSpecification.v151.Core} § 11.20.7
+ * @see {@link MatterSpecification.v16.Core} § 11.20.7
  */
 export declare namespace OtaSoftwareUpdateRequestor {
     /**
@@ -34,7 +34,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
     export const name: "OtaSoftwareUpdateRequestor";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 1;
 
@@ -60,7 +60,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * Provider Locations obtained using the AnnounceOTAProvider command shall NOT overwrite values set in the
          * DefaultOTAProviders attribute.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.5.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.5.1
          */
         defaultOtaProviders: ProviderLocation[];
 
@@ -70,7 +70,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * 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.v151.Core} § 11.20.7.5.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.5.2
          */
         updatePossible: boolean;
 
@@ -80,7 +80,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          *
          * This field SHOULD be updated in a timely manner whenever OTA Requestor internal state updates.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.5.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.5.3
          */
         updateState: UpdateState;
 
@@ -95,7 +95,7 @@ export declare namespace 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.v151.Core} § 11.20.7.5.4
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.5.4
          */
         updateStateProgress: number | null;
     }
@@ -115,7 +115,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * Provider Locations obtained using the AnnounceOTAProvider command shall NOT overwrite values set in the
          * DefaultOTAProviders attribute.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.5.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.5.1
          */
         defaultOtaProviders: ProviderLocation[];
 
@@ -125,7 +125,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * 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.v151.Core} § 11.20.7.5.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.5.2
          */
         updatePossible: boolean;
 
@@ -135,7 +135,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          *
          * This field SHOULD be updated in a timely manner whenever OTA Requestor internal state updates.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.5.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.5.3
          */
         updateState: UpdateState;
 
@@ -150,7 +150,7 @@ export declare namespace 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.v151.Core} § 11.20.7.5.4
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.5.4
          */
         updateStateProgress: number | null;
     }
@@ -166,7 +166,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          *
          * If the accessing fabric index is 0, this command shall fail with an UNSUPPORTED_ACCESS status code.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.6.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.6.1
          */
         announceOtaProvider(request: AnnounceOtaProviderRequest): MaybePromise;
     }
@@ -184,7 +184,7 @@ export declare namespace 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.v151.Core} § 11.20.7.7.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.1
          */
         stateTransition: StateTransitionEvent;
 
@@ -193,14 +193,14 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * update. This event SHOULD be generated even if a software update was done using means outside of this
          * cluster.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.2
          */
         versionApplied: VersionAppliedEvent;
 
         /**
          * This event shall be generated whenever an error occurs during OTA Requestor download operation.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.3
          */
         downloadError: DownloadErrorEvent;
     }
@@ -213,7 +213,7 @@ export declare namespace 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.v151.Core} § 11.20.7.7.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.1
          */
         stateTransition: StateTransitionEvent;
 
@@ -222,14 +222,14 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * update. This event SHOULD be generated even if a software update was done using means outside of this
          * cluster.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.2
          */
         versionApplied: VersionAppliedEvent;
 
         /**
          * This event shall be generated whenever an error occurs during OTA Requestor download operation.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.3
          */
         downloadError: DownloadErrorEvent;
     }
@@ -239,7 +239,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
     /**
      * This structure encodes a fabric-scoped location of an OTA provider on a given fabric.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.4
+     * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.4
      */
     export class ProviderLocation {
         constructor(values?: Partial<ProviderLocation>);
@@ -248,7 +248,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This field shall contain the Node ID of the OTA Provider to contact within the Fabric identified by the
          * FabricIndex.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.4.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.4.1
          */
         providerNodeId: NodeId;
 
@@ -257,7 +257,7 @@ export declare namespace 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.v151.Core} § 11.20.7.4.4.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.4.2
          */
         endpoint: EndpointNumber;
 
@@ -265,7 +265,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2
+     * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2
      */
     export enum UpdateState {
         /**
@@ -274,7 +274,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This value shall indicate that the current state is not yet determined. Nodes SHOULD attempt a better state
          * reporting.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2.1
          */
         Unknown = 0,
 
@@ -284,7 +284,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This value shall indicate a Node not yet in the process of software update, for example because it is
          * awaiting the moment when a query will be made.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2.2
          */
         Idle = 1,
 
@@ -294,7 +294,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This value shall indicate a Node in the process of querying an OTA Provider with QueryImage command,
          * including during the process of awaiting a response to that command.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2.3
          */
         Querying = 2,
 
@@ -304,7 +304,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This value shall indicate a Node waiting because it received a prior QueryImageResponse with a Status field
          * indicating Busy.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2.4
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2.4
          */
         DelayedOnQuery = 3,
 
@@ -313,7 +313,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          *
          * This value shall indicate a Node currently in the process of downloading a software update.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2.5
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2.5
          */
         Downloading = 4,
 
@@ -322,7 +322,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          *
          * This value shall indicate a Node currently in the process of verifying and applying a software update.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2.6
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2.6
          */
         Applying = 5,
 
@@ -332,7 +332,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This value shall indicate a Node waiting because it received a prior ApplyUpdateResponse with an Action field
          * set to AwaitNextAction.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2.7
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2.7
          */
         DelayedOnApply = 6,
 
@@ -343,7 +343,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * was applied, but that could not remain in force, for reasons such as invalid data detected on boot, or
          * significant runtime issues such as reboot loops. Eventually, the next state seen SHOULD be Unknown or Idle.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.2.8
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.2.8
          */
         RollingBack = 7,
 
@@ -360,7 +360,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
      *
      * If the accessing fabric index is 0, this command shall fail with an UNSUPPORTED_ACCESS status code.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.20.7.6.1
+     * @see {@link MatterSpecification.v16.Core} § 11.20.7.6.1
      */
     export class AnnounceOtaProviderRequest {
         constructor(values?: Partial<AnnounceOtaProviderRequest>);
@@ -369,7 +369,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This field shall contain the Node ID of a Node implementing the OTA Provider cluster server, on the accessing
          * fabric.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.6.1.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.6.1.1
          */
         providerNodeId: NodeId;
 
@@ -377,14 +377,14 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * 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.v151.Core} § 11.20.7.6.1.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.6.1.2
          */
         vendorId: VendorId;
 
         /**
          * This field shall contain a value expressing the reason for the announcement.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.6.1.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.6.1.3
          */
         announcementReason: AnnouncementReason;
 
@@ -398,7 +398,7 @@ export declare namespace 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.v151.Core} § 11.20.7.6.1.4
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.6.1.4
          */
         metadataForNode?: Bytes;
 
@@ -407,7 +407,7 @@ export declare namespace 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.v151.Core} § 11.20.7.6.1.5
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.6.1.5
          */
         endpoint: EndpointNumber;
     }
@@ -416,7 +416,7 @@ export declare namespace 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.v151.Core} § 11.20.7.7.1
+     * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.1
      */
     export class StateTransitionEvent {
         constructor(values?: Partial<StateTransitionEvent>);
@@ -425,21 +425,21 @@ export declare namespace 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.v151.Core} § 11.20.7.7.1.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.1.1
          */
         previousState: UpdateState;
 
         /**
          * This field shall be set to the state now in effect through the transition causing this event to be generated.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.1.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.1.2
          */
         newState: UpdateState;
 
         /**
          * This field shall be set to the reason why this event was generated.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.1.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.1.3
          */
         reason: ChangeReason;
 
@@ -447,7 +447,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * 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.v151.Core} § 11.20.7.7.1.4
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.1.4
          */
         targetSoftwareVersion: number | null;
     }
@@ -456,7 +456,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
      * This event shall be generated whenever a new version starts executing after being applied due to a software
      * update. This event SHOULD be generated even if a software update was done using means outside of this cluster.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.2
+     * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.2
      */
     export class VersionAppliedEvent {
         constructor(values?: Partial<VersionAppliedEvent>);
@@ -465,7 +465,7 @@ export declare namespace 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.v151.Core} § 11.20.7.7.2.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.2.1
          */
         softwareVersion: number;
 
@@ -475,7 +475,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * functional update that may impact aspects of the product reflected in the DeviceModel schema of the
          * Distributed Compliance Ledger.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.2.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.2.2
          */
         productId: number;
     }
@@ -483,7 +483,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
     /**
      * This event shall be generated whenever an error occurs during OTA Requestor download operation.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.20.7.7.3
+     * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.3
      */
     export class DownloadErrorEvent {
         constructor(values?: Partial<DownloadErrorEvent>);
@@ -492,7 +492,7 @@ export declare namespace 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.v151.Core} § 11.20.7.7.3.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.3.1
          */
         softwareVersion: number;
 
@@ -500,7 +500,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * 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.v151.Core} § 11.20.7.7.3.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.3.2
          */
         bytesDownloaded: number | bigint;
 
@@ -509,7 +509,7 @@ export declare namespace 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.v151.Core} § 11.20.7.7.3.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.3.3
          */
         progressPercent: number | null;
 
@@ -518,13 +518,13 @@ export declare namespace 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.v151.Core} § 11.20.7.7.3.4
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.7.3.4
          */
         platformCode: number | bigint | null;
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.1
+     * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.1
      */
     export enum AnnouncementReason {
         /**
@@ -533,7 +533,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * An OTA Provider is announcing its presence, but there is no implication that an OTA Requestor would have a
          * new Software Image available if it queried immediately.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.1.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.1.1
          */
         SimpleAnnouncement = 0,
 
@@ -546,7 +546,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * receiving OTA Requestor SHOULD only query the indicated OTA Provider at the ProviderLocation at its next
          * upcoming OTA Provider query.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.1.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.1.2
          */
         UpdateAvailable = 1,
 
@@ -562,13 +562,13 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * just after initial commissioning of a device, to assist OTA Requestors in more rapidly obtaining updated
          * software.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.1.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.1.3
          */
         UrgentUpdateAvailable = 2
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.3
+     * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.3
      */
     export enum ChangeReason {
         /**
@@ -576,7 +576,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          *
          * This value shall indicate that the reason for a state change is unknown.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.3.1
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.3.1
          */
         Unknown = 0,
 
@@ -585,7 +585,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          *
          * This value shall indicate that the reason for a state change is the success of a prior operation.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.3.2
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.3.2
          */
         Success = 1,
 
@@ -594,7 +594,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          *
          * This value shall indicate that the reason for a state change is the failure of a prior operation.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.3.3
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.3.3
          */
         Failure = 2,
 
@@ -604,7 +604,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This value shall indicate that the reason for a state change is a time-out condition as determined by the OTA
          * Requestor.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.3.4
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.3.4
          */
         TimeOut = 3,
 
@@ -614,7 +614,7 @@ export declare namespace OtaSoftwareUpdateRequestor {
          * This value shall indicate that the reason for a state change is a request by the OTA Provider to await for a
          * delay.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.20.7.4.3.5
+         * @see {@link MatterSpecification.v16.Core} § 11.20.7.4.3.5
          */
         DelayByProvider = 4
     }