matterbridge 1.6.8-dev.8 → 1.6.8-dev.9

package/CHANGELOG.md

@@ -13,12 +13,14 @@ It is also available the official Matterbridge Home Assistant plugin https://git
 
 Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord group: https://discord.gg/QX58CDe6hd.
 
-## [1.6.8-dev.8] - 2024-12-19
+## [1.6.8-dev.9] - 2024-12-21
 
 ### Added
 
 - [storage]: Added conversion from old matter storage to the new api format with fabrics, resumptionRecords, network, commissioning, operationalCredentials, acl and parts number. The conversion is triggered every time you shutdown or restart matterbridge till the new storage has been used with matterbridge edge. 
+- [storage]: Added conversion for child endpoint numbers. 
 - [package]: Update README.md and README-SERVICE.md to include instructions for using SSL on port 443.
+- [platform]: Added checkEndpointNumbers() to detect endpoint numbers changes.
 
 ### Changed
 

package/dist/matterbridge.js

@@ -137,6 +137,12 @@ export class Matterbridge extends EventEmitter {
         super();
         this.matterbridgeMessageHandler = wsMessageHandler.bind(this);
     }
+    getDevices() {
+        return this.devices.array();
+    }
+    getPlugins() {
+        return this.plugins.array();
+    }
     matterbridgeMessageHandler;
     static async loadInstance(initialize = false) {
         if (!Matterbridge.instance) {
@@ -1553,7 +1559,7 @@ export class Matterbridge extends EventEmitter {
             const storageService = Environment.default.get(StorageService);
             Environment.default.vars.set('path.root', path.join(this.matterbridgeDirectory, 'matterstorage' + (this.profile ? '.' + this.profile : '')));
             const nodeStorage = await storageService.open('Matterbridge');
-            if ((await nodeStorage.createContext('root').createContext('generalDiagnostics').get('rebootCount', 0)) > 0) {
+            if ((await nodeStorage.createContext('root').createContext('generalDiagnostics').get('rebootCount', -1)) >= 0) {
                 this.log.info(`Matter node storage already converted to Matterbridge edge for ${plg}${pluginName}${nf}`);
                 return;
             }
@@ -1562,7 +1568,7 @@ export class Matterbridge extends EventEmitter {
             }
             const fabricManagerContext = context.createContext('FabricManager');
             const fabrics = (await fabricManagerContext.get('fabrics', []));
-            const nextFabricIndex = await fabricManagerContext.get('nextFabricIndex', 1);
+            const nextFabricIndex = await fabricManagerContext.get('nextFabricIndex', 0);
             const eventHandlerContext = context.createContext('EventHandler');
             const sessionManagerContext = context.createContext('SessionManager');
             const endpointStructureContext = context.createContext('EndpointStructure');
@@ -1574,6 +1580,10 @@ export class Matterbridge extends EventEmitter {
             const trcArray = [];
             const aclArray = [];
             this.log.info(`Found ${CYAN}${fabrics.length}${nf} fabrics (nextFabricIndex ${CYAN}${nextFabricIndex}${nf}) for ${plg}${pluginName}${nf}:`);
+            if (fabrics.length === 0 || nextFabricIndex === 0) {
+                this.log.notice(`If you want to try out matterbridge edge (beta) add -edge to the command line and pair it to your controller(s).`);
+                return;
+            }
             for (const fabric of fabrics) {
                 this.log.info(`- fabricIndex ${CYAN}${fabric.fabricIndex}${nf} fabricId ${CYAN}${fabric.fabricId}${nf} nodeId ${CYAN}${fabric.nodeId}${nf} rootNodeId ${CYAN}${fabric.rootNodeId}${nf} rootVendorId ${CYAN}${fabric.rootVendorId}${nf} label ${CYAN}${fabric.label}${nf}`);
                 fabricInfo[fabric.fabricIndex] = {
@@ -1640,20 +1650,47 @@ export class Matterbridge extends EventEmitter {
                 const parts = key.split('-');
                 const number = await endpointStructureContext.get(key);
                 if (parts.length === 2) {
-                    this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.__number__:${number}`);
+                    this.log.debug(`Converting bridge Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.__number__:${number}`);
                     await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').set('__number__', number);
                 }
                 else if (parts.length === 3 && parts[2].startsWith('custom_')) {
-                    this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${parts[2].replace('custom_', '')}.__number__:${number}`);
-                    await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').createContext('parts').createContext(parts[2].replace('custom_', '')).set('__number__', number);
+                    this.log.debug(`Converting custom Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${parts[2].replace('custom_', '').replace(/[ .]/g, '')}.__number__:${number}`);
+                    await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').createContext('parts').createContext(parts[2].replace('custom_', '').replace(/[ .]/g, '')).set('__number__', number);
                 }
                 else if (parts.length === 3 && parts[2].startsWith('unique_')) {
                     const device = this.devices.get(parts[2].replace('unique_', ''));
                     if (device && device.deviceName && device.maybeNumber) {
-                        this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${device.deviceName.replace(/[ .]/g, '')}.__number__:${device.maybeNumber}`);
+                        this.log.debug(`Converting unique Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${device.deviceName.replace(/[ .]/g, '')}.__number__:${device.maybeNumber}`);
                         await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').createContext('parts').createContext(device.deviceName.replace(/[ .]/g, '')).set('__number__', device.maybeNumber);
                     }
                 }
+                else if (parts.length === 4 && parts[2].startsWith('unique_') && parts[3].startsWith('custom_')) {
+                    const device = this.devices.get(parts[2].replace('unique_', ''));
+                    if (device && device.deviceName && device.maybeNumber) {
+                        this.log.debug(`Converting unique Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${device.deviceName.replace(/[ .]/g, '')}.parts.${parts[3].replace('custom_', '').replace(/[ .]/g, '')}.__number__:${device.maybeNumber}`);
+                        await nodeStorage
+                            .createContext('root')
+                            .createContext('parts')
+                            .createContext('Matterbridge')
+                            .createContext('parts')
+                            .createContext(device.deviceName.replace(/[ .]/g, ''))
+                            .createContext('parts')
+                            .createContext(parts[3].replace('custom_', '').replace(/[ .]/g, ''))
+                            .set('__number__', device.maybeNumber);
+                    }
+                }
+                else if (parts.length === 4 && parts[2].startsWith('custom_') && parts[3].startsWith('custom_')) {
+                    this.log.debug(`Converting custom Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${parts[2].replace('custom_', '').replace(/[ .]/g, '')}.parts.${parts[3].replace('custom_', '').replace(/[ .]/g, '')}.__number__:${number}`);
+                    await nodeStorage
+                        .createContext('root')
+                        .createContext('parts')
+                        .createContext('Matterbridge')
+                        .createContext('parts')
+                        .createContext(parts[2].replace('custom_', '').replace(/[ .]/g, ''))
+                        .createContext('parts')
+                        .createContext(parts[3].replace('custom_', '').replace(/[ .]/g, ''))
+                        .set('__number__', number);
+                }
             }
             await nodeStorage.createContext('persist').set('converted', true);
             await nodeStorage.createContext('persist').set('deviceName', await context.get('deviceName'));

package/dist/matterbridgePlatform.js

@@ -1,7 +1,9 @@
 import { MatterbridgeDevice } from './matterbridgeDevice.js';
-import { CYAN, nf } from 'node-ansi-logger';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
-import { isValidArray, isValidObject } from './utils/utils.js';
+import { isValidArray, isValidObject, isValidString } from './utils/utils.js';
+import { CYAN, db, nf, wr } from 'node-ansi-logger';
+import { NodeStorageManager } from 'node-persist-manager';
+import path from 'path';
 export class MatterbridgePlatform {
     matterbridge;
     log;
@@ -9,20 +11,34 @@ export class MatterbridgePlatform {
     name = '';
     type = '';
     version = '';
+    storage;
+    context;
     constructor(matterbridge, log, config) {
         this.matterbridge = matterbridge;
         this.log = log;
         this.config = config;
+        if (!isValidString(this.config.name))
+            return;
+        this.log.debug(`Creating storage for plugin ${this.config.name} in ${path.join(this.matterbridge.matterbridgeDirectory, this.config.name)}`);
+        this.storage = new NodeStorageManager({
+            dir: path.join(this.matterbridge.matterbridgeDirectory, this.config.name),
+            writeQueue: false,
+            expiredInterval: undefined,
+            logging: false,
+            forgiveParseErrors: true,
+        });
     }
     async onStart(reason) {
         this.log.error('Plugins must override onStart.', reason);
         throw new Error('Plugins must override onStart.');
     }
     async onConfigure() {
-        this.log.debug("The plugin doesn't override onConfigure.");
+        this.log.debug(`Configuring platform ${this.name}`);
+        await this.checkEndpointNumbers();
     }
     async onShutdown(reason) {
-        this.log.debug("The plugin doesn't override onShutdown.", reason);
+        this.log.debug(`Shutting down platform ${this.name}`, reason);
+        await this.checkEndpointNumbers();
     }
     async onChangeLoggerLevel(logLevel) {
         this.log.debug(`The plugin doesn't override onChangeLoggerLevel. Logger level set to: ${logLevel}`);
@@ -120,4 +136,38 @@ export class MatterbridgePlatform {
         }
         return true;
     }
+    async checkEndpointNumbers() {
+        if (!this.storage)
+            return -1;
+        this.log.debug('Checking endpoint numbers...');
+        const context = await this.storage.createStorage('context');
+        const separator = '|.|';
+        const endpointMap = new Map(await context.get('endpointMap', []));
+        for (const device of this.matterbridge.getDevices().filter((d) => d.plugin === this.name)) {
+            if (device.uniqueId === undefined || device.maybeNumber === undefined)
+                continue;
+            if (endpointMap.has(device.uniqueId) && endpointMap.get(device.uniqueId) !== device.maybeNumber) {
+                this.log.warn(`Endpoint number for device ${CYAN}${device.uniqueId}${wr} changed from ${CYAN}${endpointMap.get(device.uniqueId)}${wr} to ${CYAN}${device.maybeNumber}${wr}`);
+                endpointMap.set(device.uniqueId, device.maybeNumber);
+            }
+            if (!endpointMap.has(device.uniqueId)) {
+                this.log.debug(`Setting endpoint number for device ${CYAN}${device.uniqueId}${db} to ${CYAN}${device.maybeNumber}${db}`);
+                endpointMap.set(device.uniqueId, device.maybeNumber);
+            }
+            for (const child of device.getChildEndpoints()) {
+                const childId = child instanceof MatterbridgeEndpoint ? child.id : child.uniqueStorageKey;
+                if (!childId || !child.maybeNumber)
+                    continue;
+                if (endpointMap.has(device.uniqueId + separator + childId) && endpointMap.get(device.uniqueId + separator + childId) !== child.maybeNumber) {
+                    this.log.warn(`Child endpoint number for device ${CYAN}${device.uniqueId}${wr}.${CYAN}${childId}${wr} changed from ${CYAN}${endpointMap.get(device.uniqueId + separator + childId)}${wr} to ${CYAN}${child.maybeNumber}${wr}`);
+                }
+                if (!endpointMap.has(device.uniqueId + separator + childId)) {
+                    this.log.debug(`Setting child endpoint number for device ${CYAN}${device.uniqueId}${db}.${CYAN}${childId}${db} to ${CYAN}${child.maybeNumber}${db}`);
+                    endpointMap.set(device.uniqueId + separator + childId, child.maybeNumber);
+                }
+            }
+        }
+        await context.set('endpointMap', Array.from(endpointMap.entries()));
+        return endpointMap.size;
+    }
 }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "1.6.8-dev.8",
+  "version": "1.6.8-dev.9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "1.6.8-dev.8",
+      "version": "1.6.8-dev.9",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.11.9",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "1.6.8-dev.8",
+  "version": "1.6.8-dev.9",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",