matterbridge 1.6.3 → 1.6.5-dev.1

package/dist/matterbridgeEndpoint.js

@@ -64,6 +64,8 @@ export class MatterbridgeEndpoint extends Endpoint {
     softwareVersionString = undefined;
     hardwareVersion = undefined;
     hardwareVersionString = undefined;
+    name = undefined;
+    deviceType;
     uniqueStorageKey = undefined;
     tagList = undefined;
     // Maps matter deviceTypes and endpoints
@@ -78,12 +80,20 @@ export class MatterbridgeEndpoint extends Endpoint {
      * @param {MatterbridgeEndpointOptions} [options={}] - The options for the device.
      */
     constructor(definition, options = {}, debug = false) {
+        let deviceTypeList = [];
         // Get the first DeviceTypeDefinition
         let firstDefinition;
-        if (Array.isArray(definition))
+        if (Array.isArray(definition)) {
             firstDefinition = definition[0];
-        else
+            deviceTypeList = Array.from(definition.values()).map((dt) => ({
+                deviceType: dt.code,
+                revision: dt.revision,
+            }));
+        }
+        else {
             firstDefinition = definition;
+            deviceTypeList = [{ deviceType: firstDefinition.code, revision: firstDefinition.revision }];
+        }
         // Convert the first DeviceTypeDefinition to an EndpointType.Options
         const deviceTypeDefinitionV8 = {
             name: firstDefinition.name.replace('-', '_'),
@@ -104,31 +114,30 @@ export class MatterbridgeEndpoint extends Endpoint {
         };
         const endpointV8 = MutableEndpoint(deviceTypeDefinitionV8);
         // Convert the options to an Endpoint.Options
-        // [{ mfgCode: null, namespaceId: 0x07, tag: 1, label: 'Switch1' }]
-        // endpoint = endpoint.enable({features: { tagList: true }});
         const optionsV8 = {
             id: options.uniqueStorageKey?.replace(/[ .]/g, ''),
             number: options.endpointId,
-            descriptor: options.tagList ? { tagList: options.tagList } : undefined,
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            descriptor: options.tagList ? { tagList: options.tagList, deviceTypeList } : { deviceTypeList },
         };
         super(endpointV8, optionsV8);
         this.uniqueStorageKey = options.uniqueStorageKey;
+        this.name = firstDefinition.name;
+        this.deviceType = firstDefinition.code;
         this.tagList = options.tagList;
+        if (Array.isArray(definition)) {
+            definition.forEach((deviceType) => {
+                this.deviceTypes.set(deviceType.code, deviceType);
+            });
+        }
+        else
+            this.deviceTypes.set(firstDefinition.code, firstDefinition);
         // console.log('MatterbridgeEndpoint.option', options);
         // console.log('MatterbridgeEndpoint.endpointV8', endpointV8);
         // console.log('MatterbridgeEndpoint.optionsV8', optionsV8);
-        // Update the endpoint
+        // Create the logger
         this.log = new AnsiLogger({ logName: 'MatterbridgeEndpoint', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: debug === true ? "debug" /* LogLevel.DEBUG */ : MatterbridgeEndpoint.logLevel });
         this.log.debug(`${YELLOW}new${db} MatterbridgeEndpoint: ${zb}${'0x' + firstDefinition.code.toString(16).padStart(4, '0')}${db}-${zb}${firstDefinition.name}${db} ` +
             `id: ${CYAN}${options.uniqueStorageKey}${db} number: ${CYAN}${options.endpointId}${db} taglist: ${CYAN}${options.tagList ? debugStringify(options.tagList) : 'undefined'}${db}`);
-        this.deviceTypes.set(firstDefinition.code, firstDefinition);
-        // Add the other device types to the descriptor server
-        if (Array.isArray(definition)) {
-            definition.forEach((deviceType) => {
-                this.addDeviceType(deviceType);
-            });
-        }
         // Add MatterbridgeBehavior with MatterbridgeBehaviorDevice
         this.behaviors.require(MatterbridgeBehavior, { deviceCommand: new MatterbridgeBehaviorDevice(this.log, this.commandHandler, undefined) });
     }
@@ -164,7 +173,7 @@ export class MatterbridgeEndpoint extends Endpoint {
         if (clusterId === Groups.Cluster.id)
             return GroupsServer;
         if (clusterId === OnOff.Cluster.id)
-            return MatterbridgeOnOffServer;
+            return MatterbridgeOnOffServer.with('Lighting');
         if (clusterId === LevelControl.Cluster.id)
             return MatterbridgeLevelControlServer;
         if (clusterId === ColorControl.Cluster.id)
@@ -298,7 +307,12 @@ export class MatterbridgeEndpoint extends Endpoint {
             });
         });
         includeServerList.forEach((clusterId) => {
-            this.log.debug(`- with cluster: ${hk}${'0x' + clusterId.toString(16).padStart(4, '0')}${db}-${hk}${getClusterNameById(clusterId)}${db}`);
+            if (!this.getClusterServerById(clusterId)) {
+                this.log.debug(`- with cluster: ${hk}${'0x' + clusterId.toString(16).padStart(4, '0')}${db}-${hk}${getClusterNameById(clusterId)}${db}`);
+            }
+            else {
+                includeServerList.splice(includeServerList.indexOf(clusterId), 1);
+            }
         });
         deviceTypes.forEach((deviceType) => {
             this.addDeviceType(deviceType);
@@ -349,6 +363,47 @@ export class MatterbridgeEndpoint extends Endpoint {
         this.addClusterServerFromList(endpoint, optionalServerList);
         return endpoint;
     }
+    /**
+     * Adds a child endpoint with the specified device types and options.
+     * If the child endpoint is not already present, it will be created and added.
+     * If the child endpoint is already present, the device types will be added to the existing child endpoint.
+     *
+     * @param {string} endpointName - The name of the new endpoint to add.
+     * @param {AtLeastOne<DeviceTypeDefinition>} deviceTypes - The device types to add.
+     * @param {MatterbridgeEndpointOptions} [options={}] - The options for the endpoint.
+     * @param {boolean} [debug=false] - Whether to enable debug logging.
+     * @returns {MatterbridgeEndpoint} - The child endpoint that was found or added.
+     */
+    addChildDeviceType(endpointName, deviceTypes, options = {}, debug = false) {
+        this.log.debug(`addChildDeviceType: ${CYAN}${endpointName}${db}`);
+        let child = this.getChildEndpointByName(endpointName);
+        if (!child) {
+            if ('tagList' in options) {
+                for (const tag of options.tagList) {
+                    this.log.debug(`- with tagList: mfgCode ${CYAN}${tag.mfgCode}${db} namespaceId ${CYAN}${tag.namespaceId}${db} tag ${CYAN}${tag.tag}${db} label ${CYAN}${tag.label}${db}`);
+                }
+                child = new MatterbridgeEndpoint(deviceTypes[0], { uniqueStorageKey: endpointName, tagList: options.tagList }, debug);
+            }
+            else {
+                child = new MatterbridgeEndpoint(deviceTypes[0], { uniqueStorageKey: endpointName }, debug);
+            }
+        }
+        deviceTypes.forEach((deviceType) => {
+            this.log.debug(`- with deviceType: ${zb}${'0x' + deviceType.code.toString(16).padStart(4, '0')}${db}-${zb}${deviceType.name}${db}`);
+        });
+        deviceTypes.forEach((deviceType) => {
+            child.addDeviceType(deviceType);
+        });
+        if (this.lifecycle.isInstalled) {
+            this.log.debug(`- with lifecycle installed`);
+            this.add(child);
+        }
+        else {
+            this.log.debug(`- with lifecycle NOT installed`);
+            this.parts.add(child);
+        }
+        return child;
+    }
     /**
      * Adds a child endpoint with one or more device types with the required cluster servers and the specified cluster servers.
      * If the child endpoint is not already present in the childEndpoints, it will be added.
@@ -383,7 +438,15 @@ export class MatterbridgeEndpoint extends Endpoint {
             });
         });
         includeServerList.forEach((clusterId) => {
-            this.log.debug(`- with cluster: ${hk}${'0x' + clusterId.toString(16).padStart(4, '0')}${db}-${hk}${getClusterNameById(clusterId)}${db}`);
+            if (!child.getClusterServerById(clusterId)) {
+                this.log.debug(`- with cluster: ${hk}${'0x' + clusterId.toString(16).padStart(4, '0')}${db}-${hk}${getClusterNameById(clusterId)}${db}`);
+            }
+            else {
+                includeServerList.splice(includeServerList.indexOf(clusterId), 1);
+            }
+        });
+        deviceTypes.forEach((deviceType) => {
+            child.addDeviceType(deviceType);
         });
         this.addClusterServerFromList(child, includeServerList);
         if (this.lifecycle.isInstalled) {
@@ -419,6 +482,10 @@ export class MatterbridgeEndpoint extends Endpoint {
             this.addDeviceType(deviceType);
         });
     }
+    async setBridgedDeviceReachability(reachable) {
+        // await this.setAttribute(BridgedDeviceBasicInformationCluster.id, 'reachable', reachable, this.log);
+        // await this.triggerEvent(BridgedDeviceBasicInformationCluster.id, 'reachableChanged', { reachableNewValue: reachable }, this.log);
+    }
     hasClusterServer(cluster) {
         return this.clusterServers.has(cluster.id);
     }
@@ -428,6 +495,9 @@ export class MatterbridgeEndpoint extends Endpoint {
             return clusterServer;
         }
     }
+    getAllClusterServers() {
+        return [...this.clusterServers.values()];
+    }
     getClusterServerById(clusterId) {
         return this.clusterServers.get(clusterId);
     }
@@ -1121,34 +1191,53 @@ export class MatterbridgeEndpoint extends Endpoint {
     /**
      * Get a default OnOff cluster server.
      *
-     * @param onOff - The initial state of the OnOff cluster (default: false).
+     * @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
+     * @param {boolean} [globalSceneControl=false] - The global scene control state.
+     * @param {number} [onTime=0] - The on time value.
+     * @param {number} [offWaitTime=0] - The off wait time value.
+     * @param {OnOff.StartUpOnOff | null} [startUpOnOff=null] - The start-up OnOff state. Null means previous state.
+     * @returns {ClusterServer} - The configured OnOff cluster server.
      */
-    getDefaultOnOffClusterServer(onOff = false) {
-        return ClusterServer(OnOffCluster, {
+    getDefaultOnOffClusterServer(onOff = false, globalSceneControl = false, onTime = 0, offWaitTime = 0, startUpOnOff = null) {
+        return ClusterServer(OnOffCluster.with(OnOff.Feature.Lighting), {
             onOff,
+            globalSceneControl,
+            onTime,
+            offWaitTime,
+            startUpOnOff,
         }, {
             on: async (data) => {
-                this.log.debug('Matter command: on onOff:', data.attributes.onOff.getLocal());
-                await this.commandHandler.executeHandler('on', data);
+                // Never called in edge
             },
             off: async (data) => {
-                this.log.debug('Matter command: off onOff:', data.attributes.onOff.getLocal());
-                await this.commandHandler.executeHandler('off', data);
+                // Never called in edge
             },
             toggle: async (data) => {
-                this.log.debug('Matter command: toggle onOff:', data.attributes.onOff.getLocal());
-                await this.commandHandler.executeHandler('toggle', data);
+                // Never called in edge
+            },
+            offWithEffect: async () => {
+                // Never called in edge
+            },
+            onWithRecallGlobalScene: async () => {
+                // Never called in edge
+            },
+            onWithTimedOff: async () => {
+                // Never called in edge
             },
         }, {});
     }
     /**
      * Creates a default OnOff cluster server.
      *
-     * @param onOff - The initial state of the OnOff cluster (default: false).
+     * @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
+     * @param {boolean} [globalSceneControl=false] - The global scene control state.
+     * @param {number} [onTime=0] - The on time value.
+     * @param {number} [offWaitTime=0] - The off wait time value.
+     * @param {OnOff.StartUpOnOff | null} [startUpOnOff=null] - The start-up OnOff state. Null means previous state.
      * @returns {void}
      */
-    createDefaultOnOffClusterServer(onOff = false) {
-        this.addClusterServer(this.getDefaultOnOffClusterServer(onOff));
+    createDefaultOnOffClusterServer(onOff = false, globalSceneControl = false, onTime = 0, offWaitTime = 0, startUpOnOff = null) {
+        this.addClusterServer(this.getDefaultOnOffClusterServer(onOff, globalSceneControl, onTime, offWaitTime, startUpOnOff));
     }
     /**
      * Get a default level control cluster server.
@@ -1158,7 +1247,7 @@ export class MatterbridgeEndpoint extends Endpoint {
      * @param maxLevel - The maximum level (default: 254).
      * @param onLevel - The on level (default: null).
      */
-    getDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 0, maxLevel = 254, onLevel = null) {
+    getDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 0, maxLevel = 254, onLevel = 254) {
         return ClusterServer(LevelControlCluster.with(LevelControl.Feature.OnOff), {
             currentLevel,
             minLevel,
@@ -1205,7 +1294,7 @@ export class MatterbridgeEndpoint extends Endpoint {
      * @param maxLevel - The maximum level (default: 254).
      * @param onLevel - The on level (default: null).
      */
-    createDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 0, maxLevel = 254, onLevel = null) {
+    createDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 0, maxLevel = 254, onLevel = 254) {
         this.addClusterServer(this.getDefaultLevelControlClusterServer(currentLevel, minLevel, maxLevel, onLevel));
     }
     /**