@project-chip/matter.js 0.2.1 → 0.4.0

package/dist/es/device/Aggregator.js

@@ -0,0 +1,90 @@
+import { DeviceTypes } from "./DeviceTypes.js";
+import { ComposedDevice } from "./ComposedDevice.js";
+import { BridgedDeviceBasicInformationCluster } from "../cluster/BridgedDeviceBasicInformationCluster.js";
+import { ClusterServer } from "../protocol/interaction/InteractionServer.js";
+/**
+ * An Aggregator is a special endpoint that exposes multiple devices as a "bridge" into the matter ecosystem.
+ * Use the `addBridgedDevice` or `addBridgedDeviceWithPowerSourceInfo` method to add the devices and provide the details
+ * for the "Bridged Device Basic Information Cluster". The BridgedDeviceBasicInformationCluster is then added automatically.
+ * If Power source information should be provided you need to also add the needed clusters (PowerSourceConfigurationCluster
+ * and PowerSourceCluster) to the device!
+ */
+export class Aggregator extends ComposedDevice {
+    /**
+     * Create a new Aggregator instance and optionally directly add devices to it. If this is used the devices must
+     * already have the BridgedDeviceBasicInformationCluster added!
+     * @param devices Array of devices to add
+     * @param endpointId Optional endpoint ID to use. If not provided will automatically be assigned
+     */
+    constructor(devices = [], endpointId) {
+        // Aggregator is a Composed device with an DeviceTypes.AGGREGATOR device type
+        super([DeviceTypes.AGGREGATOR], [], endpointId);
+        devices.forEach(device => this.addBridgedDevice(device));
+    }
+    /**
+     * @deprecated Use addBridgedDevice or addBridgedDeviceWithPowerSourceInfo instead
+     */
+    addDevice() {
+        throw new Error("Aggregator does not support addDevice. Use addBridgedDevice instead.");
+    }
+    /**
+     * Add a bridged device to the Aggregator. If provided the bridgedBasicInformation is used to automatically add the
+     * BridgedDeviceBasicInformationCluster to the device. If not provided the BridgedDeviceBasicInformationCluster must
+     * be already existing on the device!
+     *
+     * @param device Device instance to add
+     * @param bridgedBasicInformation Optional BridgedDeviceBasicInformationCluster attribute values to
+     */
+    addBridgedDevice(device, bridgedBasicInformation) {
+        // Add DeviceTypes.BRIDGED_DEVICE device type to the device exposed via Aggregator
+        const deviceTypes = device.getDeviceTypes();
+        if (!deviceTypes.includes(DeviceTypes.BRIDGED_NODE)) {
+            deviceTypes.push(DeviceTypes.BRIDGED_NODE);
+            device.setDeviceTypes(deviceTypes);
+        }
+        if (bridgedBasicInformation !== undefined) {
+            device.addClusterServer(ClusterServer(BridgedDeviceBasicInformationCluster, bridgedBasicInformation, {}));
+        }
+        else {
+            if (!device.hasClusterServer(BridgedDeviceBasicInformationCluster)) {
+                throw new Error("BridgedDeviceBasicInformationCluster is required for bridged devices. Please add yourself or provide as second parameter");
+            }
+        }
+        super.addDevice(device);
+    }
+    /**
+     * Add a bridged device with power source information to the Aggregator. If provided the bridgedBasicInformation is
+     * used to automatically add the BridgedDeviceBasicInformationCluster to the device. If not provided the
+     * BridgedDeviceBasicInformationCluster must be already existing on the device!
+     * The required clusters PowerSourceConfigurationCluster and PowerSourceCluster needs to be added manually to the device!
+     *
+     * @param device Device instance to add
+     * @param bridgedBasicInformation Optional BridgedDeviceBasicInformationCluster attribute values to
+     */
+    addBridgedDeviceWithPowerSourceInfo(device, bridgedBasicInformation) {
+        // Add DeviceTypes.BRIDGED_DEVICE_WITH_POWER_SOURCE_INFORMATION device type to the device exposed via Aggregator
+        const deviceTypes = device.getDeviceTypes();
+        if (!deviceTypes.includes(DeviceTypes.BRIDGED_DEVICE_WITH_POWER_SOURCE_INFORMATION)) {
+            deviceTypes.push(DeviceTypes.BRIDGED_DEVICE_WITH_POWER_SOURCE_INFORMATION);
+            device.setDeviceTypes(deviceTypes);
+        }
+        if (bridgedBasicInformation !== undefined) {
+            device.addClusterServer(ClusterServer(BridgedDeviceBasicInformationCluster, bridgedBasicInformation, {}));
+        }
+        else {
+            if (!device.hasClusterServer(BridgedDeviceBasicInformationCluster)) {
+                throw new Error("BridgedDeviceBasicInformationCluster is required for bridged devices. Please add yourself or provide as second parameter");
+            }
+        }
+        super.addDevice(device);
+    }
+    /**
+     * Returns all bridged devices added to the Aggregator
+     *
+     * @returns Array of bridged devices
+     */
+    getBridgedDevices() {
+        return super.getDevices();
+    }
+}
+//# sourceMappingURL=Aggregator.js.map

package/dist/es/device/Aggregator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Aggregator.js","sourceRoot":"","sources":["../../../src/device/Aggregator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,oCAAoC,EAAE,MAAM,oDAAoD,CAAC;AAC1G,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAE7E;;;;;;GAMG;AACH,MAAM,OAAO,UAAW,SAAQ,cAAc;IAC1C;;;;;OAKG;IACH,YAAY,UAAoB,EAAE,EAAE,UAAmB;QACnD,6EAA6E;QAC7E,KAAK,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;QAChD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACM,SAAS;QACd,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,MAAc,EAAE,uBAAwG;QACrI,kFAAkF;QAClF,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;QAC5C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE;YACjD,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;SACtC;QACD,IAAI,uBAAuB,KAAK,SAAS,EAAE;YACvC,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,oCAAoC,EAAE,uBAAuB,EAAE,EAAE,CAAC,CAAC,CAAC;SAC7G;aAAM;YACH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oCAAoC,CAAC,EAAE;gBAChE,MAAM,IAAI,KAAK,CAAC,0HAA0H,CAAC,CAAC;aAC/I;SACJ;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;OAQG;IACH,mCAAmC,CAAC,MAAc,EAAE,uBAAwG;QACxJ,gHAAgH;QAChH,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;QAC5C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,4CAA4C,CAAC,EAAE;YACjF,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAAC;YAC3E,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;SACtC;QACD,IAAI,uBAAuB,KAAK,SAAS,EAAE;YACvC,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,oCAAoC,EAAE,uBAAuB,EAAE,EAAE,CAAC,CAAC,CAAC;SAC7G;aAAM;YACH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oCAAoC,CAAC,EAAE;gBAChE,MAAM,IAAI,KAAK,CAAC,0HAA0H,CAAC,CAAC;aAC/I;SACJ;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACb,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC;CACJ"}

package/dist/es/device/ComposedDevice.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright 2022 The matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Endpoint } from "./Endpoint.js";
+import { Device } from "./Device.js";
+import { DeviceTypeDefinition } from "./DeviceTypes.js";
+import { AtLeastOne } from "../util/Array.js";
+/**
+ * A ComposedDevice is a special endpoint that allows to combine multiple sub devices and expose this as one device
+ * (e.g. a fan and a light).
+ */
+export declare class ComposedDevice extends Endpoint {
+    /**
+     * Creates a new ComposedDevice.
+     *
+     * @param deviceTypes Array with Device types how this device should be presented to the Matter ecosystem.
+     * @param devices Array with devices that should be combined into one device that are directly added.
+     * @param endpointId Optional endpoint ID to use. If not provided will automatically be assigned
+     */
+    constructor(deviceTypes: AtLeastOne<DeviceTypeDefinition>, devices?: Device[], endpointId?: number);
+    /**
+     * Add a sub-device to the composed device.
+     * @param device Device instance to add
+     */
+    addDevice(device: Device): void;
+    /**
+     * Get all sub-devices of the composed device.
+     *
+     * @returns Array with all sub-devices
+     */
+    getDevices(): Endpoint[];
+    /**
+     * Verify that the required clusters exists on the device.
+     */
+    protected verifyRequiredClusters(): void;
+}
+//# sourceMappingURL=ComposedDevice.d.ts.map

package/dist/es/device/ComposedDevice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComposedDevice.d.ts","sourceRoot":"","sources":["../../../src/device/ComposedDevice.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;;GAGG;AACH,qBAAa,cAAe,SAAQ,QAAQ;IACxC;;;;;;OAMG;gBAEC,WAAW,EAAE,UAAU,CAAC,oBAAoB,CAAC,EAC7C,OAAO,GAAE,MAAM,EAAO,EACtB,UAAU,CAAC,EAAE,MAAM;IAMvB;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM;IAIxB;;;;OAIG;IACH,UAAU;IAIV;;OAEG;cACgB,sBAAsB;CAM5C"}

package/dist/es/device/ComposedDevice.js

@@ -0,0 +1,48 @@
+/**
+ * @license
+ * Copyright 2022 The matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Endpoint } from "./Endpoint.js";
+/**
+ * A ComposedDevice is a special endpoint that allows to combine multiple sub devices and expose this as one device
+ * (e.g. a fan and a light).
+ */
+export class ComposedDevice extends Endpoint {
+    /**
+     * Creates a new ComposedDevice.
+     *
+     * @param deviceTypes Array with Device types how this device should be presented to the Matter ecosystem.
+     * @param devices Array with devices that should be combined into one device that are directly added.
+     * @param endpointId Optional endpoint ID to use. If not provided will automatically be assigned
+     */
+    constructor(deviceTypes, devices = [], endpointId) {
+        super(deviceTypes, [], endpointId);
+        devices.forEach(device => this.addDevice(device));
+    }
+    /**
+     * Add a sub-device to the composed device.
+     * @param device Device instance to add
+     */
+    addDevice(device) {
+        this.addChildEndpoint(device);
+    }
+    /**
+     * Get all sub-devices of the composed device.
+     *
+     * @returns Array with all sub-devices
+     */
+    getDevices() {
+        return this.getChildEndpoints();
+    }
+    /**
+     * Verify that the required clusters exists on the device.
+     */
+    verifyRequiredClusters() {
+        // TODO find out what to really check here and how ... most likely we need to verify that the added sub devices
+        //      somehow match with the device types of the composed device?!
+        //      For now we do not check this
+        return;
+    }
+}
+//# sourceMappingURL=ComposedDevice.js.map

package/dist/es/device/ComposedDevice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComposedDevice.js","sourceRoot":"","sources":["../../../src/device/ComposedDevice.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAKzC;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,QAAQ;IACxC;;;;;;OAMG;IACH,YACI,WAA6C,EAC7C,UAAoB,EAAE,EACtB,UAAmB;QAEnB,KAAK,CAAC,WAAW,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;QACnC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,MAAc;QACpB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,UAAU;QACN,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;IACpC,CAAC;IAED;;OAEG;IACgB,sBAAsB;QACrC,+GAA+G;QAC/G,oEAAoE;QACpE,oCAAoC;QACpC,OAAO;IACX,CAAC;CACJ"}

package/dist/es/device/Device.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @license
+ * Copyright 2022 The matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { DeviceTypeDefinition } from "./DeviceTypes.js";
+import { Endpoint } from "./Endpoint.js";
+import { AtLeastOne } from "../util/Array.js";
+import { HandlerFunction } from "../util/NamedHandler.js";
+import { ClusterClientObj } from "../cluster/client/ClusterClient.js";
+import { ClusterServerObj } from "../cluster/server/ClusterServer.js";
+import { Attributes, Cluster, Commands, Events } from "../cluster/Cluster.js";
+import { BitSchema, TypeFromBitSchema } from "../schema/BitmapSchema.js";
+/**
+ * Temporary used device class for paired devices until we added a layer to choose the right specialized device class
+ * based on the device classes and features of the paired device
+ */
+export declare class PairedDevice extends Endpoint {
+    private declineAddingMoreClusters;
+    /**
+     * Create a new PairedDevice instance. All data are automatically parsed from the paired device!
+     *
+     * @param definition DeviceTypeDefinitions of the paired device as reported by the device
+     * @param clusters Clusters of the paired device as reported by the device
+     * @param endpointId Endpoint ID of the paired device as reported by the device
+     */
+    constructor(definition: AtLeastOne<DeviceTypeDefinition>, clusters: (ClusterServerObj<Attributes, Commands> | ClusterClientObj<Attributes, Commands>)[] | undefined, endpointId: number);
+    /**
+     * @deprecated PairedDevice does not support adding additional clusters
+     */
+    addClusterServer<A extends Attributes, C extends Commands>(cluster: ClusterServerObj<A, C>): void;
+    /**
+     * @deprecated PairedDevice does not support adding additional clusters
+     */
+    addClusterClient<A extends Attributes, C extends Commands>(cluster: ClusterClientObj<A, C>): void;
+}
+/**
+ * Root endpoint of a device. This is used internally and not needed to be instanced by the user.
+ */
+export declare class RootEndpoint extends Endpoint {
+    readonly deviceType: number;
+    /**
+     * Create a new RootEndpoint instance. This is automatically instanced by the CommissioningServer class.
+     */
+    constructor();
+}
+/**
+ * Base class for all devices. This class should be extended by all devices.
+ */
+export declare class Device extends Endpoint {
+    readonly deviceType: number;
+    private commandHandler;
+    /**
+     * Create a new Device instance.
+     *
+     * @param definition DeviceTypeDefinitions of the device
+     * @param clusters Optional Array of clusters to be added to the device directly
+     * @param endpointId Optional endpoint ID of the device. If not set, the device will be instanced as a root device
+     */
+    constructor(definition: DeviceTypeDefinition, clusters?: (ClusterServerObj<Attributes, Commands> | ClusterClientObj<Attributes, Commands>)[], endpointId?: number);
+    /**
+     * Method to add command handlers to the device.
+     * The base class do not expose any commands!
+     *
+     * @param command Command name to add a handler for
+     * @param handler Handler function to be executed when the command is received
+     */
+    addCommandHandler(command: never, handler: HandlerFunction): void;
+    /**
+     * Method to remove command handlers from the device.
+     * The base class do not expose any commands!
+     *
+     * @param command Command name to remove the handler from
+     * @param handler Handler function to be removed
+     */
+    removeCommandHandler(command: never, handler: HandlerFunction): void;
+    /**
+     * Execute a command handler. Should only be used internally, but can not be declared as protected officially
+     * because needed public for derived classes.
+     *
+     * @protected
+     * @param command Command name to execute the handler for
+     * @param args Arguments to be passed to the handler
+     */
+    protected _executeHandler(command: never, ...args: any[]): Promise<void>;
+    protected createOptionalClusterServer<F extends BitSchema, SF extends TypeFromBitSchema<F>, A extends Attributes, C extends Commands, E extends Events>(_cluster: Cluster<F, SF, A, C, E>): ClusterServerObj<A, C>;
+    protected createOptionalClusterClient<F extends BitSchema, SF extends TypeFromBitSchema<F>, A extends Attributes, C extends Commands, E extends Events>(_cluster: Cluster<F, SF, A, C, E>): ClusterClientObj<A, C>;
+    getClusterServer<F extends BitSchema, SF extends TypeFromBitSchema<F>, A extends Attributes, C extends Commands, E extends Events>(cluster: Cluster<F, SF, A, C, E>): ClusterServerObj<A, C> | undefined;
+    getClusterClient<F extends BitSchema, SF extends TypeFromBitSchema<F>, A extends Attributes, C extends Commands, E extends Events>(cluster: Cluster<F, SF, A, C, E>): ClusterClientObj<A, C> | undefined;
+}
+//# sourceMappingURL=Device.d.ts.map

package/dist/es/device/Device.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Device.d.ts","sourceRoot":"","sources":["../../../src/device/Device.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAiB,oBAAoB,EAAe,MAAM,kBAAkB,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAgB,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAIzE;;;GAGG;AACH,qBAAa,YAAa,SAAQ,QAAQ;IACtC,OAAO,CAAC,yBAAyB,CAAS;IAC1C;;;;;;OAMG;gBAEC,UAAU,EAAE,UAAU,CAAC,oBAAoB,CAAC,EAC5C,QAAQ,iGAA0F,EAClG,UAAU,EAAE,MAAM;IAMtB;;OAEG;IACM,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,QAAQ,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IAOnG;;OAEG;IACM,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,QAAQ,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;CAMtG;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,QAAQ;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B;;OAEG;;CAMN;AAMD;;GAEG;AACH,qBAAa,MAAO,SAAQ,QAAQ;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,cAAc,CAA2B;IAEjD;;;;;;OAMG;gBAEC,UAAU,EAAE,oBAAoB,EAChC,QAAQ,GAAE,CAAC,gBAAgB,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,gBAAgB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,EAAO,EAClG,UAAU,CAAC,EAAE,MAAM;IAkBvB;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe;IAI1D;;;;;;OAMG;IACH,oBAAoB,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe;IAI7D;;;;;;;OAOG;cACa,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAI9D,SAAS,CAAC,2BAA2B,CAAC,CAAC,SAAS,SAAS,EAAE,EAAE,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IAKlN,SAAS,CAAC,2BAA2B,CAAC,CAAC,SAAS,SAAS,EAAE,EAAE,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IAKzM,gBAAgB,CAAC,CAAC,SAAS,SAAS,EAAE,EAAE,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS;IAaxM,gBAAgB,CAAC,CAAC,SAAS,SAAS,EAAE,EAAE,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS;CAYpN"}

package/dist/es/device/Device.js

@@ -0,0 +1,161 @@
+/**
+ * @license
+ * Copyright 2022 The matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { DeviceClasses, DeviceTypes } from "./DeviceTypes.js";
+import { Endpoint } from "./Endpoint.js";
+import { NamedHandler } from "../util/NamedHandler.js";
+import { BindingCluster } from "../cluster/BindingCluster.js";
+import { ClusterServer } from "../protocol/interaction/InteractionServer.js";
+/**
+ * Temporary used device class for paired devices until we added a layer to choose the right specialized device class
+ * based on the device classes and features of the paired device
+ */
+export class PairedDevice extends Endpoint {
+    /**
+     * Create a new PairedDevice instance. All data are automatically parsed from the paired device!
+     *
+     * @param definition DeviceTypeDefinitions of the paired device as reported by the device
+     * @param clusters Clusters of the paired device as reported by the device
+     * @param endpointId Endpoint ID of the paired device as reported by the device
+     */
+    constructor(definition, clusters = [], endpointId) {
+        super(definition, clusters, endpointId);
+        this.declineAddingMoreClusters = false;
+        this.declineAddingMoreClusters = true;
+    }
+    /**
+     * @deprecated PairedDevice does not support adding additional clusters
+     */
+    addClusterServer(cluster) {
+        if (this.declineAddingMoreClusters) {
+            throw new Error("PairedDevice does not support adding additional clusters");
+        }
+        return super.addClusterServer(cluster);
+    }
+    /**
+     * @deprecated PairedDevice does not support adding additional clusters
+     */
+    addClusterClient(cluster) {
+        if (this.declineAddingMoreClusters) {
+            throw new Error("PairedDevice does not support adding additional clusters");
+        }
+        return super.addClusterClient(cluster);
+    }
+}
+/**
+ * Root endpoint of a device. This is used internally and not needed to be instanced by the user.
+ */
+export class RootEndpoint extends Endpoint {
+    /**
+     * Create a new RootEndpoint instance. This is automatically instanced by the CommissioningServer class.
+     */
+    constructor() {
+        super([DeviceTypes.ROOT], [], 0);
+        this.deviceType = DeviceTypes.ROOT.code;
+    }
+}
+// TODO Add checks that only allowed clusters are added
+// TODO add "get adds dummy instance" when optional and not existing
+// TODO add typing support to know which clusters are available based on required clusters from device type def to be used by getClusterServer/Client
+/**
+ * Base class for all devices. This class should be extended by all devices.
+ */
+export class Device extends Endpoint {
+    /**
+     * Create a new Device instance.
+     *
+     * @param definition DeviceTypeDefinitions of the device
+     * @param clusters Optional Array of clusters to be added to the device directly
+     * @param endpointId Optional endpoint ID of the device. If not set, the device will be instanced as a root device
+     */
+    constructor(definition, clusters = [], endpointId) {
+        if (definition.deviceClass === DeviceClasses.Node) {
+            throw new Error("MatterNode devices are not supported");
+        }
+        super([definition], clusters, endpointId);
+        this.commandHandler = new NamedHandler();
+        this.deviceType = definition.code;
+        if (definition.deviceClass === DeviceClasses.Simple || definition.deviceClass === DeviceClasses.Client) {
+            this.addClusterServer(ClusterServer(BindingCluster, {
+                bindingList: []
+            }, {}));
+        }
+    }
+    /**
+     * Method to add command handlers to the device.
+     * The base class do not expose any commands!
+     *
+     * @param command Command name to add a handler for
+     * @param handler Handler function to be executed when the command is received
+     */
+    addCommandHandler(command, handler) {
+        this.commandHandler.addHandler(command, handler);
+    }
+    /**
+     * Method to remove command handlers from the device.
+     * The base class do not expose any commands!
+     *
+     * @param command Command name to remove the handler from
+     * @param handler Handler function to be removed
+     */
+    removeCommandHandler(command, handler) {
+        this.commandHandler.removeHandler(command, handler);
+    }
+    /**
+     * Execute a command handler. Should only be used internally, but can not be declared as protected officially
+     * because needed public for derived classes.
+     *
+     * @protected
+     * @param command Command name to execute the handler for
+     * @param args Arguments to be passed to the handler
+     */
+    _executeHandler(command, ...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.commandHandler.executeHandler(command, ...args);
+        });
+    }
+    createOptionalClusterServer(_cluster) {
+        // TODO: Implement this in upper classes to add optional clusters on the fly
+        throw new Error("createOptionalClusterServer needs to be implemented by derived classes");
+    }
+    createOptionalClusterClient(_cluster) {
+        // TODO: Implement this in upper classes to add optional clusters on the fly
+        throw new Error("createOptionalClusterClient needs to be implemented by derived classes");
+    }
+    getClusterServer(cluster) {
+        const clusterServer = super.getClusterServer(cluster);
+        if (clusterServer !== undefined) {
+            return clusterServer;
+        }
+        for (const deviceType of this.deviceTypes) {
+            if (deviceType.optionalServerClusters.includes(cluster.id)) {
+                const clusterServer = this.createOptionalClusterServer(cluster);
+                this.addClusterServer(clusterServer);
+            }
+        }
+    }
+    getClusterClient(cluster) {
+        const clusterClient = super.getClusterClient(cluster);
+        if (clusterClient !== undefined) {
+            return clusterClient;
+        }
+        for (const deviceType of this.deviceTypes) {
+            if (deviceType.optionalClientClusters.includes(cluster.id)) {
+                const clusterClient = this.createOptionalClusterClient(cluster);
+                this.addClusterClient(clusterClient);
+            }
+        }
+    }
+}
+//# sourceMappingURL=Device.js.map

package/dist/es/device/Device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Device.js","sourceRoot":"","sources":["../../../src/device/Device.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;;;;;;;;;AAEH,OAAO,EAAE,aAAa,EAAwB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAmB,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAKxE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAE7E;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,QAAQ;IAEtC;;;;;;OAMG;IACH,YACI,UAA4C,EAC5C,WAAgG,EAAE,EAClG,UAAkB;QAElB,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAbpC,8BAAyB,GAAG,KAAK,CAAC;QActC,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAC1C,CAAC;IAED;;OAEG;IACM,gBAAgB,CAA2C,OAA+B;QAC/F,IAAI,IAAI,CAAC,yBAAyB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;SAC/E;QACD,OAAO,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACM,gBAAgB,CAA2C,OAA+B;QAC/F,IAAI,IAAI,CAAC,yBAAyB,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;SAC/E;QACD,OAAO,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,QAAQ;IAGtC;;OAEG;IACH;QAEI,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;IAC5C,CAAC;CACJ;AAED,uDAAuD;AACvD,oEAAoE;AACpE,qJAAqJ;AAErJ;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,QAAQ;IAIhC;;;;;;OAMG;IACH,YACI,UAAgC,EAChC,WAAgG,EAAE,EAClG,UAAmB;QAEnB,IAAI,UAAU,CAAC,WAAW,KAAK,aAAa,CAAC,IAAI,EAAE;YAC/C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SAC3D;QACD,KAAK,CAAC,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAjBtC,mBAAc,GAAG,IAAI,YAAY,EAAO,CAAC;QAkB7C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC;QAClC,IAAI,UAAU,CAAC,WAAW,KAAK,aAAa,CAAC,MAAM,IAAI,UAAU,CAAC,WAAW,KAAK,aAAa,CAAC,MAAM,EAAE;YACpG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAC/B,cAAc,EACd;gBACI,WAAW,EAAE,EAAE;aAClB,EACD,EAAE,CACL,CAAC,CAAC;SACN;IACL,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAc,EAAE,OAAwB;QACtD,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,oBAAoB,CAAC,OAAc,EAAE,OAAwB;QACzD,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACa,eAAe,CAAC,OAAc,EAAE,GAAG,IAAW;;YAC1D,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;QACtE,CAAC;KAAA;IAES,2BAA2B,CAAmH,QAAiC;QACrL,4EAA4E;QAC5E,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC9F,CAAC;IAES,2BAA2B,CAAmH,QAAiC;QACrL,4EAA4E;QAC5E,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC9F,CAAC;IAEQ,gBAAgB,CAAmH,OAAgC;QACxK,MAAM,aAAa,GAAG,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,aAAa,KAAK,SAAS,EAAE;YAC7B,OAAO,aAAa,CAAC;SACxB;QACD,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACvC,IAAI,UAAU,CAAC,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;gBACxD,MAAM,aAAa,GAAG,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;gBAChE,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;aACxC;SACJ;IACL,CAAC;IAEQ,gBAAgB,CAAmH,OAAgC;QACxK,MAAM,aAAa,GAAG,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,aAAa,KAAK,SAAS,EAAE;YAC7B,OAAO,aAAa,CAAC;SACxB;QACD,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACvC,IAAI,UAAU,CAAC,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;gBACxD,MAAM,aAAa,GAAG,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;gBAChE,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;aACxC;SACJ;IACL,CAAC;CACJ"}

package/dist/es/device/DeviceTypes.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * This represents a Root Node for devices.
+ * @see {@link MatterDeviceLibrarySpecificationV1_0} § 1.1.5
+ */
+export declare enum DeviceClasses {
+    /** Node device type. */
+    Node = "Node",
+    /**
+     * Application device type.
+     * Application devices types are typically the most datatype endpoints on a node and in the network.
+     */
+    App = "App",
+    /**
+     * Simple device type.
+     * A Simple device type supports local control that is persistent, independent, and unsupervised.
+     */
+    Simple = "Simple",
+    /**
+     * Dynamic device type.
+     * A Dynamic device type supports intelligent and supervisory services, such as commissioning,
+     * monitoring, trend analysis, scheduling and central management. A dynamic device type is an
+     * application device type.
+     */
+    Dynamic = "Dynamic",
+    /** There exists a client application cluster on the endpoint. */
+    Client = "Client",
+    /** There exists a server application cluster on the endpoint. */
+    Server = "Server",
+    /** The device type is composed of 2 or more device types. */
+    Composed = "Composed",
+    /** Composed device type that is composed of 2 or more endpoints with the same device type. */
+    Multiple = "Multiple",
+    /** The endpoint is an Initiator for Zigbee EZ-Mode Finding & Binding. */
+    "EZInitiator" = "EZ-Initiator",
+    /** The endpoint is a Target for Zigbee EZ-Mode Finding & Binding. */
+    "EZTarget" = "EZ-Target",
+    /**
+     * The endpoint represents a Bridged Device, for which information about the state of
+     * its power source is available to the Bridge
+     */
+    BridgedPowerSourceInfo = "BridgedPowerSourceInfo"
+}
+export interface DeviceTypeDefinition {
+    name: string;
+    code: number;
+    deviceClass: DeviceClasses;
+    superSet?: string;
+    revision: number;
+    requiredServerClusters: number[];
+    optionalServerClusters: number[];
+    requiredClientClusters: number[];
+    optionalClientClusters: number[];
+}
+export declare const DeviceTypeDefinition: ({ name, code, deviceClass, superSet, revision, requiredServerClusters, optionalServerClusters, requiredClientClusters, optionalClientClusters, }: {
+    name: string;
+    code: number;
+    deviceClass: DeviceClasses;
+    superSet?: string | undefined;
+    revision: number;
+    requiredServerClusters?: number[] | undefined;
+    optionalServerClusters?: number[] | undefined;
+    requiredClientClusters?: number[] | undefined;
+    optionalClientClusters?: number[] | undefined;
+}) => DeviceTypeDefinition;
+export declare const DeviceTypes: {
+    [key: string]: DeviceTypeDefinition;
+};
+export declare function getDeviceTypeDefinitionByCode(code: number): DeviceTypeDefinition | undefined;
+//# sourceMappingURL=DeviceTypes.d.ts.map

package/dist/es/device/DeviceTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceTypes.d.ts","sourceRoot":"","sources":["../../../src/device/DeviceTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH;;;GAGG;AACH,oBAAY,aAAa;IACrB,wBAAwB;IACxB,IAAI,SAAS;IAEb;;;OAGG;IACH,GAAG,QAAQ;IAEX;;;OAGG;IACH,MAAM,WAAW;IAEjB;;;;;OAKG;IACH,OAAO,YAAY;IAEnB,iEAAiE;IACjE,MAAM,WAAW;IAEjB,iEAAiE;IACjE,MAAM,WAAW;IAEjB,6DAA6D;IAC7D,QAAQ,aAAa;IAErB,8FAA8F;IAC9F,QAAQ,aAAa;IAErB,yEAAyE;IACzE,aAAa,iBAAiB;IAE9B,qEAAqE;IACrE,UAAU,cAAc;IAExB;;;OAGG;IACH,sBAAsB,2BAA2B;CACpD;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,aAAa,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,sBAAsB,EAAE,MAAM,EAAE,CAAC;CACpC;AAED,eAAO,MAAM,oBAAoB;UAWvB,MAAM;UACN,MAAM;iBACC,aAAa;;cAEhB,MAAM;;;;;MAKhB,oBAUF,CAAC;AAEH,eAAO,MAAM,WAAW,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB,CAAA;CAu7B9D,CAAA;AAED,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,CAO5F"}