matterbridge 1.6.6-dev.1 → 1.6.6-dev.14

package/CHANGELOG.md

@@ -14,12 +14,36 @@ If you want to run Matterbridge in Home Assistant please use the official add-on
 
 Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord group: https://discord.gg/QX58CDe6hd.
 
-## [1.6.6] - 2024-12-05
+## [1.6.6-dev.13] - 2024-12-10
+
+### Added
+
+- [frontend]: Add the possibility to install a specific version or the dev of any plugin (i.e. you can install matterbridge-hass@dev or matterbridge-hass@0.0.3).
+  It is also possible to use the install plugin to install a specific version of matterbridge (i.e. you can install matterbridge@dev or matterbridge@1.6.5)
+- [frontend]: Add the possibility to set the matter discriminator for commissioning (you can always override passing **-discriminator [DISCRIMINATOR]** on the command line).
+- [frontend]: Add the possibility to set the matter passcode for commissioning (you can always override passing **-passcode [PASSCODE]** on the command line).
+- [frontend]: Add the possibility to set the matter port for commissioning (you can always override passing **-port [PORT]** on the command line).
+- [deviceTypes]: Add device type airConditioner (not supported by the Apple Home).
+- [docker]: Add matterbridge-hass to docker dev.
+- [platform]: Added validateDeviceWhiteBlackList and validateEntityBlackList to be used consistently by all plugins.
+- [/api/devices]: Added productUrl and configUrl.
 
 ### Changed
 
-- [plugin]: Removed check on types since we are moving to production plugins.
+- [package]: Update matter.js to 0.11.9-alpha.0-20241206-22f23333.
+- [package]: Update matter.js to 0.11.9-alpha.0-20241207-b604cfa44
+- [package]: Update matter.js to 0.11.9-alpha.0-20241209-06a8040e1
+- [plugin]: Removed check on package types since we are moving to production plugins.
+- [package]: Set required node version to 18, 20 and 22.
 - [package]: Update dependencies.
+- [onOff]: Set default to OnOff.Feature.Lighting.
+- [levelControl]: Set default to LevelControl.Feature.Lighting.
+- [lightSensor]: Refactor lightSensor removing Group optional cluster server.
+- [jest]: Update Jest tests.
+
+### Fixed
+
+- [device]: Fix typos in Device and Endpoint.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="./yellow-button.png" alt="Buy me a coffee" width="120">

package/README-DEV.md

@@ -71,9 +71,9 @@ I added some error messages when a plugin has wrong imports or configurations an
 
 I'm working with matter.js team to define the strategy for the migration of Matterbridge to the new API.
 
-- First phase: crete MatterbridgeEdge class: completed 90%
-- Second phase: create MatterbridgeEndpoint and MatterbridgeBehaviors classes: completed 90%
-- Third phase: modifiy all plugins to support both normal and edge mode of Matterbridge: completed 80%
+- First phase: create MatterbridgeEdge class: completed 95%
+- Second phase: create MatterbridgeEndpoint and MatterbridgeBehaviors classes: completed 95%
+- Third phase: modifiy all plugins to support both normal and edge mode of Matterbridge: completed 90%
 - Fourth phase: remove all old api code from Matterbridge and all plugins...
 
 ## How to create your plugin

package/README.md

@@ -46,6 +46,10 @@ A special thank to Apollon77 for his incredible work.
 
 To run Matterbridge, you need either a [Node.js](https://nodejs.org/en/download/package-manager) environment or [Docker](https://docs.docker.com/get-started/get-docker/) installed on your system.
 
+If you don't have Node.js already install, please use this method to install it on a debian device: https://github.com/nodesource/distributions. Nvm is not a good choice.
+
+If you don't have Docker already install, please use this method to install it on a debian device: https://docs.docker.com/desktop/setup/install/linux/debian/. 
+
 ## Installation
 
 Follow these steps to install Matterbridge:

package/dist/matterbridge.js

@@ -68,6 +68,9 @@ export class Matterbridge extends EventEmitter {
         mattermdnsinterface: undefined,
         matteripv4address: undefined,
         matteripv6address: undefined,
+        matterPort: 5540,
+        matterDiscriminator: undefined,
+        matterPasscode: undefined,
         restartRequired: false,
         refreshRequired: false,
     };
@@ -151,9 +154,6 @@ export class Matterbridge extends EventEmitter {
         await wait(1000, 'Wait for the global node_modules and matterbridge version', false);
     }
     async initialize() {
-        this.port = getIntParameter('port') ?? 5540;
-        this.passcode = getIntParameter('passcode');
-        this.discriminator = getIntParameter('discriminator');
         if (hasParameter('service'))
             this.restartMode = 'service';
         if (hasParameter('docker'))
@@ -200,6 +200,9 @@ export class Matterbridge extends EventEmitter {
             this.log.fatal('Fatal error creating node storage manager and context for matterbridge');
             throw new Error('Fatal error creating node storage manager and context for matterbridge');
         }
+        this.port = getIntParameter('port') ?? (await this.nodeContext.get('matterport', 5540)) ?? 5540;
+        this.passcode = getIntParameter('passcode') ?? (await this.nodeContext.get('matterpasscode'));
+        this.discriminator = getIntParameter('discriminator') ?? (await this.nodeContext.get('matterdiscriminator'));
         if (hasParameter('logger')) {
             const level = getParameter('logger');
             if (level === 'debug') {
@@ -1646,7 +1649,7 @@ export class Matterbridge extends EventEmitter {
         this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with uniqueId ${uniqueId} serialNumber ${serialNumber}`);
         this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with softwareVersion ${softwareVersion} softwareVersionString ${softwareVersionString}`);
         this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with hardwareVersion ${hardwareVersion} hardwareVersionString ${hardwareVersionString}`);
-        this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with nodeLabel '${productName}' port ${this.port} passcode ${this.passcode} discriminator ${this.discriminator}`);
+        this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with nodeLabel '${productName}' port ${CYAN}${this.port}${db} discriminator ${CYAN}${this.discriminator}${db} passcode ${CYAN}${this.passcode}${db} `);
         if (this.ipv4address) {
             const networkInterfaces = os.networkInterfaces();
             const availableAddresses = Object.values(networkInterfaces)
@@ -2312,6 +2315,9 @@ export class Matterbridge extends EventEmitter {
             this.matterbridgeInformation.mattermdnsinterface = (await this.nodeContext?.get('mattermdnsinterface', '')) || '';
             this.matterbridgeInformation.matteripv4address = (await this.nodeContext?.get('matteripv4address', '')) || '';
             this.matterbridgeInformation.matteripv6address = (await this.nodeContext?.get('matteripv6address', '')) || '';
+            this.matterbridgeInformation.matterPort = (await this.nodeContext?.get('matterport', 5540)) ?? 5540;
+            this.matterbridgeInformation.matterDiscriminator = await this.nodeContext?.get('matterdiscriminator');
+            this.matterbridgeInformation.matterPasscode = await this.nodeContext?.get('matterpasscode');
             this.matterbridgeInformation.matterbridgePaired = this.matterbridgePaired;
             this.matterbridgeInformation.matterbridgeConnected = this.matterbridgeConnected;
             this.matterbridgeInformation.matterbridgeQrPairingCode = this.matterbridgeQrPairingCode;
@@ -2329,7 +2335,7 @@ export class Matterbridge extends EventEmitter {
         });
         this.expressApp.get('/api/devices', (req, res) => {
             this.log.debug('The frontend sent /api/devices');
-            const data = [];
+            const devices = [];
             this.devices.forEach(async (device) => {
                 const pluginName = device.plugin ?? 'Unknown';
                 if (this.edge)
@@ -2340,21 +2346,26 @@ export class Matterbridge extends EventEmitter {
                 let serial = device.getClusterServer(BasicInformationCluster)?.attributes.serialNumber?.getLocal();
                 if (!serial)
                     serial = device.getClusterServer(BridgedDeviceBasicInformationCluster)?.attributes.serialNumber?.getLocal() ?? 'Unknown';
+                let productUrl = device.getClusterServer(BasicInformationCluster)?.attributes.productUrl?.getLocal();
+                if (!productUrl)
+                    productUrl = device.getClusterServer(BridgedDeviceBasicInformationCluster)?.attributes.productUrl?.getLocal() ?? 'Unknown';
                 let uniqueId = device.getClusterServer(BasicInformationCluster)?.attributes.uniqueId?.getLocal();
                 if (!uniqueId)
                     uniqueId = device.getClusterServer(BridgedDeviceBasicInformationCluster)?.attributes.uniqueId?.getLocal() ?? 'Unknown';
                 const cluster = this.getClusterTextFromDevice(device);
-                data.push({
+                devices.push({
                     pluginName,
                     type: device.name + ' (0x' + device.deviceType.toString(16).padStart(4, '0') + ')',
                     endpoint: device.number,
                     name,
                     serial,
+                    productUrl,
+                    configUrl: device.configUrl,
                     uniqueId,
                     cluster: cluster,
                 });
             });
-            res.json(data);
+            res.json(devices);
         });
         this.expressApp.get('/api/devices_clusters/:selectedPluginName/:selectedDeviceEndpoint', (req, res) => {
             const selectedPluginName = req.params.selectedPluginName;
@@ -2629,6 +2640,30 @@ export class Matterbridge extends EventEmitter {
                 res.json({ message: 'Command received' });
                 return;
             }
+            if (command === 'setmatterport') {
+                const port = Math.min(Math.max(parseInt(param), 5540), 5560);
+                this.matterbridgeInformation.matterPort = port;
+                this.log.debug(`Set matter commissioning port to ${CYAN}${port}${db}`);
+                await this.nodeContext?.set('matterport', port);
+                res.json({ message: 'Command received' });
+                return;
+            }
+            if (command === 'setmatterdiscriminator') {
+                const discriminator = Math.min(Math.max(parseInt(param), 1000), 4095);
+                this.matterbridgeInformation.matterDiscriminator = discriminator;
+                this.log.debug(`Set matter commissioning discriminator to ${CYAN}${discriminator}${db}`);
+                await this.nodeContext?.set('matterdiscriminator', discriminator);
+                res.json({ message: 'Command received' });
+                return;
+            }
+            if (command === 'setmatterpasscode') {
+                const passcode = Math.min(Math.max(parseInt(param), 10000000), 90000000);
+                this.matterbridgeInformation.matterPasscode = passcode;
+                this.log.debug(`Set matter commissioning passcode to ${CYAN}${passcode}${db}`);
+                await this.nodeContext?.set('matterpasscode', passcode);
+                res.json({ message: 'Command received' });
+                return;
+            }
             if (command === 'setmblogfile') {
                 this.log.debug('Matterbridge file log:', param);
                 this.matterbridgeInformation.fileLogger = param === 'true';
@@ -2732,6 +2767,11 @@ export class Matterbridge extends EventEmitter {
                     this.log.error(`Error installing plugin ${plg}${param}${er}`);
                 }
                 this.wssSendRestartRequired();
+                param = param.split('@')[0];
+                if (param === 'matterbridge') {
+                    res.json({ message: 'Command received' });
+                    return;
+                }
             }
             if (command === 'addplugin' || command === 'installplugin') {
                 param = param.replace(/\*/g, '\\');

package/dist/matterbridgeBehaviors.js

@@ -23,6 +23,10 @@ export class MatterbridgeBehaviorDevice {
         this.log.info(`Identifying device for ${identifyTime} seconds`);
         this.commandHandler.executeHandler('identify', { request: { identifyTime }, attributes: {}, endpoint: { number: this.endpointNumber, uniqueStorageKey: this.endpointId } });
     }
+    triggerEffect({ effectIdentifier, effectVariant }) {
+        this.log.info(`Triggering effect ${effectIdentifier} variant ${effectVariant}`);
+        this.commandHandler.executeHandler('triggerEffect', { request: { effectIdentifier, effectVariant }, attributes: {}, endpoint: { number: this.endpointNumber, uniqueStorageKey: this.endpointId } });
+    }
     on() {
         this.log.info(`Switching device on (endpoint ${this.endpointId}.${this.endpointNumber})`);
         this.commandHandler.executeHandler('on', { request: {}, attributes: {}, endpoint: { number: this.endpointNumber, uniqueStorageKey: this.endpointId } });
@@ -125,6 +129,11 @@ export class MatterbridgeIdentifyServer extends IdentifyServer {
         device.identify({ identifyTime });
         super.identify({ identifyTime });
     }
+    triggerEffect({ effectIdentifier, effectVariant }) {
+        const device = this.agent.get(MatterbridgeBehavior).state.deviceCommand;
+        device.triggerEffect({ effectIdentifier, effectVariant });
+        super.triggerEffect({ effectIdentifier, effectVariant });
+    }
 }
 export class MatterbridgeOnOffServer extends OnOffServer {
     async on() {

package/dist/matterbridgeDevice.js

@@ -12,6 +12,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
     static logLevel = "info";
     log;
     plugin = undefined;
+    configUrl = undefined;
     serialNumber = undefined;
     deviceName = undefined;
     uniqueId = undefined;
@@ -458,6 +459,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             vendorName: vendorName.slice(0, 32),
             productId: productId,
             productName: productName.slice(0, 32),
+            productUrl: 'https://www.npmjs.com/package/matterbridge',
             productLabel: deviceName.slice(0, 64),
             nodeLabel: deviceName.slice(0, 32),
             serialNumber: serialNumber.slice(0, 32),
@@ -502,6 +504,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             vendorId: vendorId !== undefined ? VendorId(vendorId) : undefined,
             vendorName: vendorName.slice(0, 32),
             productName: productName.slice(0, 32),
+            productUrl: 'https://www.npmjs.com/package/matterbridge',
             productLabel: deviceName.slice(0, 64),
             nodeLabel: deviceName.slice(0, 32),
             serialNumber: serialNumber.slice(0, 32),
@@ -644,12 +647,14 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
     createDefaultOnOffClusterServer(onOff = false, globalSceneControl = false, onTime = 0, offWaitTime = 0, startUpOnOff = null) {
         this.addClusterServer(this.getDefaultOnOffClusterServer(onOff, globalSceneControl, onTime, offWaitTime, startUpOnOff));
     }
-    getDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 0, maxLevel = 254, onLevel = null) {
-        return ClusterServer(LevelControlCluster.with(LevelControl.Feature.OnOff), {
+    getDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 1, maxLevel = 254, onLevel = null, startUpCurrentLevel = null) {
+        return ClusterServer(LevelControlCluster.with(LevelControl.Feature.OnOff, LevelControl.Feature.Lighting), {
             currentLevel,
             minLevel,
             maxLevel,
             onLevel,
+            remainingTime: 0,
+            startUpCurrentLevel,
             options: {
                 executeIfOff: false,
                 coupleColorTempToLevel: false,
@@ -683,8 +688,8 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             },
         });
     }
-    createDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 0, maxLevel = 254, onLevel = null) {
-        this.addClusterServer(this.getDefaultLevelControlClusterServer(currentLevel, minLevel, maxLevel, onLevel));
+    createDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 1, maxLevel = 254, onLevel = null, startUpCurrentLevel = null) {
+        this.addClusterServer(this.getDefaultLevelControlClusterServer(currentLevel, minLevel, maxLevel, onLevel, startUpCurrentLevel));
     }
     getDefaultColorControlClusterServer(currentX = 0, currentY = 0, currentHue = 0, currentSaturation = 0, colorTemperatureMireds = 500, colorTempPhysicalMinMireds = 147, colorTempPhysicalMaxMireds = 500) {
         return ClusterServer(ColorControlCluster.with(ColorControl.Feature.Xy, ColorControl.Feature.HueSaturation, ColorControl.Feature.ColorTemperature), {
@@ -702,6 +707,9 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             colorTemperatureMireds,
             colorTempPhysicalMinMireds,
             colorTempPhysicalMaxMireds,
+            coupleColorTempToLevelMinMireds: colorTempPhysicalMinMireds,
+            remainingTime: 0,
+            startUpColorTemperatureMireds: null,
         }, {
             moveToColor: async (data) => {
                 this.log.debug('Matter command: moveToColor request:', data.request, 'attributes.currentX:', data.attributes.currentX.getLocal(), 'attributes.currentY:', data.attributes.currentY.getLocal());
@@ -766,6 +774,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             numberOfPrimaries: null,
             currentX,
             currentY,
+            remainingTime: 0,
         }, {
             moveToColor: async (data) => {
                 this.log.debug('Matter command: moveToColor request:', data.request, 'attributes.currentX:', data.attributes.currentX.getLocal(), 'attributes.currentY:', data.attributes.currentY.getLocal());
@@ -782,7 +791,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             },
         }, {});
     }
-    createXyControlClusterServer(currentX = 0, currentY = 0) {
+    createXyColorControlClusterServer(currentX = 0, currentY = 0) {
         this.addClusterServer(this.getXyColorControlClusterServer(currentX, currentY));
     }
     getHsColorControlClusterServer(currentHue = 0, currentSaturation = 0) {
@@ -796,6 +805,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             numberOfPrimaries: null,
             currentHue,
             currentSaturation,
+            remainingTime: 0,
         }, {
             moveToHue: async ({ request, attributes, endpoint }) => {
                 this.log.debug('Matter command: moveToHue request:', request, 'attributes.currentHue:', attributes.currentHue.getLocal());
@@ -841,6 +851,9 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
             colorTemperatureMireds,
             colorTempPhysicalMinMireds,
             colorTempPhysicalMaxMireds,
+            coupleColorTempToLevelMinMireds: colorTempPhysicalMinMireds,
+            remainingTime: 0,
+            startUpColorTemperatureMireds: null,
         }, {
             stopMoveStep: async () => {
                 this.log.error('Matter command: stopMoveStep not implemented');

package/dist/matterbridgeDeviceTypes.js

@@ -116,7 +116,6 @@ export const lightSensor = DeviceTypeDefinition({
     deviceClass: DeviceClasses.Simple,
     revision: 3,
     requiredServerClusters: [Identify.Cluster.id, IlluminanceMeasurement.Cluster.id],
-    optionalClientClusters: [Groups.Cluster.id],
 });
 export const occupancySensor = DeviceTypeDefinition({
     name: 'MA-occupancysensor',

package/dist/matterbridgeEdge.js

@@ -48,9 +48,6 @@ export class MatterbridgeEdge extends Matterbridge {
         await super.initialize();
         if (this.mdnsInterface)
             this.environment.vars.set('mdns.networkInterface', this.mdnsInterface);
-        this.port = 5540;
-        this.passcode = 20242025;
-        this.discriminator = 3840;
     }
     async startMatterStorage(storageType, storageName) {
         this.log.info(`Starting matter node storage...`);