@project-chip/matter.js 0.0.2 → 0.1.0

package/dist/es/cluster/IdentifyCluster.js

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, WritableAttribute, Cluster, Command, OptionalCommand, TlvNoResponse, TlvNoArguments } from "./Cluster.js";
+import { TlvField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvEnum, TlvUInt16 } from "../tlv/TlvNumber.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2.6.1 */
+const TlvIdentifyRequest = TlvObject({
+    identifyTime: TlvField(0, TlvUInt16),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2.6.3 */
+const TlvTriggerEffectRequest = TlvObject({
+    effectIdentifier: TlvField(0, TlvEnum()),
+    effectVariant: TlvField(1, TlvEnum()),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2.6.4 */
+const TlvIdentifyQueryResponse = TlvObject({
+    timeout: TlvField(0, TlvUInt16),
+});
+/**
+ * Attributes and commands for putting a device into Identification mode (e.g. flashing a light).
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2
+ */
+export const IdentifyCluster = Cluster({
+    id: 0x03,
+    name: "Identify",
+    revision: 4,
+    features: {
+        /** Replies to multicast / groupcast queries if the identification state is active. */
+        query: BitFlag(0),
+    },
+    /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2.5 */
+    attributes: {
+        /** Specifies the remaining length of time, in seconds, that the endpoint will continue to identify itself. */
+        identifyTime: WritableAttribute(0, TlvUInt16, { default: 0 }),
+        /** Specifies how the identification state is presented to the user. */
+        identifyType: Attribute(1, TlvEnum(), { default: 0 }),
+    },
+    /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2.6 */
+    commands: {
+        /** Starts or stops the receiving device identifying itself. */
+        identify: Command(0, TlvIdentifyRequest, 0, TlvNoResponse),
+        /** Request the target or targets to respond if they are currently identifying themselves. */
+        identifyQuery: Command(1, TlvNoArguments, 0, TlvIdentifyQueryResponse),
+        /** Allows the support of feedback to the user, such as a certain light effect when identifying. */
+        triggerEffect: OptionalCommand(0x40, TlvTriggerEffectRequest, 0, TlvNoResponse),
+    },
+});

package/dist/es/cluster/LabelCluster.js

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, WritableAttribute } from "./Cluster.js";
+import { TlvField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+/**
+ * This is a string tuple with strings that are user defined.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.7.5.1
+ */
+const TlvLabel = TlvObject({
+    /** Contains a string as label without a further defined semantic n this base cluster. */
+    label: TlvField(0, TlvString.bound({ length: 16 })),
+    /** Contains a string as value without a further defined semantic n this base cluster. */
+    value: TlvField(1, TlvString.bound({ length: 16 })), /* default: "" */
+});
+/**
+ * This cluster provides a feature to tag an endpoint with zero or more labels.
+ * Derived from LabelCluster ({@link MatterCoreSpecificationV1_0} § 9.7)
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.9
+ */
+export const UserLabelCluster = Cluster({
+    id: 0x41,
+    name: "User Label",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 9.9.4 */
+    attributes: {
+        /** An implementation SHALL support at least 4 list entries per node for all User Label cluster instances on the node. */
+        labelList: WritableAttribute(0, TlvArray(TlvLabel), { default: [], writeAcl: 1 /* AccessLevel.Manage */ }), /* non-volatile */
+    },
+});
+/**
+ * This cluster provides a feature for the device to tag an endpoint with zero or more read only labels.
+ * Derived from LabelCluster ({@link MatterCoreSpecificationV1_0} § 9.7)
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.8
+ */
+export const FixedLabelCluster = Cluster({
+    id: 0x40,
+    name: "Fixed Label",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 9.8.4 */
+    attributes: {
+        /** List of fixed labels. */
+        labelList: Attribute(0, TlvArray(TlvLabel), { default: [] }), /* non-volatile */
+    },
+});

package/dist/es/cluster/OnOffCluster.js

@@ -0,0 +1,102 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Command, TlvNoArguments, TlvNoResponse } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { TlvBoolean } from "../tlv/TlvBoolean.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.2 */
+// const TlvEffectVariant = TlvUInt8 as TlvSchema<DyingLightEffectVariant | DelayedAllOffEffectVariant>;
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4 */
+/* const TlvOffWithEffectRequest = TlvObject({
+    effectIdentifier: TlvField(0, TlvEnum<OnOffEffectIdentifier>()),
+    effectVariant: TlvField(1, TlvEffectVariant),
+}) as TlvSchema<
+    { effectIdentifier: OnOffEffectIdentifier.DelayedAllOff, effectVariant: DelayedAllOffEffectVariant } |
+    { effectIdentifier: OnOffEffectIdentifier.DyingLight, effectVariant: DyingLightEffectVariant }
+    >; */
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.2 */
+/* const TlvOnOffControlBitmap = TlvBitmap(TlvUInt8, {
+    acceptOnlyWhenOn: BitFlag(1),
+}) */
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.6. */
+/* const TlvOnWithTimedOffRequest = TlvObject({
+    onOffControl: TlvField(0, TlvOnOffControlBitmap),
+    onTime: TlvField(1, TlvNullable(TlvUInt8.bound({ min: 0, max: 254 }))),
+    offWaitTime: TlvField(2, TlvNullable(TlvUInt8.bound({ min: 0, max: 254 }))),
+}); */
+/**
+ * Attributes and commands for switching devices between 'On' and 'Off' states.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5
+ */
+export const OnOffCluster = Cluster({
+    id: 0x06,
+    name: "On/Off",
+    revision: 4,
+    features: {
+        /** Level Control for Lighting - Behavior that supports lighting applications */
+        lightingLevelControl: BitFlag(0),
+    },
+    /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.6 */
+    attributes: {
+        /** Indicates whether the device type implemented on the endpoint is turned off (false) or turned on (true). */
+        onOff: Attribute(0, TlvBoolean, { default: false }), /* reportable: true, scene:true */
+        // The following attributes are only needed for "Level Control for Lighting" support
+        /** Used to remember if a state is already storednin an old scene to not store one again when sending another Off command */
+        //globalSceneControl: OptionalAttribute(0x4000,  TlvBoolean, { default: true }),
+        /**
+         * Specifies the length of time (in 1/10ths second) that the ‘On’ state SHALL be maintained before
+         * automatically transitioning to the ‘Off’ state when using the OnWithTimedOff command.
+         */
+        //onTime: OptionalWritableAttribute(0x4001, TlvNullable(TlvUInt16)), { default: 0 }), /* unit: 1/10s */
+        /**
+         * Specifies the length of time (in 1/10ths second) that the ‘Off’ state SHALL be guarded to prevent
+         * another OnWithTimedOff command turning the server back to its ‘On’ state
+         */
+        //offWaitTime: OptionalWritableAttribute(0x4002, TlvNullable(TlvUInt16), { default: 0 }), /* unit: 1/10s */
+        /** Defines the desired startup behavior of a device when it is supplied with power. */
+        //startUpOnOff: OptionalWritableAttribute(0x4003, TlvNullable(TlvEnum<StartUpOnOff>()), { writeAcl: AccessLevel.Manage }),
+    },
+    /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7 */
+    commands: {
+        /**
+         * On receipt of this command, a device SHALL enter its ‘Off’ state. This state is device dependent, but it is
+         * recommended that it is used for power off or similar functions. On receipt of the Off command, the OnTime
+         * attribute SHALL be set to 0.
+         */
+        off: Command(0, TlvNoArguments, 0, TlvNoResponse),
+        /**
+         * On receipt of this command, a device SHALL enter its ‘On’ state. This state is device dependent, but it is
+         * recommended that it is used for power on or similar functions. On receipt of the On command, if the value
+         * of the OnTime attribute is equal to 0, the device SHALL set the OffWaitTime attribute to 0.
+         */
+        on: Command(1, TlvNoArguments, 1, TlvNoResponse),
+        /**
+         * On receipt of this command, if a device is in its ‘Off’ state it SHALL enter its ‘On’ state. Otherwise,
+         * if it is in its ‘On’ state it SHALL enter its ‘Off’ state. On receipt of the Toggle command, if the value
+         * of the OnOff attribute is equal to FALSE and if the value of the OnTime attribute is equal to 0, the device
+         * SHALL set the OffWaitTime attribute to 0. If the value of the OnOff attribute is equal to TRUE, the OnTime
+         * attribute SHALL be set to 0.
+         */
+        toggle: Command(2, TlvNoArguments, 2, TlvNoResponse),
+        // The following attributes are only needed for "Level Control for Lighting" support
+        // So we declare them option for now!
+        // TODO: Split these out into a separate Cluster Spec that adds "Level Control for Lighting" support
+        /**
+         * The OffWithEffect command allows devices to be turned off using enhanced ways of fading.
+         */
+        //offWithEffect: OptionalCommand(0x40, OffWithEffectRequestT, 0x40, NoResponseT),
+        /**
+         * The OnWithRecallGlobalScene command allows the recall of the settings when the device was turned off.
+         */
+        //onWithRecallGlobalScene: OptionalCommand(0x41, NoArgumentsT, 0x41, NoResponseT),
+        /**
+         * The OnWithTimedOff command allows devices to be turned on for a specific duration with a guarded off
+         * duration so that SHOULD the device be subsequently switched off, further OnWithTimedOff commands, received
+         * during this time, are prevented from turning the devices back on.
+         */
+        //onWithTimedOff: OptionalCommand(0x42, OnWithTimedOffRequestT, 0x42, NoResponseT),
+    },
+});

package/dist/es/cluster/OperationalCredentialsCluster.js

@@ -0,0 +1,202 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { TlvVendorId } from "../common/VendorId.js";
+import { TlvNodeId } from "../common/NodeId.js";
+import { TlvSubjectId } from "../common/SubjectId.js";
+import { TlvFabricId } from "../common/FabricId.js";
+import { TlvFabricIndex } from "../common/FabricIndex.js";
+import { Attribute, Cluster, Command, TlvNoResponse } from "./Cluster.js";
+import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+import { TlvByteString, TlvString, TlvString32max } from "../tlv/TlvString.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+import { TlvBoolean } from "../tlv/TlvBoolean.js";
+import { TlvEnum, TlvUInt32, TlvUInt8 } from "../tlv/TlvNumber.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.1 */
+export const RESP_MAX = 900;
+/**
+ * Encodes a Fabric Reference for a fabric within which a given Node is currently commissioned.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17.5.3
+ */
+const TlvFabricDescriptor = TlvObject({
+    /** Contains the public key for the trusted root that scopes the fabric referenced by FabricIndex and its associated operational credential. */
+    rootPublicKey: TlvField(1, TlvByteString.bound({ length: 65 })),
+    /** Contains the value of AdminVendorID provided in the AddNOC command that led to the creation of this FabricDescriptorStruct. */
+    vendorId: TlvField(2, TlvVendorId),
+    /** Contains the FabricID allocated to the fabric referenced by FabricIndex. */
+    fabricID: TlvField(3, TlvFabricId),
+    /** Contain the NodeID in use within the fabric referenced by FabricIndex. */
+    nodeID: TlvField(4, TlvNodeId),
+    /** Contains a commissioner-set label for the fabric referenced by FabricIndex. */
+    label: TlvField(5, TlvString.bound({ maxLength: 32 })), /* default: "" */
+});
+/**
+ * Encodes a fabric sensitive NOC chain, underpinning a commissioned Operational Identity for a given Node.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17.5.2
+ */
+const TlvNoc = TlvObject({
+    /** Contains the NOC for the struct’s associated fabric. */
+    noc: TlvField(1, TlvByteString.bound({ maxLength: 400 })),
+    /** Contain the ICAC or the struct’s associated fabric. */
+    icac: TlvField(2, TlvNullable(TlvByteString.bound({ maxLength: 400 }))), /* default(not present): null */
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.1 */
+const TlvAttestationRequest = TlvObject({
+    /** Contains the attestation nonce to be used in the computation of the Attestation Information. */
+    attestationNonce: TlvField(0, TlvByteString.bound({ length: 32 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.2 */
+const TlvAttestationResponse = TlvObject({
+    /** Contains the octet string of the serialized attestation_elements_message. */
+    elements: TlvField(0, TlvByteString.bound({ maxLength: RESP_MAX })),
+    /** Contain the octet string of the necessary attestation_signature. */
+    signature: TlvField(1, TlvByteString.bound({ length: 64 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.5 */
+const TlvCertSigningRequestRequest = TlvObject({
+    /** Contains the CSRNonce to be used in the computation of the NOCSR information. */
+    certSigningRequestNonce: TlvField(0, TlvByteString.bound({ length: 32 })),
+    /**
+     * If set to true, the internal state of the CSR associated keypair SHALL be tagged as being for
+     * a subsequent UpdateNOC, otherwise the internal state of the CSR SHALL be tagged as being for a
+     * subsequent AddNOC
+     * */
+    isForUpdateNOC: TlvOptionalField(1, TlvBoolean), /* default: false */
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.6 */
+const TlvCertSigningRequestResponse = TlvObject({
+    /** Contains the octet string of the serialized nocsr_elements_message. */
+    elements: TlvField(0, TlvByteString.bound({ maxLength: RESP_MAX })),
+    /** Contain the octet string of the necessary attestation_signature. */
+    signature: TlvField(1, TlvByteString.bound({ length: 64 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.3 */
+const TlvCertChainRequest = TlvObject({
+    /** Contains the type of certificate to be requested. */
+    type: TlvField(0, TlvEnum()),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.4 */
+const TlvCertChainResponse = TlvObject({
+    /** Contains the octet string of the requested certificate. */
+    certificate: TlvField(0, TlvByteString.bound({ maxLength: 600 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.8 */
+const TlvAddNocRequest = TlvObject({
+    /** Contains the Node Operational Certificate (NOC) to be added. */
+    operationalCert: TlvField(0, TlvByteString.bound({ maxLength: 400 })),
+    /** Contains the Intermediate CA Certificate (ICAC). */
+    intermediateCaCert: TlvOptionalField(1, TlvByteString.bound({ maxLength: 400 })),
+    /** Contains the value of the Epoch Key for the Identity Protection Key (IPK) to set for the Fabric which is to be added. */
+    identityProtectionKey: TlvField(2, TlvByteString.bound({ length: 16 })),
+    /**
+     * Used to atomically add an Access Control Entry enabling that Subject to subsequently administer
+     * the Node whose operational identity is being added by this command.
+     */
+    caseAdminNode: TlvField(3, TlvSubjectId),
+    /** Contains the Vendor ID of the entity issuing the AddNOC command. */
+    adminVendorId: TlvField(4, TlvVendorId),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.9 */
+const TlvUpdateNocRequest = TlvObject({
+    /** Contains the Node Operational Certificate (NOC). */
+    operationalCert: TlvField(0, TlvByteString.bound({ maxLength: 400 })),
+    /** Contains the Intermediate CA Certificate (ICAC). */
+    intermediateCaCert: TlvOptionalField(1, TlvByteString.bound({ maxLength: 400 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.13 */
+const TlvAddTrustedRootCertificateRequest = TlvObject({
+    /** Contains the Trusted Root Certificate (TRC) to be added. */
+    certificate: TlvField(0, TlvByteString.bound({ maxLength: 400 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.10 */
+const TlvOperationalCertificateStatusResponse = TlvObject({
+    /** Contains a NOCStatus value representing the status of an operation involving a NOC. */
+    status: TlvField(0, TlvEnum()),
+    /** When action was successful, contains the Fabric Index of the Fabric last added, removed or updated. */
+    fabricIndex: TlvOptionalField(1, TlvFabricIndex),
+    /** Optionally contains debugging textual information from the cluster implementation and should be visible in logs, not User UI */
+    debugText: TlvOptionalField(2, TlvString.bound({ maxLength: 128 })),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.4 */
+export const TlvAttestation = TlvObject({
+    declaration: TlvField(1, TlvByteString),
+    attestationNonce: TlvField(2, TlvByteString.bound({ length: 32 })),
+    timestamp: TlvField(3, TlvUInt32),
+    firmwareInfo: TlvOptionalField(4, TlvByteString),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.6 */
+export const TlvCertSigningRequest = TlvObject({
+    certSigningRequest: TlvField(1, TlvByteString),
+    certSigningRequestNonce: TlvField(2, TlvByteString.bound({ length: 32 })),
+    vendorReserved1: TlvOptionalField(3, TlvByteString),
+    vendorReserved2: TlvOptionalField(4, TlvByteString),
+    vendorReserved3: TlvOptionalField(5, TlvByteString),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.11 */
+const TlvUpdateFabricLabelRequest = TlvObject({
+    /** Contains the label to set for the fabric associated with the current secure session. */
+    label: TlvField(0, TlvString32max),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.7.12 */
+const TlvRemoveFabricRequest = TlvObject({
+    /** Contains the Fabric Index reference associated with the Fabric which is to be removed from the device. */
+    fabricIndex: TlvField(0, TlvFabricIndex),
+});
+/**
+ * This cluster is used to add or remove Operational Credentials on a Commissionee or Node, as well as manage the
+ * associated Fabrics.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17
+ */
+export const OperationalCredentialsCluster = Cluster({
+    id: 0x3e,
+    name: "Operational Credentials",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.17.6 */
+    attributes: {
+        /** Contains all NOCs applicable to this Node. */
+        nocs: Attribute(0, TlvArray(TlvNoc), { readAcl: 2 /* AccessLevel.Administer */ }),
+        /** Describes all fabrics to which this Node is commissioned. */
+        fabrics: Attribute(1, TlvArray(TlvFabricDescriptor)),
+        /** Contains the number of Fabrics that are supported by the device. */
+        supportedFabrics: Attribute(2, TlvUInt8.bound({ min: 5, max: 254 })),
+        /** Contains the number of Fabrics to which the device is currently commissioned. */
+        commissionedFabrics: Attribute(3, TlvUInt8),
+        /** Contains a read-only list of Trusted Root CA Certificates installed on the Node. */
+        trustedRootCertificates: Attribute(4, TlvArray(TlvByteString, { maxLength: 400 })),
+        /** Contain accessing fabric index. */
+        currentFabricIndex: Attribute(5, TlvUInt8),
+    },
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.17.7 */
+    commands: {
+        /** Sender is requesting attestation information from the receiver. */
+        requestAttestation: Command(0, TlvAttestationRequest, 1, TlvAttestationResponse),
+        /** Sender is requesting a device attestation certificate from the receiver. */
+        requestCertChain: Command(2, TlvCertChainRequest, 3, TlvCertChainResponse),
+        /** Sender is requesting a certificate signing request (CSR) from the receiver. */
+        requestCertSigning: Command(4, TlvCertSigningRequestRequest, 5, TlvCertSigningRequestResponse),
+        /** Sender is requesting to add the new node operational certificates. */
+        addOperationalCert: Command(6, TlvAddNocRequest, 8, TlvOperationalCertificateStatusResponse),
+        /** Sender is requesting to update the node operational certificates. */
+        updateOperationalCert: Command(7, TlvUpdateNocRequest, 8, TlvOperationalCertificateStatusResponse),
+        /**
+         * This command SHALL be used by an Administrative Node to set the user-visible Label field for a given
+         * Fabric, as reflected by entries in the Fabrics attribute.
+         */
+        updateFabricLabel: Command(9, TlvUpdateFabricLabelRequest, 8, TlvOperationalCertificateStatusResponse),
+        /**
+         * This command is used by Administrative Nodes to remove a given fabric index and delete all associated
+         * fabric-scoped data.
+         */
+        removeFabric: Command(10, TlvRemoveFabricRequest, 8, TlvOperationalCertificateStatusResponse),
+        /**
+         * This command SHALL add a Trusted Root CA Certificate, provided as its CHIP Certificate representation.
+         */
+        addRootCert: Command(11, TlvAddTrustedRootCertificateRequest, 11, TlvNoResponse),
+    },
+});

package/dist/es/cluster/ScenesCluster.js

@@ -0,0 +1,233 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, OptionalAttribute, Cluster, Command, OptionalCommand, TlvNoResponse } from "./Cluster.js";
+import { TlvGroupId } from "../common/GroupId.js";
+import { TlvClusterId } from "../common/ClusterId.js";
+import { TlvNodeId } from "../common/NodeId.js";
+import { TlvAttributeId } from "../common/AttributeId.js";
+import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvAny } from "../tlv/TlvAny.js";
+import { TlvBitmap, TlvEnum, TlvUInt16, TlvUInt8 } from "../tlv/TlvNumber.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { TlvBoolean } from "../tlv/TlvBoolean.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.6.1 */
+const TlvAttributeValuePair = TlvObject({
+    /**
+     * This field SHALL be present or not present, for all instances in the Scenes cluster. If this field is
+     * not present, then the data type of AttributeValue SHALL be determined by the order and data type defined
+     * in the cluster specification. Otherwise the data type of AttributeValue SHALL be the data type of the
+     * attribute indicated by AttributeID.
+     */
+    attributeId: TlvField(0, TlvAttributeId),
+    /** This is the attribute value as part of an extension field set. */
+    attributeValue: TlvField(1, TlvArray(TlvAny)),
+});
+/**
+ * This data type indicates for a given cluster a set of attributes and their values. Only attributes which
+ * have the "S" designation in the Quality column of the cluster specification SHALL be used in the
+ * AttributeValueList field.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.6.2
+ */
+export const TlvExtensionFieldSet = TlvObject({
+    clusterId: TlvField(0, TlvClusterId),
+    attributeValueList: TlvField(1, TlvArray(TlvAttributeValuePair)),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.2 and 1.4.9.9 */
+const TlvAddSceneRequest = TlvObject({
+    groupId: TlvField(0, TlvGroupId),
+    sceneId: TlvField(1, TlvUInt8),
+    transitionTime: TlvField(2, TlvUInt16),
+    sceneName: TlvField(3, TlvString.bound({ maxLength: 16 })),
+    extensionFieldSets: TlvField(4, TlvArray(TlvExtensionFieldSet)),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.3 and § 1.4.9.10 */
+const TlvViewSceneRequest = TlvObject({
+    groupId: TlvField(0, TlvGroupId),
+    sceneId: TlvField(1, TlvUInt8),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.4 */
+const TlvRemoveSceneRequest = TlvObject({
+    groupId: TlvField(0, TlvGroupId),
+    sceneId: TlvField(1, TlvUInt8),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.5 */
+const TlvRemoveAllScenesRequest = TlvObject({
+    groupId: TlvField(0, TlvGroupId),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.6 */
+const TlvStoreSceneRequest = TlvObject({
+    groupId: TlvField(0, TlvGroupId),
+    sceneId: TlvField(1, TlvUInt8),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.7 */
+const TlvRecallSceneRequest = TlvObject({
+    groupId: TlvField(0, TlvGroupId),
+    sceneId: TlvField(1, TlvUInt8),
+    transitionTime: TlvOptionalField(2, TlvNullable(TlvUInt16)),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.8 */
+const TlvGetSceneMembershipRequest = TlvObject({
+    groupId: TlvField(0, TlvGroupId),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.11.1 */
+const TlvScenesCopyMode = TlvBitmap(TlvUInt8, {
+    copyAllScenes: BitFlag(0),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.11 */
+const TlvCopySceneRequest = TlvObject({
+    /** Contains information of how the scene copy is to proceed. Bitmap: see 1.4.9.11.1 */
+    mode: TlvField(0, TlvScenesCopyMode),
+    /** Specifies the identifier of the group from which the scene is to be copied. */
+    groupIdFrom: TlvField(1, TlvGroupId),
+    /** Specifies the identifier of the scene from which the scene is to be copied. */
+    sceneIdFrom: TlvField(2, TlvUInt8),
+    /** Specifies the identifier of the group to which the scene is to be copied. */
+    TlvGroupIdo: TlvField(3, TlvGroupId),
+    /** Specifies the identifier of the scene to which the scene is to be copied. */
+    sceneIdTo: TlvField(4, TlvUInt8),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.12 and § 1.4.9.18 */
+const TlvAddSceneResponse = TlvObject({
+    status: TlvField(0, TlvEnum()),
+    groupId: TlvField(1, TlvGroupId),
+    sceneId: TlvField(2, TlvUInt8),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.13 and § 1.4.9.19 */
+const TlvViewSceneResponse = TlvObject({
+    status: TlvField(0, TlvEnum()),
+    groupId: TlvField(1, TlvGroupId),
+    sceneId: TlvField(2, TlvUInt8),
+    transitionTime: TlvOptionalField(3, TlvUInt16),
+    sceneName: TlvOptionalField(4, TlvString.bound({ maxLength: 16 })),
+    extensionFieldSets: TlvOptionalField(5, TlvArray(TlvExtensionFieldSet)),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.14 */
+const TlvRemoveSceneResponse = TlvObject({
+    status: TlvField(0, TlvEnum()),
+    groupId: TlvField(1, TlvGroupId),
+    sceneId: TlvField(2, TlvUInt8),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.15 */
+const TlvRemoveAllScenesResponse = TlvObject({
+    status: TlvField(0, TlvEnum()),
+    groupId: TlvField(1, TlvGroupId),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.16 */
+const TlvStoreSceneResponse = TlvObject({
+    status: TlvField(0, TlvEnum()),
+    groupId: TlvField(1, TlvGroupId),
+    sceneId: TlvField(2, TlvUInt8),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.17 */
+const TlvGetSceneMembershipResponse = TlvObject({
+    status: TlvField(0, TlvEnum()),
+    capacity: TlvField(1, TlvNullable(TlvUInt8)),
+    groupId: TlvField(2, TlvGroupId),
+    sceneList: TlvOptionalField(3, TlvArray(TlvUInt8)),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9.20 */
+const TlvCopySceneResponse = TlvObject({
+    /** Contains the status of the copy scene attempt. */
+    status: TlvField(0, TlvEnum()),
+    /** Specifies the identifier of the group from which the scene was copied. */
+    groupIdFrom: TlvField(1, TlvGroupId),
+    /** Specifies the identifier of the scene from which the scene was copied. */
+    sceneIdFrom: TlvField(2, TlvUInt8),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.7.5 */
+const TlvNameSupportBitmap = TlvBitmap(TlvUInt8, {
+    sceneNames: BitFlag(7),
+});
+/**
+ * The Scenes cluster provides attributes and commands for setting up and recalling scenes.
+ * Each scene corresponds to a set of stored values of specified attributes for one or more
+ * clusters on the same end point as the Scenes cluster.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4
+ */
+export const ScenesCluster = Cluster({
+    id: 0x05,
+    name: "Scenes",
+    revision: 4,
+    features: {
+        /** The ability to store a name for a scene. */
+        sceneNames: BitFlag(0),
+    },
+    /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.7 */
+    attributes: {
+        /** Specifies the number of scenes currently in the server’s Scene Table. */
+        sceneCount: Attribute(0, TlvUInt8, { default: 0 }),
+        /** Holds the scene identifier of the scene last invoked. */
+        currentScene: Attribute(1, TlvUInt8, { default: 0 }),
+        /** Holds the group identifier of the scene last invoked, or 0 if the scene last invoked is not associated with a group. */
+        currentGroup: Attribute(2, TlvUInt16.bound({ min: 0, max: 0xfff7 }), { default: 0 }),
+        /** Indicates whether the state of the server corresponds to that associated with the CurrentScene and CurrentGroup attributes. */
+        sceneValid: Attribute(3, TlvBoolean, { default: false }),
+        /**
+         * This attribute provides legacy, read-only access to whether the Scene
+         * Names feature is supported. The most significant bit, bit 7, SHALL be
+         * equal to bit 0 of the FeatureMap attribute. All other bits SHALL be 0.
+         *
+         * TODO because we (will) support group names we need to set bit 7 to 1, rest is 0
+         */
+        nameSupport: Attribute(4, TlvNameSupportBitmap, { default: { sceneNames: true } }),
+        /** Holds the Node ID (the IEEE address in case of Zigbee) of the node that last configured the Scene Table. */
+        lastConfiguredBy: OptionalAttribute(5, TlvNullable(TlvNodeId)),
+    },
+    /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.4.9 */
+    commands: {
+        /**
+         * Add a scene to the scene table.
+         * Extension field sets are supported, and are inputed as
+         * '{"ClusterID": VALUE, "AttributeValueList":[{"AttributeId": VALUE, "AttributeValue": VALUE}]}'
+         */
+        addScene: Command(0, TlvAddSceneRequest, 0, TlvAddSceneResponse),
+        /**
+         * Retrieves the requested scene entry from its Scene table.
+         */
+        viewScene: Command(1, TlvViewSceneRequest, 1, TlvViewSceneResponse),
+        /**
+         * Removes the requested scene entry, corresponding to the value of the GroupID field, from its Scene Table
+         */
+        removeScene: Command(2, TlvRemoveSceneRequest, 2, TlvRemoveSceneResponse),
+        /**
+         * Remove all scenes, corresponding to the value of the GroupID field, from its Scene Table
+         */
+        removeAllScenes: Command(3, TlvRemoveAllScenesRequest, 3, TlvRemoveAllScenesResponse),
+        /**
+         * Adds the scene entry into its Scene Table along with all extension field sets corresponding to the current
+         * state of other clusters on the same endpoint
+         */
+        storeScenes: Command(4, TlvStoreSceneRequest, 4, TlvStoreSceneResponse),
+        /**
+         * Set the attributes and corresponding state for each other cluster implemented on the endpoint accordingly to
+         * the requested scene entry in the Scene Table
+         */
+        recallScene: Command(5, TlvRecallSceneRequest, 5, TlvNoResponse),
+        /**
+         * Get an unused scene identifier when no commissioning tool is in the network, or for a commissioning tool to
+         * get the used scene identifiers within a certain group
+         */
+        getSceneMembership: Command(6, TlvGetSceneMembershipRequest, 6, TlvGetSceneMembershipResponse),
+        /**
+         * Allows a scene to be added using a finer scene transition time than the AddScene command.
+         */
+        enhancedAddScene: OptionalCommand(0x40, TlvAddSceneRequest, 0x40, TlvAddSceneResponse),
+        /**
+         * Allows a scene to be retrieved using a finer scene transition time than the ViewScene command
+         */
+        enhancedViewScene: OptionalCommand(0x41, TlvViewSceneRequest, 0x41, TlvViewSceneResponse),
+        /**
+         * Allows a client to efficiently copy scenes from one group/scene identifier pair to another group/scene
+         * identifier pair.
+         */
+        copyScene: OptionalCommand(0x42, TlvCopySceneRequest, 0x42, TlvCopySceneResponse),
+    },
+});

package/dist/es/common/AttributeId.js

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { TlvUInt32 } from "../tlv/TlvNumber.js";
+import { TlvWrapper } from "../tlv/TlvWrapper.js";
+/**
+ * An Attribute ID is a 32 bit number and indicates an attribute defined in a cluster specification.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 7.18.2.15
+ */
+export class AttributeId {
+    constructor(id) {
+        this.id = id;
+    }
+}
+/** Tlv schema for an Attribute Id. */
+export const TlvAttributeId = new TlvWrapper(TlvUInt32, attributeId => attributeId.id, value => new AttributeId(value));