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

package/src/clusters/alarm-base.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 {
+    FixedAttribute,
+    Command,
+    TlvNoResponse,
+    Attribute,
+    OptionalCommand,
+    Event,
+    EventPriority
+} from "../cluster/Cluster.js";
+import { TlvUInt32 } from "../tlv/TlvNumber.js";
+import { TlvField, TlvObject } from "../tlv/TlvObject.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { Identity } from "#general";
+
+export namespace AlarmBase {
+    /**
+     * These are optional features supported by AlarmBaseCluster.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.4
+     */
+    export 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
+     */
+    export const TlvResetRequest = 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: TlvField(0, TlvUInt32)
+    });
+
+    /**
+     * Input to the AlarmBase reset command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.1
+     */
+    export interface ResetRequest extends TypeFromSchema<typeof TlvResetRequest> {}
+
+    /**
+     * Input to the AlarmBase modifyEnabledAlarms command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+     */
+    export const TlvModifyEnabledAlarmsRequest = 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: TlvField(0, TlvUInt32)
+    });
+
+    /**
+     * Input to the AlarmBase modifyEnabledAlarms command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.7.2
+     */
+    export interface ModifyEnabledAlarmsRequest extends TypeFromSchema<typeof TlvModifyEnabledAlarmsRequest> {}
+
+    /**
+     * Body of the AlarmBase notify event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+     */
+    export const TlvNotifyEvent = TlvObject({
+        /**
+         * This field shall indicate those alarms that have become active.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.1
+         */
+        active: TlvField(1, TlvUInt32),
+
+        /**
+         * This field shall indicate those alarms that have become inactive.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1.2
+         */
+        inactive: TlvField(2, 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: TlvField(3, 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: TlvField(4, TlvUInt32)
+    });
+
+    /**
+     * Body of the AlarmBase notify event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.15.8.1
+     */
+    export interface NotifyEvent extends TypeFromSchema<typeof TlvNotifyEvent> {}
+
+    /**
+     * A AlarmBaseCluster supports these elements if it supports feature Reset.
+     */
+    export const ResetComponent = 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: FixedAttribute(0x1, 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: Command(0x0, TlvResetRequest, 0x0, TlvNoResponse)
+        }
+    });
+
+    /**
+     * AlarmBase is a derived cluster, not to be used directly. These elements are present in all clusters derived from
+     * AlarmBase.
+     */
+    export const Base = 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: 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: Attribute(0x0, 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: Attribute(0x2, 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: FixedAttribute(0x3, 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: OptionalCommand(0x1, TlvModifyEnabledAlarmsRequest, 0x1, 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: Event(0x0, EventPriority.Info, TlvNotifyEvent)
+        },
+
+        /**
+         * This metadata controls which AlarmBaseCluster elements matter.js activates for specific feature combinations.
+         */
+        extensions: MutableCluster.Extensions({ flags: { reset: true }, component: ResetComponent })
+    });
+
+    const RESET = { reset: true };
+
+    /**
+     * @see {@link Complete}
+     */
+    export const CompleteInstance = MutableCluster.Component({
+        name: Base.name,
+        revision: Base.revision,
+        features: Base.features,
+        attributes: {
+            ...Base.attributes,
+            latch: MutableCluster.AsConditional(ResetComponent.attributes.latch, { mandatoryIf: [RESET] })
+        },
+        commands: {
+            ...Base.commands,
+            reset: MutableCluster.AsConditional(ResetComponent.commands.reset, { mandatoryIf: [RESET] })
+        },
+        events: Base.events
+    });
+
+    /**
+     * 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.
+     */
+    export interface Complete extends Identity<typeof CompleteInstance> {}
+
+    export const Complete: Complete = CompleteInstance;
+}

package/src/clusters/application-basic.ts

@@ -0,0 +1,178 @@
+/**
+ * @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 { OptionalFixedAttribute, FixedAttribute, Attribute } from "../cluster/Cluster.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { TlvUInt16, TlvEnum } from "../tlv/TlvNumber.js";
+import { TlvField, TlvObject } from "../tlv/TlvObject.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+import { AccessLevel } from "#model";
+import { Identity } from "#general";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+
+export namespace ApplicationBasic {
+    /**
+     * This indicates a global identifier for an Application given a catalog.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.2
+     */
+    export const TlvApplication = TlvObject({
+        /**
+         * This field shall indicate the Connectivity Standards Alliance issued vendor ID for the catalog. The DIAL
+         * registry shall use value 0x0000.
+         *
+         * It is assumed that Content App Platform providers (see Video Player Architecture section in [MatterDevLib])
+         * will have their own catalog vendor ID (set to their own Vendor ID) and will assign an ApplicationID to each
+         * Content App.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.2.1
+         */
+        catalogVendorId: TlvField(0, TlvUInt16),
+
+        /**
+         * This field shall indicate the application identifier, expressed as a string, such as "123456-5433",
+         * "PruneVideo" or "Company X". This field shall be unique within a catalog.
+         *
+         * For the DIAL registry catalog, this value shall be the DIAL prefix.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.2.2
+         */
+        applicationId: TlvField(1, TlvString)
+    });
+
+    /**
+     * This indicates a global identifier for an Application given a catalog.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.2
+     */
+    export interface Application extends TypeFromSchema<typeof TlvApplication> {}
+
+    /**
+     * @see {@link MatterSpecification.v13.Cluster} § 6.3.4.1
+     */
+    export enum ApplicationStatus {
+        /**
+         * Application is not running.
+         */
+        Stopped = 0,
+
+        /**
+         * Application is running, is visible to the user, and is the active target for input.
+         */
+        ActiveVisibleFocus = 1,
+
+        /**
+         * Application is running but not visible to the user.
+         */
+        ActiveHidden = 2,
+
+        /**
+         * Application is running and visible, but is not the active target for input.
+         */
+        ActiveVisibleNotFocus = 3
+    }
+
+    /**
+     * @see {@link Cluster}
+     */
+    export const ClusterInstance = MutableCluster({
+        id: 0x50d,
+        name: "ApplicationBasic",
+        revision: 1,
+
+        attributes: {
+            /**
+             * This attribute shall specify a human readable (displayable) name of the vendor for the Content App.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.1
+             */
+            vendorName: OptionalFixedAttribute(0x0, TlvString.bound({ maxLength: 32 })),
+
+            /**
+             * This attribute, if present, shall specify the Connectivity Standards Alliance assigned Vendor ID for the
+             * Content App.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.2
+             */
+            vendorId: OptionalFixedAttribute(0x1, TlvVendorId),
+
+            /**
+             * This attribute shall specify a human readable (displayable) name of the Content App assigned by the
+             * vendor. For example, "NPR On Demand". The maximum length of the ApplicationName attribute is 256 bytes
+             * of UTF-8 characters.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.3
+             */
+            applicationName: FixedAttribute(0x2, TlvString),
+
+            /**
+             * This attribute, if present, shall specify a numeric ID assigned by the vendor to identify a specific
+             * Content App made by them. If the Content App is certified by the Connectivity Standards Alliance, then
+             * this would be the Product ID as specified by the vendor for the certification.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.4
+             */
+            productId: OptionalFixedAttribute(0x3, TlvUInt16),
+
+            /**
+             * This attribute shall specify a Content App which consists of an Application ID using a specified catalog.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.5
+             */
+            application: FixedAttribute(0x4, TlvApplication),
+
+            /**
+             * This attribute shall specify the current running status of the application.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.6
+             */
+            status: Attribute(0x5, TlvEnum<ApplicationStatus>()),
+
+            /**
+             * This attribute shall specify a human readable (displayable) version of the Content App assigned by the
+             * vendor. The maximum length of the ApplicationVersion attribute is 32 bytes of UTF-8 characters.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.7
+             */
+            applicationVersion: FixedAttribute(0x6, TlvString.bound({ maxLength: 32 })),
+
+            /**
+             * This attribute is a list of vendor IDs. Each entry is a vendor-id.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.3.5.8
+             */
+            allowedVendorList: FixedAttribute(
+                0x7,
+                TlvArray(TlvVendorId),
+                { default: [], readAcl: AccessLevel.Administer, writeAcl: AccessLevel.Administer }
+            )
+        }
+    });
+
+    /**
+     * This cluster provides information about a Content App running on a Video Player device which is represented as
+     * an endpoint (see Device Type Library document).
+     *
+     * The cluster server for this cluster should be supported on each endpoint that represents a Content App on a
+     * Video Player device. This cluster provides identification information about the Content App such as vendor and
+     * product.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.3
+     */
+    export interface Cluster extends Identity<typeof ClusterInstance> {}
+
+    export const Cluster: Cluster = ClusterInstance;
+    export const Complete = Cluster;
+}
+
+export type ApplicationBasicCluster = ApplicationBasic.Cluster;
+export const ApplicationBasicCluster = ApplicationBasic.Cluster;
+ClusterRegistry.register(ApplicationBasic.Complete);