matterbridge 1.6.6-dev.1 → 1.6.6-dev.3

package/CHANGELOG.md

@@ -16,10 +16,23 @@ Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord
 
 ## [1.6.6] - 2024-12-05
 
+### Added
+
+- [deviceTypes]: Add device type airConditioner.
+- [docker]: Add matterbridge-hass to docker dev.
+- [platform]: Added validateDeviceWhiteBlackList and validateEntityBlackList to be use consistently by all plugins.
+
 ### Changed
 
-- [plugin]: Removed check on types since we are moving to production plugins.
+- [plugin]: Removed check on package types since we are moving to production plugins.
+- [package]: Set node version to 18, 20 and 22.
 - [package]: Update dependencies.
+- [levelControl]: Set default to OnOff.Feature.Lighting.
+- [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/dist/matterbridgeEndpoint.js

@@ -41,6 +41,7 @@ export class MatterbridgeEndpoint extends Endpoint {
     deviceType;
     uniqueStorageKey = undefined;
     tagList = undefined;
+    subType = '';
     deviceTypes = new Map();
     clusterServers = new Map();
     clusterClients = new Map();
@@ -115,7 +116,7 @@ export class MatterbridgeEndpoint extends Endpoint {
         });
         return behaviorTypes;
     }
-    static getBehaviourTypeFromClusterServerId(clusterId, type) {
+    static getBehaviourTypeFromClusterServerId(clusterId, subType) {
         if (clusterId === Identify.Cluster.id)
             return MatterbridgeIdentifyServer;
         if (clusterId === Groups.Cluster.id)
@@ -124,29 +125,35 @@ export class MatterbridgeEndpoint extends Endpoint {
             return MatterbridgeOnOffServer.with('Lighting');
         if (clusterId === LevelControl.Cluster.id)
             return MatterbridgeLevelControlServer;
-        if (clusterId === ColorControl.Cluster.id && type === 'CompleteColorControl')
+        if (clusterId === ColorControl.Cluster.id && subType === undefined)
             return MatterbridgeColorControlServer;
-        if (clusterId === ColorControl.Cluster.id && type === 'XyColorControl')
+        if (clusterId === ColorControl.Cluster.id && subType === 'CompleteColorControl')
+            return MatterbridgeColorControlServer;
+        if (clusterId === ColorControl.Cluster.id && subType === 'XyColorControl')
             return MatterbridgeColorControlServer.with('Xy');
-        if (clusterId === ColorControl.Cluster.id && type === 'HueSaturationColorControl')
+        if (clusterId === ColorControl.Cluster.id && subType === 'HueSaturationColorControl')
             return MatterbridgeColorControlServer.with('HueSaturation');
-        if (clusterId === ColorControl.Cluster.id && type === 'ColorTemperatureColorControl')
+        if (clusterId === ColorControl.Cluster.id && subType === 'ColorTemperatureColorControl')
             return MatterbridgeColorControlServer.with('ColorTemperature');
         if (clusterId === DoorLock.Cluster.id)
             return MatterbridgeDoorLockServer;
-        if (clusterId === Thermostat.Cluster.id && type === 'AutoModeThermostat')
+        if (clusterId === Thermostat.Cluster.id && subType === undefined)
+            return MatterbridgeThermostatServer.with('AutoMode', 'Heating', 'Cooling');
+        if (clusterId === Thermostat.Cluster.id && subType === 'AutoModeThermostat')
             return MatterbridgeThermostatServer.with('AutoMode', 'Heating', 'Cooling');
-        if (clusterId === Thermostat.Cluster.id && type === 'HeatingThermostat')
+        if (clusterId === Thermostat.Cluster.id && subType === 'HeatingThermostat')
             return MatterbridgeThermostatServer.with('Heating');
-        if (clusterId === Thermostat.Cluster.id && type === 'CoolingThermostat')
+        if (clusterId === Thermostat.Cluster.id && subType === 'CoolingThermostat')
             return MatterbridgeThermostatServer.with('Cooling');
         if (clusterId === WindowCovering.Cluster.id)
             return MatterbridgeWindowCoveringServer;
         if (clusterId === FanControl.Cluster.id)
             return MatterbridgeFanControlServer;
-        if (clusterId === Switch.Cluster.id && type === 'MomentarySwitch')
+        if (clusterId === Switch.Cluster.id && subType === undefined)
             return SwitchServer.with('MomentarySwitch', 'MomentarySwitchRelease', 'MomentarySwitchLongPress', 'MomentarySwitchMultiPress');
-        if (clusterId === Switch.Cluster.id && type === 'LatchingSwitch')
+        if (clusterId === Switch.Cluster.id && subType === 'MomentarySwitch')
+            return SwitchServer.with('MomentarySwitch', 'MomentarySwitchRelease', 'MomentarySwitchLongPress', 'MomentarySwitchMultiPress');
+        if (clusterId === Switch.Cluster.id && subType === 'LatchingSwitch')
             return SwitchServer.with('LatchingSwitch');
         if (clusterId === TemperatureMeasurement.Cluster.id)
             return TemperatureMeasurementServer;
@@ -200,11 +207,13 @@ export class MatterbridgeEndpoint extends Endpoint {
             return ElectricalPowerMeasurementServer.with('AlternatingCurrent');
         if (clusterId === ElectricalEnergyMeasurement.Cluster.id)
             return ElectricalEnergyMeasurementServer.with('ImportedEnergy', 'ExportedEnergy', 'CumulativeEnergy');
-        if (clusterId === PowerSource.Cluster.id && type === 'WiredPowerSource')
+        if (clusterId === PowerSource.Cluster.id && subType === undefined)
+            return PowerSourceServer;
+        if (clusterId === PowerSource.Cluster.id && subType === 'WiredPowerSource')
             return PowerSourceServer.with(PowerSource.Feature.Wired);
-        if (clusterId === PowerSource.Cluster.id && type === 'BatteryReplaceablePowerSource')
+        if (clusterId === PowerSource.Cluster.id && subType === 'BatteryReplaceablePowerSource')
             return PowerSourceServer.with(PowerSource.Feature.Battery, PowerSource.Feature.Replaceable);
-        if (clusterId === PowerSource.Cluster.id && type === 'BatteryRechargeablePowerSource')
+        if (clusterId === PowerSource.Cluster.id && subType === 'BatteryRechargeablePowerSource')
             return PowerSourceServer.with(PowerSource.Feature.Battery, PowerSource.Feature.Rechargeable);
         if (clusterId === BasicInformation.Cluster.id)
             return BasicInformationServer;
@@ -410,40 +419,32 @@ export class MatterbridgeEndpoint extends Endpoint {
         if (this.clusterServers.has(cluster.id)) {
             this.log.debug(`****cluster ${hk}${'0x' + cluster.id.toString(16).padStart(4, '0')}${db}-${hk}${getClusterNameById(cluster.id)}${db} already added`);
         }
-        let type = undefined;
+        this.subType = '';
         if (cluster.id === ColorControl.Cluster.id && cluster.isAttributeSupportedByName('currentX') && !cluster.isAttributeSupportedByName('currentHue') && !cluster.isAttributeSupportedByName('colorTemperatureMireds'))
-            type = 'XyColorControl';
+            this.subType = 'XyColorControl';
         else if (cluster.id === ColorControl.Cluster.id && cluster.isAttributeSupportedByName('currentHue') && !cluster.isAttributeSupportedByName('currentX') && !cluster.isAttributeSupportedByName('colorTemperatureMireds'))
-            type = 'HueSaturationColorControl';
+            this.subType = 'HueSaturationColorControl';
         else if (cluster.id === ColorControl.Cluster.id && cluster.isAttributeSupportedByName('colorTemperatureMireds') && !cluster.isAttributeSupportedByName('currentHue') && !cluster.isAttributeSupportedByName('currentX'))
-            type = 'ColorTemperatureColorControl';
+            this.subType = 'ColorTemperatureColorControl';
         else
-            type = 'CompleteColorControl';
+            this.subType = 'CompleteColorControl';
         if (cluster.id === SwitchCluster.id && cluster.isEventSupportedByName('multiPressComplete'))
-            type = 'MomentarySwitch';
+            this.subType = 'MomentarySwitch';
         if (cluster.id === SwitchCluster.id && cluster.isEventSupportedByName('switchLatched'))
-            type = 'LatchingSwitch';
+            this.subType = 'LatchingSwitch';
         if (cluster.id === PowerSourceCluster.id && cluster.isAttributeSupportedByName('wiredCurrentType'))
-            type = 'WiredPowerSource';
+            this.subType = 'WiredPowerSource';
         if (cluster.id === PowerSourceCluster.id && cluster.isAttributeSupportedByName('batReplacementDescription'))
-            type = 'BatteryReplaceablePowerSource';
+            this.subType = 'BatteryReplaceablePowerSource';
         if (cluster.id === PowerSourceCluster.id && cluster.isAttributeSupportedByName('batChargeState'))
-            type = 'BatteryRechargeablePowerSource';
+            this.subType = 'BatteryRechargeablePowerSource';
         if (cluster.id === ThermostatCluster.id && cluster.isAttributeSupportedByName('occupiedCoolingSetpoint'))
-            type = 'CoolingThermostat';
+            this.subType = 'CoolingThermostat';
         if (cluster.id === ThermostatCluster.id && cluster.isAttributeSupportedByName('occupiedHeatingSetpoint'))
-            type = 'HeatingThermostat';
+            this.subType = 'HeatingThermostat';
         if (cluster.id === ThermostatCluster.id && cluster.isAttributeSupportedByName('minSetpointDeadBand'))
-            type = 'AutoModeThermostat';
-        const behavior = MatterbridgeEndpoint.getBehaviourTypeFromClusterServerId(cluster.id, type);
-        if (cluster.id === PowerTopologyCluster.id && this.clusterServers.has(cluster.id))
-            return;
-        if (cluster.id === ElectricalPowerMeasurementCluster.id && this.clusterServers.has(cluster.id))
-            return;
-        if (cluster.id === ElectricalEnergyMeasurementCluster.id && this.clusterServers.has(cluster.id))
-            return;
-        if (cluster.id === ThermostatCluster.id && this.clusterServers.has(cluster.id))
-            return;
+            this.subType = 'AutoModeThermostat';
+        const behavior = MatterbridgeEndpoint.getBehaviourTypeFromClusterServerId(cluster.id, this.subType);
         this.clusterServers.set(cluster.id, cluster);
         if (cluster.id === BasicInformationCluster.id)
             return;

package/dist/matterbridgePlatform.js

@@ -1,5 +1,7 @@
 import { MatterbridgeDevice } from './matterbridgeDevice.js';
+import { CYAN, nf, wr } from 'node-ansi-logger';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+import { isValidArray, isValidObject } from './utils/utils.js';
 export class MatterbridgePlatform {
     matterbridge;
     log;
@@ -39,13 +41,16 @@ export class MatterbridgePlatform {
             await this.matterbridge.removeBridgedEndpoint(this.name, device);
     }
     async unregisterAllDevices() {
-        await this.matterbridge.removeAllBridgedDevices(this.name);
+        if (this.matterbridge.edge)
+            await this.matterbridge.removeAllBridgedEndpoints(this.name);
+        else
+            await this.matterbridge.removeAllBridgedDevices(this.name);
     }
     verifyMatterbridgeVersion(requiredVersion) {
         const compareVersions = (matterbridgeVersion, requiredVersion) => {
             const stripTag = (v) => {
                 const parts = v.split('-');
-                return parts.length > 0 ? parts[0] : v;
+                return parts[0];
             };
             const v1Parts = stripTag(matterbridgeVersion).split('.').map(Number);
             const v2Parts = stripTag(requiredVersion).split('.').map(Number);
@@ -65,4 +70,26 @@ export class MatterbridgePlatform {
             return false;
         return true;
     }
+    validateDeviceWhiteBlackList(device) {
+        if (isValidArray(this.config.whiteList, 1) && !this.config.whiteList.includes(device)) {
+            this.log.info(`Skipping device ${CYAN}${device}${nf} because not in whitelist`);
+            return false;
+        }
+        if (isValidArray(this.config.blackList, 1) && this.config.blackList.includes(device)) {
+            this.log.info(`Skipping device ${CYAN}${device}${nf} because in blacklist`);
+            return false;
+        }
+        return true;
+    }
+    validateEntityBlackList(device, entity) {
+        if (isValidArray(this.config.entityBlackList, 1) && this.config.entityBlackList.find((e) => e === entity)) {
+            this.log.info(`Skipping entity ${CYAN}${entity}${nf} because in entityBlackList`);
+            return false;
+        }
+        if (isValidObject(this.config.deviceEntityBlackList, 1) && device in this.config.deviceEntityBlackList && this.config.deviceEntityBlackList[device].includes(entity)) {
+            this.log.info(`Skipping entity ${CYAN}${entity}${wr} for device ${CYAN}${device}${nf} because in deviceEntityBlackList`);
+            return false;
+        }
+        return true;
+    }
 }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "1.6.6-dev.1",
+  "version": "1.6.6-dev.3",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "1.6.6-dev.1",
+      "version": "1.6.6-dev.3",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.11.8",
@@ -945,13 +945,10 @@
       }
     },
     "node_modules/gopd": {
-      "version": "1.1.0",
-      "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.1.0.tgz",
-      "integrity": "sha512-FQoVQnqcdk4hVM4JN1eromaun4iuS34oStkdlLENLdpULsuQcTyXj8w7ayhuUfPwEYZ1ZOooOTT6fdA9Vmx/RA==",
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz",
+      "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==",
       "license": "MIT",
-      "dependencies": {
-        "get-intrinsic": "^1.2.4"
-      },
       "engines": {
         "node": ">= 0.4"
       },

package/package.json

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