matterbridge 3.1.7-dev-20250724-c3522e6 → 3.1.8-dev-20250725-5cc0474

package/CHANGELOG.md

@@ -8,11 +8,12 @@ If you like this project and find it useful, please consider giving it a star on
   <img src="bmc-button.svg" alt="Buy me a coffee" width="120">
 </a>
 
-## [3.1.6] - 2025-07-??
+## [3.1.8] - 2025-07-??
 
 ### Added
 
-- [operationalState]: Improved documentation on createDefaultOperationalStateClusterServer() and added the optional attribute countdownTime. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge/pull/363).
+- [certification]: Improved certification management in pairing.json.
+- [workflow]: Update permissions and change GitHub token for Docker build trigger
 
 ### Changed
 
@@ -22,7 +23,7 @@ If you like this project and find it useful, please consider giving it a star on
   <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
 </a>
 
-## [3.1.7] - 2025-07-24
+## [3.1.7] - 2025-07-25
 
 ### Added
 
@@ -32,6 +33,11 @@ If you like this project and find it useful, please consider giving it a star on
 - [docker]: Added on demand trigger for Build Docker Image dev from other plugins workflows.
 - [mdns]: Added bin mb_mdns.
 - [coap]: Added bin mb_coap.
+- [operationalState]: Improved documentation on createDefaultOperationalStateClusterServer() and added the optional attribute countdownTime. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge/pull/363).
+- [momentarySwitch]: Added createDefaultMomentarySwitchClusterServer(). It creates a single click only switch. It is supported by the Home app.
+- [fixedLabels]: Improved documentation and added character length check.
+- [userLabels]: Improved documentation and added character length check.
+- [certification]: Improved certification management in pairing.json with new properties.
 
 ### Changed
 

package/README-SERVICE.md

@@ -207,5 +207,6 @@ or if you prefers to only give access to npm without password try with (e.g. rad
 save the file and reload the settings with:
 
 ```bash
+sudo chmod 0440 /etc/sudoers.d/matterbridge
 sudo visudo -c
 ```

package/dist/dgram/mdns.js

@@ -128,8 +128,12 @@ export class Mdns extends Multicast {
             else {
                 const ptr = result.answers?.find((record) => record.name === '_shelly._tcp.local' && record.type === 12) ||
                     result.answers?.find((record) => record.name === '_http._tcp.local' && record.type === 12) ||
-                    result.answers?.find((record) => record.type === 12);
-                this.deviceResponses.set(rinfo.address, { rinfo, response: result, dataPTR: ptr?.data });
+                    result.answers?.find((record) => record.type === 12) ||
+                    result.answers?.find((record) => record.type === 16) ||
+                    result.answers
+                    ? result.answers[0]
+                    : undefined;
+                this.deviceResponses.set(rinfo.address, { rinfo, response: result, dataPTR: ptr?.type === 12 ? ptr?.data : ptr?.name });
                 this.onResponse(rinfo, result);
             }
             this.logMdnsMessage(result);

package/dist/matterbridge.js

@@ -136,6 +136,9 @@ export class Matterbridge extends EventEmitter {
     aggregatorVendorName = getParameter('vendorName') ?? 'Matterbridge';
     aggregatorProductId = getIntParameter('productId') ?? 0x8000;
     aggregatorProductName = getParameter('productName') ?? 'Matterbridge aggregator';
+    aggregatorDeviceType = DeviceTypeId(getIntParameter('deviceType') ?? bridge.code);
+    aggregatorSerialNumber = getParameter('serialNumber');
+    aggregatorUniqueId = getParameter('uniqueId');
     static instance;
     constructor() {
         super();
@@ -286,29 +289,46 @@ export class Matterbridge extends EventEmitter {
             await fs.access(pairingFilePath, fs.constants.R_OK);
             const pairingFileContent = await fs.readFile(pairingFilePath, 'utf8');
             const pairingFileJson = JSON.parse(pairingFileContent);
-            if (isValidNumber(pairingFileJson.vendorId))
+            if (isValidNumber(pairingFileJson.vendorId)) {
                 this.aggregatorVendorId = VendorId(pairingFileJson.vendorId);
-            if (isValidString(pairingFileJson.vendorName, 3))
+                this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using vendorId ${CYAN}${this.aggregatorVendorId}${nf} from pairing file.`);
+            }
+            if (isValidString(pairingFileJson.vendorName, 3)) {
                 this.aggregatorVendorName = pairingFileJson.vendorName;
-            if (isValidNumber(pairingFileJson.productId))
+                this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using vendorName ${CYAN}${this.aggregatorVendorName}${nf} from pairing file.`);
+            }
+            if (isValidNumber(pairingFileJson.productId)) {
                 this.aggregatorProductId = pairingFileJson.productId;
-            if (isValidString(pairingFileJson.productName, 3))
+                this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using productId ${CYAN}${this.aggregatorProductId}${nf} from pairing file.`);
+            }
+            if (isValidString(pairingFileJson.productName, 3)) {
                 this.aggregatorProductName = pairingFileJson.productName;
+                this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using productName ${CYAN}${this.aggregatorProductName}${nf} from pairing file.`);
+            }
+            if (isValidNumber(pairingFileJson.deviceType)) {
+                this.aggregatorDeviceType = DeviceTypeId(pairingFileJson.deviceType);
+                this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using deviceType ${CYAN}${this.aggregatorDeviceType}(0x${this.aggregatorDeviceType.toString(16).padStart(4, '0')})${nf} from pairing file.`);
+            }
+            if (isValidString(pairingFileJson.serialNumber, 3)) {
+                this.aggregatorSerialNumber = pairingFileJson.serialNumber;
+                this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using serialNumber ${CYAN}${this.aggregatorSerialNumber}${nf} from pairing file.`);
+            }
+            if (isValidString(pairingFileJson.uniqueId, 3)) {
+                this.aggregatorUniqueId = pairingFileJson.uniqueId;
+                this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using uniqueId ${CYAN}${this.aggregatorUniqueId}${nf} from pairing file.`);
+            }
             if (isValidNumber(pairingFileJson.passcode) && isValidNumber(pairingFileJson.discriminator)) {
                 this.passcode = pairingFileJson.passcode;
                 this.discriminator = pairingFileJson.discriminator;
                 this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using passcode ${CYAN}${this.passcode}${nf} and discriminator ${CYAN}${this.discriminator}${nf} from pairing file.`);
             }
             if (pairingFileJson.privateKey && pairingFileJson.certificate && pairingFileJson.intermediateCertificate && pairingFileJson.declaration) {
-                const hexStringToUint8Array = (hexString) => {
-                    const matches = hexString.match(/.{1,2}/g);
-                    return matches ? new Uint8Array(matches.map((byte) => parseInt(byte, 16))) : new Uint8Array();
-                };
+                const { hexToBuffer } = await import('./utils/hex.js');
                 this.certification = {
-                    privateKey: hexStringToUint8Array(pairingFileJson.privateKey),
-                    certificate: hexStringToUint8Array(pairingFileJson.certificate),
-                    intermediateCertificate: hexStringToUint8Array(pairingFileJson.intermediateCertificate),
-                    declaration: hexStringToUint8Array(pairingFileJson.declaration),
+                    privateKey: hexToBuffer(pairingFileJson.privateKey),
+                    certificate: hexToBuffer(pairingFileJson.certificate),
+                    intermediateCertificate: hexToBuffer(pairingFileJson.intermediateCertificate),
+                    declaration: hexToBuffer(pairingFileJson.declaration),
                 };
                 this.log.info(`Pairing file ${CYAN}${pairingFilePath}${nf} found. Using privateKey, certificate, intermediateCertificate and declaration from pairing file.`);
             }
@@ -647,6 +667,15 @@ export class Matterbridge extends EventEmitter {
         }
         try {
             await this.startMatterStorage();
+            if (this.aggregatorSerialNumber && this.aggregatorUniqueId && this.matterStorageService) {
+                const storageManager = await this.matterStorageService.open('Matterbridge');
+                const storageContext = storageManager?.createContext('persist');
+                if (this.aggregatorSerialNumber)
+                    await storageContext?.set('serialNumber', this.aggregatorSerialNumber);
+                if (this.aggregatorUniqueId)
+                    await storageContext?.set('uniqueId', this.aggregatorUniqueId);
+                this.matterbridgeInformation.matterbridgeSerialNumber = this.aggregatorSerialNumber;
+            }
         }
         catch (error) {
             this.log.fatal(`Fatal error creating matter storage: ${error instanceof Error ? error.message : error}`);
@@ -1200,7 +1229,7 @@ export class Matterbridge extends EventEmitter {
     async createDynamicPlugin(plugin) {
         if (!plugin.locked) {
             plugin.locked = true;
-            plugin.storageContext = await this.createServerNodeContext(plugin.name, 'Matterbridge', bridge.code, this.aggregatorVendorId, this.aggregatorVendorName, this.aggregatorProductId, plugin.description);
+            plugin.storageContext = await this.createServerNodeContext(plugin.name, 'Matterbridge', this.aggregatorDeviceType, this.aggregatorVendorId, this.aggregatorVendorName, this.aggregatorProductId, plugin.description);
             plugin.serverNode = await this.createServerNode(plugin.storageContext, this.port ? this.port++ : undefined, this.passcode ? this.passcode++ : undefined, this.discriminator ? this.discriminator++ : undefined);
             plugin.aggregatorNode = await this.createAggregatorNode(plugin.storageContext);
             plugin.serialNumber = await plugin.storageContext.get('serialNumber', '');
@@ -1381,7 +1410,7 @@ export class Matterbridge extends EventEmitter {
         this.log.info(`Matter node storage service created: ${this.matterStorageService.location}`);
         this.matterStorageManager = await this.matterStorageService.open('Matterbridge');
         this.log.info('Matter node storage manager "Matterbridge" created');
-        this.matterbridgeContext = await this.createServerNodeContext('Matterbridge', 'Matterbridge', bridge.code, this.aggregatorVendorId, this.aggregatorVendorName, this.aggregatorProductId, this.aggregatorProductName);
+        this.matterbridgeContext = await this.createServerNodeContext('Matterbridge', 'Matterbridge', this.aggregatorDeviceType, this.aggregatorVendorId, this.aggregatorVendorName, this.aggregatorProductId, this.aggregatorProductName, this.aggregatorSerialNumber, this.aggregatorUniqueId);
         this.matterbridgeInformation.matterbridgeSerialNumber = await this.matterbridgeContext.get('serialNumber', '');
         this.log.info('Matter node storage started');
         await this.backupMatterStorage(path.join(this.matterbridgeDirectory, this.matterStorageName), path.join(this.matterbridgeDirectory, this.matterStorageName + '.backup'));
@@ -1404,7 +1433,7 @@ export class Matterbridge extends EventEmitter {
         this.matterbridgeContext = undefined;
         this.log.info('Matter node storage closed');
     }
-    async createServerNodeContext(pluginName, deviceName, deviceType, vendorId, vendorName, productId, productName, serialNumber) {
+    async createServerNodeContext(pluginName, deviceName, deviceType, vendorId, vendorName, productId, productName, serialNumber, uniqueId) {
         const { randomBytes } = await import('node:crypto');
         if (!this.matterStorageService)
             throw new Error('No storage service initialized');
@@ -1422,7 +1451,7 @@ export class Matterbridge extends EventEmitter {
         await storageContext.set('nodeLabel', productName.slice(0, 32));
         await storageContext.set('productLabel', productName.slice(0, 32));
         await storageContext.set('serialNumber', await storageContext.get('serialNumber', serialNumber ? serialNumber.slice(0, 32) : 'SN' + random));
-        await storageContext.set('uniqueId', await storageContext.get('uniqueId', 'UI' + random));
+        await storageContext.set('uniqueId', await storageContext.get('uniqueId', uniqueId ? uniqueId.slice(0, 32) : 'UI' + random));
         await storageContext.set('softwareVersion', isValidNumber(parseVersionString(this.matterbridgeVersion), 0, UINT32_MAX) ? parseVersionString(this.matterbridgeVersion) : 1);
         await storageContext.set('softwareVersionString', isValidString(this.matterbridgeVersion, 5, 64) ? this.matterbridgeVersion : '1.0.0');
         await storageContext.set('hardwareVersion', isValidNumber(parseVersionString(this.systemInformation.osRelease), 0, UINT16_MAX) ? parseVersionString(this.systemInformation.osRelease) : 1);

package/dist/matterbridgeEndpoint.js

@@ -822,6 +822,15 @@ export class MatterbridgeEndpoint extends Endpoint {
         });
         return this;
     }
+    createOnOffFanControlClusterServer(fanMode = FanControl.FanMode.Off) {
+        this.behaviors.require(FanControlServer, {
+            fanMode,
+            fanModeSequence: FanControl.FanModeSequence.OffHigh,
+            percentSetting: 0,
+            percentCurrent: 0,
+        });
+        return this;
+    }
     createBaseFanControlClusterServer(fanMode = FanControl.FanMode.Off, fanModeSequence = FanControl.FanModeSequence.OffLowMedHigh, percentSetting = 0, percentCurrent = 0) {
         this.behaviors.require(FanControlServer, {
             fanMode,

package/dist/matterbridgeEndpointHelpers.js

@@ -381,15 +381,15 @@ export async function addFixedLabel(endpoint, label, value) {
     if (!endpoint.hasClusterServer(FixedLabel.Cluster.id)) {
         endpoint.log.debug(`addFixedLabel: add cluster ${hk}FixedLabel${db}:${hk}fixedLabel${db} with label ${CYAN}${label}${db} value ${CYAN}${value}${db}`);
         endpoint.behaviors.require(FixedLabelServer, {
-            labelList: [{ label, value }],
+            labelList: [{ label: label.substring(0, 16), value: value.substring(0, 16) }],
         });
         return;
     }
     endpoint.log.debug(`addFixedLabel: add label ${CYAN}${label}${db} value ${CYAN}${value}${db}`);
     let labelList = endpoint.getAttribute(FixedLabel.Cluster.id, 'labelList', endpoint.log);
     if (isValidArray(labelList)) {
-        labelList = labelList.filter((entry) => entry.label !== label);
-        labelList.push({ label, value });
+        labelList = labelList.filter((entry) => entry.label !== label.substring(0, 16));
+        labelList.push({ label: label.substring(0, 16), value: value.substring(0, 16) });
         await endpoint.setAttribute(FixedLabel.Cluster.id, 'labelList', labelList, endpoint.log);
     }
 }
@@ -397,15 +397,15 @@ export async function addUserLabel(endpoint, label, value) {
     if (!endpoint.hasClusterServer(UserLabel.Cluster.id)) {
         endpoint.log.debug(`addUserLabel: add cluster ${hk}UserLabel${db}:${hk}userLabel${db} with label ${CYAN}${label}${db} value ${CYAN}${value}${db}`);
         endpoint.behaviors.require(UserLabelServer, {
-            labelList: [{ label, value }],
+            labelList: [{ label: label.substring(0, 16), value: value.substring(0, 16) }],
         });
         return;
     }
     endpoint.log.debug(`addUserLabel: add label ${CYAN}${label}${db} value ${CYAN}${value}${db}`);
     let labelList = endpoint.getAttribute(UserLabel.Cluster.id, 'labelList', endpoint.log);
     if (isValidArray(labelList)) {
-        labelList = labelList.filter((entry) => entry.label !== label);
-        labelList.push({ label, value });
+        labelList = labelList.filter((entry) => entry.label !== label.substring(0, 16));
+        labelList.push({ label: label.substring(0, 16), value: value.substring(0, 16) });
         await endpoint.setAttribute(UserLabel.Cluster.id, 'labelList', labelList, endpoint.log);
     }
 }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.1.7-dev-20250724-c3522e6",
+  "version": "3.1.8-dev-20250725-5cc0474",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.1.7-dev-20250724-c3522e6",
+      "version": "3.1.8-dev-20250725-5cc0474",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.15.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.1.7-dev-20250724-c3522e6",
+  "version": "3.1.8-dev-20250725-5cc0474",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",