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

package/dist/cjs/clusters/alarm-base.d.ts

@@ -0,0 +1,451 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { FixedAttribute, Command, Attribute, OptionalCommand, Event } from "../cluster/Cluster.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { Identity } from "#general";
+export declare namespace AlarmBase {
+    /**
+     * These are optional features supported by AlarmBaseCluster.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.4
+     */
+    enum Feature {
+        /**
+         * Reset (RESET)
+         *
+         * This feature indicates that alarms can be reset via the Reset command.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.4.1
+         */
+        Reset = "Reset"
+    }
+    /**
+     * Input to the AlarmBase reset command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+     */
+    const TlvResetRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall indicate a bitmap where each bit set in this field corresponds to an alarm that shall be
+         * reset to inactive in the State attribute unless the alarm definition requires manual intervention. If the
+         * alarms indicated are successfully reset, the response status code shall be SUCCESS, otherwise, the response
+         * status code shall be FAILURE.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1.1
+         */
+        alarms: import("../tlv/TlvObject.js").FieldType<number>;
+    }>;
+    /**
+     * Input to the AlarmBase reset command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+     */
+    interface ResetRequest extends TypeFromSchema<typeof TlvResetRequest> {
+    }
+    /**
+     * Input to the AlarmBase modifyEnabledAlarms command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+     */
+    const TlvModifyEnabledAlarmsRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall indicate a bitmap where each bit set in the this field corresponds to an alarm that SHOULD
+         * be enabled or suppressed. A value of 1 shall indicate that the alarm SHOULD be enabled while a value of 0
+         * shall indicate that the alarm SHOULD be suppressed.
+         *
+         * A server that receives this command with a Mask that includes bits that are set for unknown alarms shall
+         * respond with a status code of INVALID_COMMAND.
+         *
+         * A server that receives this command with a Mask that includes bits that are set for alarms which are not
+         * supported, as indicated in the Supported attribute, shall respond with a status code of INVALID_COMMAND.
+         *
+         * A server that is unable to enable a currently suppressed alarm, or is unable to suppress a currently enabled
+         * alarm shall respond with a status code of FAILURE; otherwise the server shall respond with a status code of
+         * SUCCESS.
+         *
+         * On a SUCCESS case, the server shall also change the value of the Mask attribute to the value of the
+         *
+         * Mask field from this command. After that the server shall also update the value of its State attribute to
+         * reflect the status of the new alarm set as indicated by the new value of the Mask attribute.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2.1
+         */
+        mask: import("../tlv/TlvObject.js").FieldType<number>;
+    }>;
+    /**
+     * Input to the AlarmBase modifyEnabledAlarms command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+     */
+    interface ModifyEnabledAlarmsRequest extends TypeFromSchema<typeof TlvModifyEnabledAlarmsRequest> {
+    }
+    /**
+     * Body of the AlarmBase notify event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+     */
+    const TlvNotifyEvent: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall indicate those alarms that have become active.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.1
+         */
+        active: import("../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * This field shall indicate those alarms that have become inactive.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.2
+         */
+        inactive: import("../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * This field shall be a copy of the new State attribute value that resulted in the event being generated. That
+         * is, this field shall have all the bits in Active set and shall NOT have any of the bits in Inactive set.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.4
+         */
+        state: import("../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * This field shall be a copy of the Mask attribute when this event was generated.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.3
+         */
+        mask: import("../tlv/TlvObject.js").FieldType<number>;
+    }>;
+    /**
+     * Body of the AlarmBase notify event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+     */
+    interface NotifyEvent extends TypeFromSchema<typeof TlvNotifyEvent> {
+    }
+    /**
+     * A AlarmBaseCluster supports these elements if it supports feature Reset.
+     */
+    const ResetComponent: {
+        readonly attributes: {
+            /**
+             * Indicates a bitmap where each bit set in the Latch attribute shall indicate that the corresponding alarm
+             * will be latched when set, and will not reset to inactive when the underlying condition which caused the
+             * alarm is no longer present, and so requires an explicit reset using the Reset command.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.2
+             */
+            readonly latch: FixedAttribute<number, any>;
+        };
+        readonly commands: {
+            /**
+             * This command resets active and latched alarms (if possible). Any generated Notify event shall contain
+             * fields that represent the state of the server after the command has been processed.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+             */
+            readonly reset: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate a bitmap where each bit set in this field corresponds to an alarm that shall be
+                 * reset to inactive in the State attribute unless the alarm definition requires manual intervention. If the
+                 * alarms indicated are successfully reset, the response status code shall be SUCCESS, otherwise, the response
+                 * status code shall be FAILURE.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1.1
+                 */
+                alarms: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, void, any>;
+        };
+    };
+    /**
+     * AlarmBase is a derived cluster, not to be used directly. These elements are present in all clusters derived from
+     * AlarmBase.
+     */
+    const Base: {
+        readonly features: {
+            /**
+             * Reset
+             *
+             * This feature indicates that alarms can be reset via the Reset command.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.4.1
+             */
+            readonly reset: BitFlag;
+        };
+        readonly name: "AlarmBase";
+        readonly revision: 1;
+        readonly attributes: {
+            /**
+             * Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that shall be
+             * enabled.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.1
+             */
+            readonly mask: Attribute<number, any>;
+            /**
+             * Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the
+             * alarm is active, otherwise the alarm is inactive.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.3
+             */
+            readonly state: Attribute<number, any>;
+            /**
+             * Indicates a bitmap where each bit shall represent whether or not an alarm is supported. The value of
+             * true means the alarm is supported, otherwise the alarm is not supported.
+             *
+             * If an alarm is not supported, the corresponding bit in Mask, Latch, and State shall be false.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.4
+             */
+            readonly supported: FixedAttribute<number, any>;
+        };
+        readonly commands: {
+            /**
+             * This command allows a client to request that an alarm be enabled or suppressed at the server.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+             */
+            readonly modifyEnabledAlarms: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate a bitmap where each bit set in the this field corresponds to an alarm that SHOULD
+                 * be enabled or suppressed. A value of 1 shall indicate that the alarm SHOULD be enabled while a value of 0
+                 * shall indicate that the alarm SHOULD be suppressed.
+                 *
+                 * A server that receives this command with a Mask that includes bits that are set for unknown alarms shall
+                 * respond with a status code of INVALID_COMMAND.
+                 *
+                 * A server that receives this command with a Mask that includes bits that are set for alarms which are not
+                 * supported, as indicated in the Supported attribute, shall respond with a status code of INVALID_COMMAND.
+                 *
+                 * A server that is unable to enable a currently suppressed alarm, or is unable to suppress a currently enabled
+                 * alarm shall respond with a status code of FAILURE; otherwise the server shall respond with a status code of
+                 * SUCCESS.
+                 *
+                 * On a SUCCESS case, the server shall also change the value of the Mask attribute to the value of the
+                 *
+                 * Mask field from this command. After that the server shall also update the value of its State attribute to
+                 * reflect the status of the new alarm set as indicated by the new value of the Mask attribute.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2.1
+                 */
+                mask: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, void, any>;
+        };
+        readonly events: {
+            /**
+             * This event shall be generated when one or more alarms change state, and shall have these fields:
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+             */
+            readonly notify: Event<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate those alarms that have become active.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.1
+                 */
+                active: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall indicate those alarms that have become inactive.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.2
+                 */
+                inactive: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall be a copy of the new State attribute value that resulted in the event being generated. That
+                 * is, this field shall have all the bits in Active set and shall NOT have any of the bits in Inactive set.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.4
+                 */
+                state: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall be a copy of the Mask attribute when this event was generated.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.3
+                 */
+                mask: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, any>;
+        };
+        /**
+         * This metadata controls which AlarmBaseCluster elements matter.js activates for specific feature combinations.
+         */
+        readonly extensions: readonly [{
+            readonly flags: {
+                readonly reset: true;
+            };
+            readonly component: {
+                readonly attributes: {
+                    /**
+                     * Indicates a bitmap where each bit set in the Latch attribute shall indicate that the corresponding alarm
+                     * will be latched when set, and will not reset to inactive when the underlying condition which caused the
+                     * alarm is no longer present, and so requires an explicit reset using the Reset command.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.2
+                     */
+                    readonly latch: FixedAttribute<number, any>;
+                };
+                readonly commands: {
+                    /**
+                     * This command resets active and latched alarms (if possible). Any generated Notify event shall contain
+                     * fields that represent the state of the server after the command has been processed.
+                     *
+                     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+                     */
+                    readonly reset: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                        /**
+                         * This field shall indicate a bitmap where each bit set in this field corresponds to an alarm that shall be
+                         * reset to inactive in the State attribute unless the alarm definition requires manual intervention. If the
+                         * alarms indicated are successfully reset, the response status code shall be SUCCESS, otherwise, the response
+                         * status code shall be FAILURE.
+                         *
+                         * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1.1
+                         */
+                        alarms: import("../tlv/TlvObject.js").FieldType<number>;
+                    }>, void, any>;
+                };
+            };
+        }];
+    };
+    /**
+     * @see {@link Complete}
+     */
+    const CompleteInstance: {
+        readonly name: "AlarmBase";
+        readonly revision: 1;
+        readonly features: {
+            /**
+             * Reset
+             *
+             * This feature indicates that alarms can be reset via the Reset command.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.4.1
+             */
+            readonly reset: BitFlag;
+        };
+        readonly attributes: {
+            readonly latch: FixedAttribute<number, any> & {
+                readonly optional: true;
+                readonly isConditional: true;
+                readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
+                readonly mandatoryIf: [] | [{
+                    reset: boolean;
+                }];
+            };
+            /**
+             * Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that shall be
+             * enabled.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.1
+             */
+            readonly mask: Attribute<number, any>;
+            /**
+             * Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the
+             * alarm is active, otherwise the alarm is inactive.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.3
+             */
+            readonly state: Attribute<number, any>;
+            /**
+             * Indicates a bitmap where each bit shall represent whether or not an alarm is supported. The value of
+             * true means the alarm is supported, otherwise the alarm is not supported.
+             *
+             * If an alarm is not supported, the corresponding bit in Mask, Latch, and State shall be false.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.4
+             */
+            readonly supported: FixedAttribute<number, any>;
+        };
+        readonly commands: {
+            readonly reset: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate a bitmap where each bit set in this field corresponds to an alarm that shall be
+                 * reset to inactive in the State attribute unless the alarm definition requires manual intervention. If the
+                 * alarms indicated are successfully reset, the response status code shall be SUCCESS, otherwise, the response
+                 * status code shall be FAILURE.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1.1
+                 */
+                alarms: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, void, any> & {
+                readonly optional: true;
+                readonly isConditional: true;
+                readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
+                readonly mandatoryIf: [] | [{
+                    reset: boolean;
+                }];
+            };
+            /**
+             * This command allows a client to request that an alarm be enabled or suppressed at the server.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+             */
+            readonly modifyEnabledAlarms: OptionalCommand<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate a bitmap where each bit set in the this field corresponds to an alarm that SHOULD
+                 * be enabled or suppressed. A value of 1 shall indicate that the alarm SHOULD be enabled while a value of 0
+                 * shall indicate that the alarm SHOULD be suppressed.
+                 *
+                 * A server that receives this command with a Mask that includes bits that are set for unknown alarms shall
+                 * respond with a status code of INVALID_COMMAND.
+                 *
+                 * A server that receives this command with a Mask that includes bits that are set for alarms which are not
+                 * supported, as indicated in the Supported attribute, shall respond with a status code of INVALID_COMMAND.
+                 *
+                 * A server that is unable to enable a currently suppressed alarm, or is unable to suppress a currently enabled
+                 * alarm shall respond with a status code of FAILURE; otherwise the server shall respond with a status code of
+                 * SUCCESS.
+                 *
+                 * On a SUCCESS case, the server shall also change the value of the Mask attribute to the value of the
+                 *
+                 * Mask field from this command. After that the server shall also update the value of its State attribute to
+                 * reflect the status of the new alarm set as indicated by the new value of the Mask attribute.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2.1
+                 */
+                mask: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, void, any>;
+        };
+        readonly events: {
+            /**
+             * This event shall be generated when one or more alarms change state, and shall have these fields:
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+             */
+            readonly notify: Event<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall indicate those alarms that have become active.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.1
+                 */
+                active: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall indicate those alarms that have become inactive.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.2
+                 */
+                inactive: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall be a copy of the new State attribute value that resulted in the event being generated. That
+                 * is, this field shall have all the bits in Active set and shall NOT have any of the bits in Inactive set.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.4
+                 */
+                state: import("../tlv/TlvObject.js").FieldType<number>;
+                /**
+                 * This field shall be a copy of the Mask attribute when this event was generated.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.3
+                 */
+                mask: import("../tlv/TlvObject.js").FieldType<number>;
+            }>, any>;
+        };
+    };
+    /**
+     * This cluster supports all AlarmBase features. It may support illegal feature combinations.
+     *
+     * If you use this cluster you must manually specify which features are active and ensure the set of active
+     * features is legal per the Matter specification.
+     */
+    interface Complete extends Identity<typeof CompleteInstance> {
+    }
+    const Complete: Complete;
+}
+//# sourceMappingURL=alarm-base.d.ts.map

package/dist/cjs/clusters/alarm-base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alarm-base.d.ts","sourceRoot":"","sources":["../../../src/clusters/alarm-base.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EACH,cAAc,EACd,OAAO,EAEP,SAAS,EACT,eAAe,EACf,KAAK,EAER,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,yBAAiB,SAAS,CAAC;IACvB;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;;;WAMG;QACH,KAAK,UAAU;KAClB;IAED;;;;OAIG;IACI,MAAM,eAAe;QACxB;;;;;;;WAOG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,YAAa,SAAQ,cAAc,CAAC,OAAO,eAAe,CAAC;KAAG;IAE/E;;;;OAIG;IACI,MAAM,6BAA6B;QACtC;;;;;;;;;;;;;;;;;;;;;WAqBG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,0BAA2B,SAAQ,cAAc,CAAC,OAAO,6BAA6B,CAAC;KAAG;IAE3G;;;;OAIG;IACI,MAAM,cAAc;QACvB;;;;WAIG;;QAGH;;;;WAIG;;QAGH;;;;;WAKG;;QAGH;;;;WAIG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,WAAY,SAAQ,cAAc,CAAC,OAAO,cAAc,CAAC;KAAG;IAE7E;;OAEG;IACI,MAAM,cAAc;;YAEnB;;;;;;eAMG;;;;YAKH;;;;;eAKG;;gBAxHP;;;;;;;mBAOG;;;;KAoHL,CAAC;IAEH;;;OAGG;IACI,MAAM,IAAI;;YAET;;;;;;eAMG;;;;;;YAQH;;;;;eAKG;;YAGH;;;;;eAKG;;YAGH;;;;;;;eAOG;;;;YAKH;;;;eAIG;;gBAzJP;;;;;;;;;;;;;;;;;;;;;mBAqBG;;;;;YAyIC;;;;eAIG;;gBA5HP;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;;mBAKG;;gBAGH;;;;mBAIG;;;;QAsGH;;WAEG;;;;;;;oBAxFC;;;;;;uBAMG;;;;oBAKH;;;;;uBAKG;;wBAxHP;;;;;;;2BAOG;;;;;;KA2LL,CAAC;IAIH;;OAEG;IACI,MAAM,gBAAgB;;;;YAtErB;;;;;;eAMG;;;;;;;;;;;;YAQH;;;;;eAKG;;YAGH;;;;;eAKG;;YAGH;;;;;;;eAOG;;;;;gBAxKP;;;;;;;mBAOG;;;;;;;;;;YAsKC;;;;eAIG;;gBAzJP;;;;;;;;;;;;;;;;;;;;;mBAqBG;;;;;YAyIC;;;;eAIG;;gBA5HP;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;;mBAKG;;gBAGH;;;;mBAIG;;;;KA8HL,CAAC;IAEH;;;;;OAKG;IACH,UAAiB,QAAS,SAAQ,QAAQ,CAAC,OAAO,gBAAgB,CAAC;KAAG;IAE/D,MAAM,QAAQ,EAAE,QAA2B,CAAC;CACtD"}

package/dist/cjs/clusters/alarm-base.js

@@ -0,0 +1,200 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var alarm_base_exports = {};
+__export(alarm_base_exports, {
+  AlarmBase: () => AlarmBase
+});
+module.exports = __toCommonJS(alarm_base_exports);
+var import_MutableCluster = require("../cluster/mutation/MutableCluster.js");
+var import_Cluster = require("../cluster/Cluster.js");
+var import_TlvNumber = require("../tlv/TlvNumber.js");
+var import_TlvObject = require("../tlv/TlvObject.js");
+var import_BitmapSchema = require("../schema/BitmapSchema.js");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+var AlarmBase;
+((AlarmBase2) => {
+  let Feature;
+  ((Feature2) => {
+    Feature2["Reset"] = "Reset";
+  })(Feature = AlarmBase2.Feature || (AlarmBase2.Feature = {}));
+  AlarmBase2.TlvResetRequest = (0, import_TlvObject.TlvObject)({
+    /**
+     * This field shall indicate a bitmap where each bit set in this field corresponds to an alarm that shall be
+     * reset to inactive in the State attribute unless the alarm definition requires manual intervention. If the
+     * alarms indicated are successfully reset, the response status code shall be SUCCESS, otherwise, the response
+     * status code shall be FAILURE.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1.1
+     */
+    alarms: (0, import_TlvObject.TlvField)(0, import_TlvNumber.TlvUInt32)
+  });
+  AlarmBase2.TlvModifyEnabledAlarmsRequest = (0, import_TlvObject.TlvObject)({
+    /**
+     * This field shall indicate a bitmap where each bit set in the this field corresponds to an alarm that SHOULD
+     * be enabled or suppressed. A value of 1 shall indicate that the alarm SHOULD be enabled while a value of 0
+     * shall indicate that the alarm SHOULD be suppressed.
+     *
+     * A server that receives this command with a Mask that includes bits that are set for unknown alarms shall
+     * respond with a status code of INVALID_COMMAND.
+     *
+     * A server that receives this command with a Mask that includes bits that are set for alarms which are not
+     * supported, as indicated in the Supported attribute, shall respond with a status code of INVALID_COMMAND.
+     *
+     * A server that is unable to enable a currently suppressed alarm, or is unable to suppress a currently enabled
+     * alarm shall respond with a status code of FAILURE; otherwise the server shall respond with a status code of
+     * SUCCESS.
+     *
+     * On a SUCCESS case, the server shall also change the value of the Mask attribute to the value of the
+     *
+     * Mask field from this command. After that the server shall also update the value of its State attribute to
+     * reflect the status of the new alarm set as indicated by the new value of the Mask attribute.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2.1
+     */
+    mask: (0, import_TlvObject.TlvField)(0, import_TlvNumber.TlvUInt32)
+  });
+  AlarmBase2.TlvNotifyEvent = (0, import_TlvObject.TlvObject)({
+    /**
+     * This field shall indicate those alarms that have become active.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.1
+     */
+    active: (0, import_TlvObject.TlvField)(1, import_TlvNumber.TlvUInt32),
+    /**
+     * This field shall indicate those alarms that have become inactive.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.2
+     */
+    inactive: (0, import_TlvObject.TlvField)(2, import_TlvNumber.TlvUInt32),
+    /**
+     * This field shall be a copy of the new State attribute value that resulted in the event being generated. That
+     * is, this field shall have all the bits in Active set and shall NOT have any of the bits in Inactive set.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.4
+     */
+    state: (0, import_TlvObject.TlvField)(3, import_TlvNumber.TlvUInt32),
+    /**
+     * This field shall be a copy of the Mask attribute when this event was generated.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.3
+     */
+    mask: (0, import_TlvObject.TlvField)(4, import_TlvNumber.TlvUInt32)
+  });
+  AlarmBase2.ResetComponent = import_MutableCluster.MutableCluster.Component({
+    attributes: {
+      /**
+       * Indicates a bitmap where each bit set in the Latch attribute shall indicate that the corresponding alarm
+       * will be latched when set, and will not reset to inactive when the underlying condition which caused the
+       * alarm is no longer present, and so requires an explicit reset using the Reset command.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.2
+       */
+      latch: (0, import_Cluster.FixedAttribute)(1, import_TlvNumber.TlvUInt32)
+    },
+    commands: {
+      /**
+       * This command resets active and latched alarms (if possible). Any generated Notify event shall contain
+       * fields that represent the state of the server after the command has been processed.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+       */
+      reset: (0, import_Cluster.Command)(0, AlarmBase2.TlvResetRequest, 0, import_Cluster.TlvNoResponse)
+    }
+  });
+  AlarmBase2.Base = import_MutableCluster.MutableCluster.Component({
+    features: {
+      /**
+       * Reset
+       *
+       * This feature indicates that alarms can be reset via the Reset command.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.15.4.1
+       */
+      reset: (0, import_BitmapSchema.BitFlag)(0)
+    },
+    name: "AlarmBase",
+    revision: 1,
+    attributes: {
+      /**
+       * Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that shall be
+       * enabled.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.1
+       */
+      mask: (0, import_Cluster.Attribute)(0, import_TlvNumber.TlvUInt32),
+      /**
+       * Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the
+       * alarm is active, otherwise the alarm is inactive.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.3
+       */
+      state: (0, import_Cluster.Attribute)(2, import_TlvNumber.TlvUInt32),
+      /**
+       * Indicates a bitmap where each bit shall represent whether or not an alarm is supported. The value of
+       * true means the alarm is supported, otherwise the alarm is not supported.
+       *
+       * If an alarm is not supported, the corresponding bit in Mask, Latch, and State shall be false.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.15.6.4
+       */
+      supported: (0, import_Cluster.FixedAttribute)(3, import_TlvNumber.TlvUInt32)
+    },
+    commands: {
+      /**
+       * This command allows a client to request that an alarm be enabled or suppressed at the server.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+       */
+      modifyEnabledAlarms: (0, import_Cluster.OptionalCommand)(1, AlarmBase2.TlvModifyEnabledAlarmsRequest, 1, import_Cluster.TlvNoResponse)
+    },
+    events: {
+      /**
+       * This event shall be generated when one or more alarms change state, and shall have these fields:
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+       */
+      notify: (0, import_Cluster.Event)(0, import_Cluster.EventPriority.Info, AlarmBase2.TlvNotifyEvent)
+    },
+    /**
+     * This metadata controls which AlarmBaseCluster elements matter.js activates for specific feature combinations.
+     */
+    extensions: import_MutableCluster.MutableCluster.Extensions({ flags: { reset: true }, component: AlarmBase2.ResetComponent })
+  });
+  const RESET = { reset: true };
+  AlarmBase2.CompleteInstance = import_MutableCluster.MutableCluster.Component({
+    name: AlarmBase2.Base.name,
+    revision: AlarmBase2.Base.revision,
+    features: AlarmBase2.Base.features,
+    attributes: {
+      ...AlarmBase2.Base.attributes,
+      latch: import_MutableCluster.MutableCluster.AsConditional(AlarmBase2.ResetComponent.attributes.latch, { mandatoryIf: [RESET] })
+    },
+    commands: {
+      ...AlarmBase2.Base.commands,
+      reset: import_MutableCluster.MutableCluster.AsConditional(AlarmBase2.ResetComponent.commands.reset, { mandatoryIf: [RESET] })
+    },
+    events: AlarmBase2.Base.events
+  });
+  AlarmBase2.Complete = AlarmBase2.CompleteInstance;
+})(AlarmBase || (AlarmBase = {}));
+//# sourceMappingURL=alarm-base.js.map

package/dist/cjs/clusters/alarm-base.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/clusters/alarm-base.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,4BAA+B;AAC/B,qBAQO;AACP,uBAA0B;AAC1B,uBAAoC;AAEpC,0BAAwB;AArBxB;AAAA;AAAA;AAAA;AAAA;AAwBO,IAAU;AAAA,CAAV,CAAUA,eAAV;AAMI,MAAK;AAAL,IAAKC,aAAL;AAQH,IAAAA,SAAA,WAAQ;AAAA,KARA,UAAAD,WAAA,YAAAA,WAAA;AAgBL,EAAMA,WAAA,sBAAkB,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASrC,YAAQ,2BAAS,GAAG,0BAAS;AAAA,EACjC,CAAC;AAcM,EAAMA,WAAA,oCAAgC,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAuBnD,UAAM,2BAAS,GAAG,0BAAS;AAAA,EAC/B,CAAC;AAcM,EAAMA,WAAA,qBAAiB,4BAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMpC,YAAQ,2BAAS,GAAG,0BAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO7B,cAAU,2BAAS,GAAG,0BAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ/B,WAAO,2BAAS,GAAG,0BAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO5B,UAAM,2BAAS,GAAG,0BAAS;AAAA,EAC/B,CAAC;AAYM,EAAMA,WAAA,iBAAiB,qCAAe,UAAU;AAAA,IACnD,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQR,WAAO,+BAAe,GAAK,0BAAS;AAAA,IACxC;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAON,WAAO,wBAAQ,GAAKA,WAAA,iBAAiB,GAAK,4BAAa;AAAA,IAC3D;AAAA,EACJ,CAAC;AAMM,EAAMA,WAAA,OAAO,qCAAe,UAAU;AAAA,IACzC,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQN,WAAO,6BAAQ,CAAC;AAAA,IACpB;AAAA,IAEA,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOR,UAAM,0BAAU,GAAK,0BAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQ9B,WAAO,0BAAU,GAAK,0BAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAU/B,eAAW,+BAAe,GAAK,0BAAS;AAAA,IAC5C;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMN,yBAAqB,gCAAgB,GAAKA,WAAA,+BAA+B,GAAK,4BAAa;AAAA,IAC/F;AAAA,IAEA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMJ,YAAQ,sBAAM,GAAK,6BAAc,MAAMA,WAAA,cAAc;AAAA,IACzD;AAAA;AAAA;AAAA;AAAA,IAKA,YAAY,qCAAe,WAAW,EAAE,OAAO,EAAE,OAAO,KAAK,GAAG,WAAWA,WAAA,eAAe,CAAC;AAAA,EAC/F,CAAC;AAED,QAAM,QAAQ,EAAE,OAAO,KAAK;AAKrB,EAAMA,WAAA,mBAAmB,qCAAe,UAAU;AAAA,IACrD,MAAMA,WAAA,KAAK;AAAA,IACX,UAAUA,WAAA,KAAK;AAAA,IACf,UAAUA,WAAA,KAAK;AAAA,IACf,YAAY;AAAA,MACR,GAAGA,WAAA,KAAK;AAAA,MACR,OAAO,qCAAe,cAAcA,WAAA,eAAe,WAAW,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,CAAC;AAAA,IACjG;AAAA,IACA,UAAU;AAAA,MACN,GAAGA,WAAA,KAAK;AAAA,MACR,OAAO,qCAAe,cAAcA,WAAA,eAAe,SAAS,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,CAAC;AAAA,IAC/F;AAAA,IACA,QAAQA,WAAA,KAAK;AAAA,EACjB,CAAC;AAUM,EAAMA,WAAA,WAAqBA,WAAA;AAAA,GAvPrB;",
+  "names": ["AlarmBase", "Feature"]
+}