@matter/types 0.11.0-alpha.0-20241005-e3e4e4a7a

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

@@ -0,0 +1 @@
+{"version":3,"file":"ota-software-update-requestor.d.ts","sourceRoot":"","sources":["../../../src/clusters/ota-software-update-requestor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EACH,6BAA6B,EAC7B,SAAS,EACT,eAAe,EAEf,KAAK,EAER,MAAM,uBAAuB,CAAC;AAM/B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAOrD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,0BAA0B,CAAC;IACxC;;;;OAIG;IACI,MAAM,mBAAmB;QAC5B;;;;;WAKG;;QAGH;;;;;;;;WAQG;;;MAIL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,gBAAiB,SAAQ,cAAc,CAAC,OAAO,mBAAmB,CAAC;KAAG;IAEvF;;OAEG;IACH,KAAY,WAAW;QACnB;;;;;;;WAOG;QACH,OAAO,IAAI;QAEX;;;;;;;WAOG;QACH,IAAI,IAAI;QAER;;;;;;;WAOG;QACH,QAAQ,IAAI;QAEZ;;;;;;;WAOG;QACH,cAAc,IAAI;QAElB;;;;;;WAMG;QACH,WAAW,IAAI;QAEf;;;;;;WAMG;QACH,QAAQ,IAAI;QAEZ;;;;;;;WAOG;QACH,cAAc,IAAI;QAElB;;;;;;;;WAQG;QACH,WAAW,IAAI;QAEf;;WAEG;QACH,oBAAoB,IAAI;KAC3B;IAED;;OAEG;IACH,KAAY,kBAAkB;QAC1B;;;;;;;WAOG;QACH,kBAAkB,IAAI;QAEtB;;;;;;;;;;WAUG;QACH,eAAe,IAAI;QAEnB;;;;;;;;;;;;;WAaG;QACH,qBAAqB,IAAI;KAC5B;IAED;;;;OAIG;IACI,MAAM,6BAA6B;QACtC;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;WAIG;;QAGH;;;;;;;;;;;WAWG;;QAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwCG;;;MAIL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,0BAA2B,SAAQ,cAAc,CAAC,OAAO,6BAA6B,CAAC;KAAG;IAE3G;;OAEG;IACH,KAAY,YAAY;QACpB;;;;;;WAMG;QACH,OAAO,IAAI;QAEX;;;;;;WAMG;QACH,OAAO,IAAI;QAEX;;;;;;WAMG;QACH,OAAO,IAAI;QAEX;;;;;;;WAOG;QACH,OAAO,IAAI;QAEX;;;;;;;WAOG;QACH,eAAe,IAAI;KACtB;IAED;;;;OAIG;IACI,MAAM,uBAAuB;QAChC;;;;;WAKG;;QAGH;;;;WAIG;;QAGH;;;;WAIG;;QAGH;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,oBAAqB,SAAQ,cAAc,CAAC,OAAO,uBAAuB,CAAC;KAAG;IAE/F;;;;OAIG;IACI,MAAM,sBAAsB;QAC/B;;;;;WAKG;;QAGH;;;;;;;WAOG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,mBAAoB,SAAQ,cAAc,CAAC,OAAO,sBAAsB,CAAC;KAAG;IAE7F;;;;OAIG;IACI,MAAM,qBAAqB;QAC9B;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;;;WAMG;;QAGH;;;;;;WAMG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;;;;;;;;eAYG;;gBAvcP;;;;;mBAKG;;gBAGH;;;;;;;;mBAQG;;;;YA8bC;;;;;;;eAOG;;YAGH;;;;;;;eAOG;;YAGH;;;;;;;;;;;;eAYG;;;;YAKH;;;;;;;;eAQG;;gBAnVP;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;mBAIG;;gBAGH;;;;;;;;;;;mBAWG;;gBAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAwCG;;;;;;YAiRC;;;;;eAKG;;gBA/MP;;;;;mBAKG;;gBAGH;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;;mBAKG;;;YAuLC;;;;;;eAMG;;gBA5KP;;;;;mBAKG;;gBAGH;;;;;;;mBAOG;;;YAgKC;;;;eAIG;;gBAnJP;;;;;mBAKG;;gBAGH;;;;;mBAKG;;gBAGH;;;;;;mBAMG;;gBAGH;;;;;;mBAMG;;;;UAuHL,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,iCAAiC,GAAG,0BAA0B,CAAC,OAAO,CAAC;AACnF,eAAO,MAAM,iCAAiC,oCAAqC,CAAC"}

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

@@ -0,0 +1,338 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import {
+  WritableFabricScopedAttribute,
+  Attribute,
+  OptionalCommand,
+  TlvNoResponse,
+  Event,
+  EventPriority
+} from "../cluster/Cluster.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+import { TlvNodeId } from "../datatype/NodeId.js";
+import { TlvEndpointNumber } from "../datatype/EndpointNumber.js";
+import { TlvFabricIndex } from "../datatype/FabricIndex.js";
+import { AccessLevel } from "#model";
+import { TlvBoolean } from "../tlv/TlvBoolean.js";
+import { TlvEnum, TlvUInt8, TlvUInt32, TlvUInt16, TlvUInt64, TlvInt64 } from "../tlv/TlvNumber.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { TlvByteString } from "../tlv/TlvString.js";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+var OtaSoftwareUpdateRequestor;
+((OtaSoftwareUpdateRequestor2) => {
+  OtaSoftwareUpdateRequestor2.TlvProviderLocation = TlvObject({
+    /**
+     * 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
+     */
+    providerNodeId: TlvField(1, TlvNodeId),
+    /**
+     * This field shall contain the endpoint number which has the OTA Provider device type and OTA
+     *
+     * Software Update 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
+     */
+    endpoint: TlvField(2, TlvEndpointNumber),
+    fabricIndex: TlvField(254, TlvFabricIndex)
+  });
+  let UpdateState;
+  ((UpdateState2) => {
+    UpdateState2[UpdateState2["Unknown"] = 0] = "Unknown";
+    UpdateState2[UpdateState2["Idle"] = 1] = "Idle";
+    UpdateState2[UpdateState2["Querying"] = 2] = "Querying";
+    UpdateState2[UpdateState2["DelayedOnQuery"] = 3] = "DelayedOnQuery";
+    UpdateState2[UpdateState2["Downloading"] = 4] = "Downloading";
+    UpdateState2[UpdateState2["Applying"] = 5] = "Applying";
+    UpdateState2[UpdateState2["DelayedOnApply"] = 6] = "DelayedOnApply";
+    UpdateState2[UpdateState2["RollingBack"] = 7] = "RollingBack";
+    UpdateState2[UpdateState2["DelayedOnUserConsent"] = 8] = "DelayedOnUserConsent";
+  })(UpdateState = OtaSoftwareUpdateRequestor2.UpdateState || (OtaSoftwareUpdateRequestor2.UpdateState = {}));
+  let AnnouncementReason;
+  ((AnnouncementReason2) => {
+    AnnouncementReason2[AnnouncementReason2["SimpleAnnouncement"] = 0] = "SimpleAnnouncement";
+    AnnouncementReason2[AnnouncementReason2["UpdateAvailable"] = 1] = "UpdateAvailable";
+    AnnouncementReason2[AnnouncementReason2["UrgentUpdateAvailable"] = 2] = "UrgentUpdateAvailable";
+  })(AnnouncementReason = OtaSoftwareUpdateRequestor2.AnnouncementReason || (OtaSoftwareUpdateRequestor2.AnnouncementReason = {}));
+  OtaSoftwareUpdateRequestor2.TlvAnnounceOtaProviderRequest = TlvObject({
+    /**
+     * 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
+     */
+    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
+     */
+    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
+     */
+    announcementReason: TlvField(2, TlvEnum()),
+    /**
+     * This optional field, if present, shall consist of a top-level anonymous list; each list element shall have a
+     * profile-specific tag encoded in fully-qualified form. Each list element shall contain a
+     * manufacturer-specific payload, which the Node invoking this command wants to expose to the receiving Node.
+     * This payload may be used for any purpose and SHOULD be as small as practical, especially if invoked to
+     * groups, in order to reduce networking burden of these payloads.
+     *
+     * 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
+     */
+    metadataForNode: TlvOptionalField(3, TlvByteString.bound({ maxLength: 512 })),
+    /**
+     * This field shall contain the endpoint number which has the OTA Provider device type and OTA Software Update
+     * 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.
+     *
+     * When Generated
+     *
+     * An OTA Provider may invoke this command directly to an OTA Requestor, to announce its presence as an OTA
+     * Provider on the Fabric.
+     *
+     * These announcements, if made, SHOULD be made at most once every 24 hours for any given target Node, to
+     * assist OTA Requestors in discovering available OTA Provider resources, unless the AnnouncementReason is
+     * UrgentUpdateAvailable, in which case this command may be more frequent.
+     *
+     * Any invocation shall be made with a delay of at least 1 second between invocations from a given OTA
+     * Provider, to reduce burden on the networking infrastructure and affect a form of serialized jitter. It is
+     * recommended to offset the first announcement of a round (i.e. new set of announcements after a previous
+     * complete set) by a random delay time with a distribution span of >= 60 seconds to jitter announcement
+     * schedules over time.
+     *
+     * Effect on Receipt
+     *
+     * On receipt of this command, an OTA Requestor SHOULD consider the new ProviderNodeID and AnnouncementReason
+     * to possibly query for new software sooner than it would have with its default behavior.
+     *
+     * The OTA Requestor SHOULD NOT update entries in the DefaultOTAProviders list based on announcements.
+     *
+     * The receiving Node may ignore the content of the announcement if it is unable or unwilling to further query
+     * OTA Providers temporarily, or if its provider list is full. If the announcement is ignored, the response
+     * SHOULD be SUCCESS.
+     *
+     * Depending on the value of the AnnouncementReason field, the OTA Requestor may have to query the OTA
+     * Provider. See Section 11.20.7.6.1.3, “AnnouncementReason Field” for the different values and their meaning.
+     *
+     * If present, the MetadataForNode field’s may be used by a receiving OTA Requestor in any way it deems
+     * satisfactory. The MetadataForNode field SHOULD be empty under most normal operational circumstance, but can
+     * 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
+     */
+    endpoint: TlvField(4, TlvEndpointNumber),
+    fabricIndex: TlvField(254, TlvFabricIndex)
+  });
+  let ChangeReason;
+  ((ChangeReason2) => {
+    ChangeReason2[ChangeReason2["Unknown"] = 0] = "Unknown";
+    ChangeReason2[ChangeReason2["Success"] = 1] = "Success";
+    ChangeReason2[ChangeReason2["Failure"] = 2] = "Failure";
+    ChangeReason2[ChangeReason2["TimeOut"] = 3] = "TimeOut";
+    ChangeReason2[ChangeReason2["DelayByProvider"] = 4] = "DelayByProvider";
+  })(ChangeReason = OtaSoftwareUpdateRequestor2.ChangeReason || (OtaSoftwareUpdateRequestor2.ChangeReason = {}));
+  OtaSoftwareUpdateRequestor2.TlvStateTransitionEvent = TlvObject({
+    /**
+     * 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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    targetSoftwareVersion: TlvField(3, TlvNullable(TlvUInt32))
+  });
+  OtaSoftwareUpdateRequestor2.TlvVersionAppliedEvent = TlvObject({
+    /**
+     * 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
+     */
+    softwareVersion: TlvField(0, TlvUInt32),
+    /**
+     * This field shall be set to the ProductID applying to the executing version, as reflected by the Basic
+     * Information Cluster. This can be used to detect a product updating its definition due to a large-scale
+     * 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
+     */
+    productId: TlvField(1, TlvUInt16)
+  });
+  OtaSoftwareUpdateRequestor2.TlvDownloadErrorEvent = TlvObject({
+    /**
+     * 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
+     */
+    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
+     */
+    bytesDownloaded: TlvField(1, TlvUInt64),
+    /**
+     * This field shall be set to the nearest integer percent value reflecting how far within the transfer the
+     * 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
+     */
+    progressPercent: TlvField(2, TlvNullable(TlvUInt8.bound({ max: 100 }))),
+    /**
+     * This field SHOULD be set to some internal product-specific error code, closest in temporal/functional
+     * 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
+     */
+    platformCode: TlvField(3, TlvNullable(TlvInt64))
+  });
+  OtaSoftwareUpdateRequestor2.ClusterInstance = MutableCluster({
+    id: 42,
+    name: "OtaSoftwareUpdateRequestor",
+    revision: 1,
+    attributes: {
+      /**
+       * This field is a list of ProviderLocation whose entries shall be set by Administrators, either during
+       * Commissioning or at a later time, to set the ProviderLocation for the default OTA Provider Node to use
+       * for software updates on a given Fabric.
+       *
+       * There shall NOT be more than one entry per Fabric. On a list update that would introduce more than one
+       * entry per fabric, the write shall fail with CONSTRAINT_ERROR status code.
+       *
+       * 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
+       */
+      defaultOtaProviders: WritableFabricScopedAttribute(
+        0,
+        TlvArray(OtaSoftwareUpdateRequestor2.TlvProviderLocation),
+        { default: [], writeAcl: AccessLevel.Administer }
+      ),
+      /**
+       * This field shall be set to True if the OTA Requestor is currently able to be updated. Otherwise, it
+       * shall be set to False in case of any condition preventing update being possible, such as insufficient
+       * capacity 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
+       */
+      updatePossible: Attribute(1, TlvBoolean, { default: true }),
+      /**
+       * This field shall reflect the current state of the OTA Requestor with regards to obtaining software
+       * updates. See Section 11.20.7.4.2, “UpdateStateEnum Type” for possible values.
+       *
+       * 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
+       */
+      updateState: Attribute(2, TlvEnum(), { default: 0 /* Unknown */ }),
+      /**
+       * This field shall reflect the percentage value of progress, relative to the current UpdateState, if
+       * applicable to the state.
+       *
+       * The value of this field shall be null if a progress indication does not apply to the current state.
+       *
+       * A value of 0 shall indicate that the beginning has occurred. A value of 100 shall indicate completion.
+       *
+       * 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
+       */
+      updateStateProgress: Attribute(3, TlvNullable(TlvUInt8.bound({ max: 100 })), { default: null })
+    },
+    commands: {
+      /**
+       * This command may be invoked by Administrators to announce the presence of a particular OTA Provider.
+       *
+       * This command shall be scoped to the accessing fabric.
+       *
+       * 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
+       */
+      announceOtaProvider: OptionalCommand(
+        0,
+        OtaSoftwareUpdateRequestor2.TlvAnnounceOtaProviderRequest,
+        0,
+        TlvNoResponse,
+        { invokeAcl: AccessLevel.Administer }
+      )
+    },
+    events: {
+      /**
+       * 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
+       */
+      stateTransition: Event(0, EventPriority.Info, OtaSoftwareUpdateRequestor2.TlvStateTransitionEvent),
+      /**
+       * 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.v13.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
+       */
+      downloadError: Event(2, EventPriority.Info, OtaSoftwareUpdateRequestor2.TlvDownloadErrorEvent)
+    }
+  });
+  OtaSoftwareUpdateRequestor2.Cluster = OtaSoftwareUpdateRequestor2.ClusterInstance;
+  OtaSoftwareUpdateRequestor2.Complete = OtaSoftwareUpdateRequestor2.Cluster;
+})(OtaSoftwareUpdateRequestor || (OtaSoftwareUpdateRequestor = {}));
+const OtaSoftwareUpdateRequestorCluster = OtaSoftwareUpdateRequestor.Cluster;
+ClusterRegistry.register(OtaSoftwareUpdateRequestor.Complete);
+export {
+  OtaSoftwareUpdateRequestor,
+  OtaSoftwareUpdateRequestorCluster
+};
+//# sourceMappingURL=ota-software-update-requestor.js.map

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

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/clusters/ota-software-update-requestor.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AACP,SAAS,gBAAgB;AACzB,SAAS,UAAU,WAAW,wBAAwB;AACtD,SAAS,iBAAiB;AAC1B,SAAS,yBAAyB;AAClC,SAAS,sBAAsB;AAE/B,SAAS,mBAAmB;AAC5B,SAAS,kBAAkB;AAC3B,SAAS,SAAS,UAAU,WAAW,WAAW,WAAW,gBAAgB;AAC7E,SAAS,mBAAmB;AAC5B,SAAS,mBAAmB;AAC5B,SAAS,qBAAqB;AAE9B,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,gCAAV;AAMI,EAAMA,4BAAA,sBAAsB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOzC,gBAAgB,SAAS,GAAG,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAWrC,UAAU,SAAS,GAAG,iBAAiB;AAAA,IAEvC,aAAa,SAAS,KAAK,cAAc;AAAA,EAC7C,CAAC;AAYM,MAAK;AAAL,IAAKC,iBAAL;AASH,IAAAA,0BAAA,aAAU,KAAV;AAUA,IAAAA,0BAAA,UAAO,KAAP;AAUA,IAAAA,0BAAA,cAAW,KAAX;AAUA,IAAAA,0BAAA,oBAAiB,KAAjB;AASA,IAAAA,0BAAA,iBAAc,KAAd;AASA,IAAAA,0BAAA,cAAW,KAAX;AAUA,IAAAA,0BAAA,oBAAiB,KAAjB;AAWA,IAAAA,0BAAA,iBAAc,KAAd;AAKA,IAAAA,0BAAA,0BAAuB,KAAvB;AAAA,KAnFQ,cAAAD,4BAAA,gBAAAA,4BAAA;AAyFL,MAAK;AAAL,IAAKE,wBAAL;AASH,IAAAA,wCAAA,wBAAqB,KAArB;AAaA,IAAAA,wCAAA,qBAAkB,KAAlB;AAgBA,IAAAA,wCAAA,2BAAwB,KAAxB;AAAA,KAtCQ,qBAAAF,4BAAA,uBAAAA,4BAAA;AA8CL,EAAMA,4BAAA,gCAAgC,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOnD,gBAAgB,SAAS,GAAG,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQrC,UAAU,SAAS,GAAG,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjC,oBAAoB,SAAS,GAAG,QAA4B,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAc7D,iBAAiB,iBAAiB,GAAG,cAAc,MAAM,EAAE,WAAW,IAAI,CAAC,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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IA2C5E,UAAU,SAAS,GAAG,iBAAiB;AAAA,IAEvC,aAAa,SAAS,KAAK,cAAc;AAAA,EAC7C,CAAC;AAYM,MAAK;AAAL,IAAKG,kBAAL;AAQH,IAAAA,4BAAA,aAAU,KAAV;AASA,IAAAA,4BAAA,aAAU,KAAV;AASA,IAAAA,4BAAA,aAAU,KAAV;AAUA,IAAAA,4BAAA,aAAU,KAAV;AAUA,IAAAA,4BAAA,qBAAkB,KAAlB;AAAA,KA9CQ,eAAAH,4BAAA,iBAAAA,4BAAA;AAsDL,EAAMA,4BAAA,0BAA0B,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO7C,eAAe,SAAS,GAAG,QAAqB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjD,UAAU,SAAS,GAAG,QAAqB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO5C,QAAQ,SAAS,GAAG,QAAsB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ3C,uBAAuB,SAAS,GAAG,YAAY,SAAS,CAAC;AAAA,EAC7D,CAAC;AAcM,EAAMA,4BAAA,yBAAyB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO5C,iBAAiB,SAAS,GAAG,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUtC,WAAW,SAAS,GAAG,SAAS;AAAA,EACpC,CAAC;AAcM,EAAMA,4BAAA,wBAAwB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,iBAAiB,SAAS,GAAG,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQtC,iBAAiB,SAAS,GAAG,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAStC,iBAAiB,SAAS,GAAG,YAAY,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAStE,cAAc,SAAS,GAAG,YAAY,QAAQ,CAAC;AAAA,EACnD,CAAC;AAYM,EAAMA,4BAAA,kBAAkB,eAAe;AAAA,IAC1C,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAcR,qBAAqB;AAAA,QACjB;AAAA,QACA,SAASA,4BAAA,mBAAmB;AAAA,QAC5B,EAAE,SAAS,CAAC,GAAG,UAAU,YAAY,WAAW;AAAA,MACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAUA,gBAAgB,UAAU,GAAK,YAAY,EAAE,SAAS,KAAK,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAU5D,aAAa,UAAU,GAAK,QAAqB,GAAG,EAAE,SAAS,gBAAoB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAepF,qBAAqB,UAAU,GAAK,YAAY,SAAS,MAAM,EAAE,KAAK,IAAI,CAAC,CAAC,GAAG,EAAE,SAAS,KAAK,CAAC;AAAA,IACpG;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAUN,qBAAqB;AAAA,QACjB;AAAA,QACAA,4BAAA;AAAA,QACA;AAAA,QACA;AAAA,QACA,EAAE,WAAW,YAAY,WAAW;AAAA,MACxC;AAAA,IACJ;AAAA,IAEA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOJ,iBAAiB,MAAM,GAAK,cAAc,MAAMA,4BAAA,uBAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASvE,gBAAgB,MAAM,GAAK,cAAc,UAAUA,4BAAA,sBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOzE,eAAe,MAAM,GAAK,cAAc,MAAMA,4BAAA,qBAAqB;AAAA,IACvE;AAAA,EACJ,CAAC;AAOM,EAAMA,4BAAA,UAAmBA,4BAAA;AACzB,EAAMA,4BAAA,WAAWA,4BAAA;AAAA,GA7iBX;AAijBV,MAAM,oCAAoC,2BAA2B;AAC5E,gBAAgB,SAAS,2BAA2B,QAAQ;",
+  "names": ["OtaSoftwareUpdateRequestor", "UpdateState", "AnnouncementReason", "ChangeReason"]
+}

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

@@ -0,0 +1,273 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { Attribute, OptionalAttribute, OptionalCommand, Event, OptionalEvent } from "../cluster/Cluster.js";
+import { Identity } from "#general";
+export declare namespace OvenCavityOperationalState {
+    /**
+     * @see {@link Cluster}
+     */
+    const ClusterInstance: MutableCluster<{
+        readonly id: 72;
+        readonly name: "OvenCavityOperationalState";
+        readonly revision: 1;
+        readonly attributes: {
+            /**
+             * Indicates a list of names of different phases that the device can go through for the selected function
+             * or mode. The list may not be in sequence order. For example in a washing machine this could include
+             * items such as "pre-soak", "rinse", and "spin". These phases are manufacturer specific and may change
+             * when a different function or mode is selected.
+             *
+             * 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
+             */
+            readonly phaseList: Attribute<string[] | null, any>;
+            /**
+             * This attribute represents the current phase of operation being performed by the server. This shall be
+             * the positional index representing the value from the set provided in the PhaseList Attribute, where the
+             * first item in that list is an index of 0. Thus, this attribute shall have a maximum value that is
+             * "length(PhaseList) - 1".
+             *
+             * 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
+             */
+            readonly currentPhase: Attribute<number | null, any>;
+            /**
+             * Indicates the estimated time left before the operation is completed, in seconds. Changes to this value
+             * shall NOT be reported in a subscription (note the C Quality). A Client implementation may periodically
+             * poll this value to ensure alignment of any local rendering of the CountdownTime with the device provided
+             * value.
+             *
+             * A value of 0 means that the operation has completed.
+             *
+             * When this attribute is null, that represents that there is no time currently defined until operation
+             * completion. This may happen, for example, because no operation is in progress or because the completion
+             * time is unknown.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.3
+             */
+            readonly countdownTime: OptionalAttribute<number | null, any>;
+            /**
+             * This attribute describes the set of possible operational states that the device exposes. An operational
+             * state is a fundamental device state such as Running or Error. Details of the phase of a device when, for
+             * example, in a state of Running are provided by the CurrentPhase attribute.
+             *
+             * All devices shall, at a minimum, expose the set of states matching the commands that are also supported
+             * by the cluster instance, in addition to Error. The set of possible device states are defined in the
+             * 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
+             */
+            readonly operationalStateList: Attribute<import("../index.js").TypeFromFields<{
+                operationalStateId: import("../index.js").FieldType<number>;
+                operationalStateLabel: import("../index.js").OptionalFieldType<string>;
+            }>[], any>;
+            /**
+             * 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
+             */
+            readonly operationalState: Attribute<number, 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 there is no error detected, this shall have an ErrorStateID of NoError.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.5.6
+             */
+            readonly operationalError: Attribute<import("../index.js").TypeFromFields<{
+                errorStateId: import("../index.js").FieldType<number>;
+                errorStateLabel: import("../index.js").OptionalFieldType<string>;
+                errorStateDetails: import("../index.js").OptionalFieldType<string>;
+            }>, any>;
+        };
+        readonly commands: {
+            /**
+             * This command shall be supported if the device supports remotely pausing the operation. If this command
+             * is supported, the Resume command shall also be supported.
+             *
+             * On receipt of this command, the device shall pause its operation if it is possible based on the current
+             * function of the server. For example, if it is at a point where it is safe to do so and/or permitted, but
+             * can be restarted from the point at which pause occurred.
+             *
+             * If this command is received when already in the Paused state the device shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of NoError but take no further action.
+             *
+             * A device that receives this command in any state which is not Pause-compatible shall respond
+             *
+             * with an OperationalCommandResponse command with an ErrorStateID of CommandInvalidInState and shall take
+             * no further action.
+             *
+             * States are defined as Pause-compatible as follows:
+             *
+             *   • For states defined in this cluster specification, in Table 3, “Pause Compatibility”.
+             *
+             *   • For states defined by derived cluster specifications, in the corresponding specifications.
+             *
+             *   • For manufacturer-specific states, by the manufacturer.
+             *
+             * A device that is unable to honor the Pause command for whatever reason shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of CommandInvalidInState but take no further
+             * action.
+             *
+             * Otherwise, on success:
+             *
+             *   • The OperationalState attribute shall be set to Paused.
+             *
+             *   • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.
+             *
+             * The following table defines the compatibility of this cluster’s states with the Pause command.
+             *
+             * ### Table 3. Pause Compatibility
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.1
+             */
+            readonly pause: OptionalCommand<void, void, any>;
+            /**
+             * This command shall be supported if the device supports remotely stopping the operation.
+             *
+             * On receipt of this command, the device shall stop its operation if it is at a position where it is safe
+             * to do so and/or permitted. Restart of the device following the receipt of the Stop command shall require
+             * attended operation unless remote start is allowed by the device type and any jurisdiction governing
+             * remote operation of the device.
+             *
+             * If this command is received when already in the Stopped state the device shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of NoError but take no further action.
+             *
+             * A device that is unable to honor the Stop command for whatever reason shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of CommandInvalidInState but take no further
+             * action.
+             *
+             * Otherwise, on success:
+             *
+             *   • The OperationalState attribute shall be set to Stopped.
+             *
+             *   • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.2
+             */
+            readonly stop: OptionalCommand<void, void, any>;
+            /**
+             * This command shall be supported if the device supports remotely starting the operation. If this command
+             * is supported, the 'Stop command shall also be supported.
+             *
+             * On receipt of this command, the device shall start its operation if it is safe to do so and the device
+             * is in an operational state from which it can be started. There may be either regulatory or
+             * manufacturer-imposed safety and security requirements that first necessitate some specific action at the
+             * device before a Start command can be honored. In such instances, a device shall respond with a status
+             * code of CommandInvalidInState if a Start command is received prior to the required on- device action.
+             *
+             * If this command is received when already in the Running state the device shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of NoError but take no further action.
+             *
+             * A device that is unable to honor the Start command for whatever reason shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of UnableToStartOrResume but take no further
+             * action.
+             *
+             * Otherwise, on success:
+             *
+             *   • The OperationalState attribute shall be set to Running.
+             *
+             *   • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.3
+             */
+            readonly start: OptionalCommand<void, void, any>;
+            /**
+             * This command shall be supported if the device supports remotely resuming the operation. If this command
+             * is supported, the Pause command shall also be supported.
+             *
+             * On receipt of this command, the device shall resume its operation from the point it was at when it
+             * received the Pause command, or from the point when it was paused by means outside of this cluster (for
+             * example by manual button press).
+             *
+             * If this command is received when already in the Running state the device shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of NoError but take no further action.
+             *
+             * A device that receives this command in any state which is not Resume-compatible shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of CommandInvalidInState and shall take no
+             * further action.
+             *
+             * States are defined as Resume-compatible as follows:
+             *
+             *   • For states defined in this cluster specification, in Table 4, “Resume Compatibility”.
+             *
+             *   • For states defined by derived cluster specifications, in the corresponding specifications.
+             *
+             *   • For manufacturer-specific states, by the manufacturer.
+             *
+             * The following table defines the compatibility of this cluster’s states with the Resume command.
+             *
+             * ### Table 4. Resume Compatibility
+             *
+             * A device that is unable to honor the Resume command for any other reason shall respond with an
+             * OperationalCommandResponse command with an ErrorStateID of UnableToStartOrResume but take no further
+             * action.
+             *
+             * Otherwise, on success:
+             *
+             *   • The OperationalState attribute shall be set to the most recent non-Error operational state prior to
+             *     entering the Paused state.
+             *
+             *   • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.6.4
+             */
+            readonly resume: OptionalCommand<void, void, any>;
+        };
+        readonly events: {
+            /**
+             * This event is generated when a reportable error condition is detected. A device that generates this
+             * event shall also set the OperationalState attribute to Error, indicating an error condition.
+             *
+             * This event shall contain the following fields:
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.1
+             */
+            readonly operationalError: Event<import("../index.js").TypeFromFields<{
+                errorState: import("../index.js").FieldType<import("../index.js").TypeFromFields<{
+                    errorStateId: import("../index.js").FieldType<number>;
+                    errorStateLabel: import("../index.js").OptionalFieldType<string>;
+                    errorStateDetails: import("../index.js").OptionalFieldType<string>;
+                }>>;
+            }>, any>;
+            /**
+             * This event is generated when the overall operation ends, successfully or otherwise. For example, the
+             * completion of a cleaning operation in a Robot Vacuum Cleaner, or the completion of a wash cycle in a
+             * Washing Machine.
+             *
+             * This event shall contain the following fields:
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.14.7.2
+             */
+            readonly operationCompletion: OptionalEvent<import("../index.js").TypeFromFields<{
+                completionErrorCode: import("../index.js").FieldType<number>;
+                totalOperationalTime: import("../index.js").OptionalFieldType<number | null>;
+                pausedTime: import("../index.js").OptionalFieldType<number | null>;
+            }>, any>;
+        };
+    }, []>;
+    /**
+     * This cluster provides an interface for monitoring the operational state of an oven.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 8.10
+     */
+    interface Cluster extends Identity<typeof ClusterInstance> {
+    }
+    const Cluster: Cluster;
+    const Complete: Cluster;
+}
+export type OvenCavityOperationalStateCluster = OvenCavityOperationalState.Cluster;
+export declare const OvenCavityOperationalStateCluster: OvenCavityOperationalState.Cluster;
+//# sourceMappingURL=oven-cavity-operational-state.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"oven-cavity-operational-state.d.ts","sourceRoot":"","sources":["../../../src/clusters/oven-cavity-operational-state.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EACH,SAAS,EACT,iBAAiB,EACjB,eAAe,EAEf,KAAK,EAEL,aAAa,EAChB,MAAM,uBAAuB,CAAC;AAO/B,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,0BAA0B,CAAC;IACxC;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;;;;;;eAUG;;YAGH;;;;;;;;;eASG;;YAGH;;;;;;;;;;;;;eAaG;;YAOH;;;;;;;;;;;eAWG;;;;;YAGH;;;;;eAKG;;YAGH;;;;;;;;eAQG;;;;;;;;YAKH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAuCG;;YAGH;;;;;;;;;;;;;;;;;;;;;;eAsBG;;YAGH;;;;;;;;;;;;;;;;;;;;;;;;eAwBG;;YAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAuCG;;;;YAKH;;;;;;;eAOG;;;;;;;;YAGH;;;;;;;;eAQG;;;;;;;UAGT,CAAC;IAEH;;;;OAIG;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,iCAAiC,GAAG,0BAA0B,CAAC,OAAO,CAAC;AACnF,eAAO,MAAM,iCAAiC,oCAAqC,CAAC"}