matterbridge-example-dynamic-platform 1.2.0-edge.10 → 1.2.0-edge.11

package/dist/appliances.js

@@ -1,13 +1,14 @@
-import { MatterbridgeEndpoint, MatterbridgeServer, MatterbridgeOnOffServer, RefrigeratorTag, PositionTag, laundryWasher, laundryDryer, dishwasher, refrigerator, temperatureControlledCabinetCooler, oven, temperatureControlledCabinetHeater, microwaveOven, extractorHood, cooktop, cookSurface, } from 'matterbridge';
+import { MatterbridgeEndpoint, MatterbridgeServer, MatterbridgeOnOffServer, RefrigeratorTag, PositionTag, laundryWasher, laundryDryer, dishwasher, refrigerator, temperatureControlledCabinetCooler, oven, temperatureControlledCabinetHeater, microwaveOven, extractorHood, cooktop, cookSurface, powerSource, } from 'matterbridge';
 import { ClusterBehavior } from 'matterbridge/matter';
 import { OperationalState, TemperatureControl, DishwasherMode, LaundryWasherControls, LaundryWasherMode, LaundryDryerControls, OvenMode, ModeBase, RefrigeratorAndTemperatureControlledCabinetMode, MicrowaveOvenMode, MicrowaveOvenControl, OvenCavityOperationalState, } from 'matterbridge/matter/clusters';
 import { DishwasherAlarmServer, LaundryDryerControlsServer, LaundryWasherControlsServer, MicrowaveOvenControlBehavior, MicrowaveOvenModeServer, OperationalStateBehavior, TemperatureControlBehavior, } from 'matterbridge/matter/behaviors';
 export class Appliances extends MatterbridgeEndpoint {
     constructor(deviceType, name, serial) {
-        super(deviceType, { uniqueStorageKey: `${name}-${serial}` }, true);
+        super([deviceType, powerSource], { uniqueStorageKey: `${name}-${serial}` }, true);
         if (deviceType.code === laundryWasher.code) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Laundry Washer');
+            this.createDefaultPowerSourceWiredClusterServer();
             this.createDeadFrontOnOffClusterServer();
             this.createLevelTemperatureControlClusterServer(3, ['Cold', '30°', '40°', '60°', '80°']);
             this.createDefaultLaundryWasherModeClusterServer();
@@ -17,6 +18,7 @@ export class Appliances extends MatterbridgeEndpoint {
         else if (deviceType.code === laundryDryer.code) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Laundry Dryer');
+            this.createDefaultPowerSourceWiredClusterServer();
             this.createDeadFrontOnOffClusterServer();
             this.createLevelTemperatureControlClusterServer(3, ['Cold', '30°', '40°', '60°', '80°']);
             this.createDefaultLaundryWasherModeClusterServer();
@@ -26,6 +28,7 @@ export class Appliances extends MatterbridgeEndpoint {
         else if (deviceType.code === dishwasher.code) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Dishwasher');
+            this.createDefaultPowerSourceWiredClusterServer();
             this.createDeadFrontOnOffClusterServer();
             this.createLevelTemperatureControlClusterServer(1, ['Cold', '30°', '40°', '60°']);
             this.createDefaultDishwasherModeClusterServer();
@@ -35,6 +38,7 @@ export class Appliances extends MatterbridgeEndpoint {
         else if (deviceType.name === refrigerator.name) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Refrigerator');
+            this.createDefaultPowerSourceWiredClusterServer();
             const refrigerator = this.addChildDeviceType('Refrigerator', temperatureControlledCabinetCooler, { tagList: [{ mfgCode: null, namespaceId: RefrigeratorTag.Refrigerator.namespaceId, tag: RefrigeratorTag.Refrigerator.tag, label: RefrigeratorTag.Refrigerator.label }] }, true);
             refrigerator.log.logName = `Refrigerator (cabinet Refrigerator)`;
             refrigerator.createDefaultIdentifyClusterServer();
@@ -51,6 +55,7 @@ export class Appliances extends MatterbridgeEndpoint {
         else if (deviceType.name === oven.name) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Oven');
+            this.createDefaultPowerSourceWiredClusterServer();
             const cabinettop = this.addChildDeviceType('Oven (top)', temperatureControlledCabinetHeater, { tagList: [{ mfgCode: null, namespaceId: PositionTag.Top.namespaceId, tag: PositionTag.Top.tag, label: PositionTag.Top.label }] }, true);
             cabinettop.log.logName = `Oven (top)`;
             cabinettop.createDefaultIdentifyClusterServer();
@@ -67,6 +72,7 @@ export class Appliances extends MatterbridgeEndpoint {
         else if (deviceType.name === microwaveOven.name) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Microwave Oven');
+            this.createDefaultPowerSourceWiredClusterServer();
             this.createDefaultOperationalStateClusterServer(OperationalState.OperationalStateEnum.Stopped);
             this.createDefaultMicrowaveOvenModeClusterServer();
             this.createDefaultMicrowaveOvenControlClusterServer();
@@ -74,6 +80,7 @@ export class Appliances extends MatterbridgeEndpoint {
         else if (deviceType.name === extractorHood.name) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Extractor Hood');
+            this.createDefaultPowerSourceWiredClusterServer();
             this.createBaseFanControlClusterServer();
             this.createDefaultHepaFilterMonitoringClusterServer();
             this.createDefaultActivatedCarbonFilterMonitoringClusterServer();
@@ -81,6 +88,7 @@ export class Appliances extends MatterbridgeEndpoint {
         else if (deviceType.name === cooktop.name) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Cooktop');
+            this.createDefaultPowerSourceWiredClusterServer();
             this.createOffOnlyOnOffClusterServer(true);
             const cookSurface1 = this.addChildDeviceType('Surface 1', cookSurface, { tagList: [{ mfgCode: null, namespaceId: PositionTag.Left.namespaceId, tag: PositionTag.Left.tag, label: PositionTag.Left.label }] }, true);
             cookSurface1.log.logName = `Cook surface (right)`;

package/dist/platform.js

@@ -738,8 +738,9 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.valve?.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
             this.valve?.log.info(`Command identify called identifyTime:${identifyTime}`);
         });
-        this.fan = new MatterbridgeEndpoint([fanDevice, bridgedNode], { uniqueStorageKey: 'Fan' }, this.config.debug)
+        this.fan = new MatterbridgeEndpoint([fanDevice, bridgedNode, powerSource], { uniqueStorageKey: 'Fan' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Fan', 'serial_980545631228', 0xfff1, 'Matterbridge', 'Matterbridge Fan', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
+            .createDefaultPowerSourceWiredClusterServer()
             .addRequiredClusterServers();
         this.setSelectDevice(this.fan.serialNumber ?? '', this.fan.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(this.fan.deviceName ?? '')) {
@@ -786,8 +787,9 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             if (isValidNumber(newValue, 0, 100))
                 await this.fan?.setAttribute(FanControl.Cluster.id, 'speedCurrent', newValue, this.fan?.log);
         }, this.fan.log);
-        this.waterLeak = new MatterbridgeEndpoint([waterLeakDetector, bridgedNode], { uniqueStorageKey: 'Water leak detector' }, this.config.debug)
+        this.waterLeak = new MatterbridgeEndpoint([waterLeakDetector, bridgedNode, powerSource], { uniqueStorageKey: 'Water leak detector' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Water leak detector', 'serial_98745631222', 0xfff1, 'Matterbridge', 'Matterbridge WaterLeakDetector', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
+            .createDefaultPowerSourceRechargeableBatteryClusterServer()
             .createDefaultBooleanStateClusterServer(false)
             .addRequiredClusterServers()
             .addOptionalClusterServers();
@@ -799,8 +801,9 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         else {
             this.waterLeak = undefined;
         }
-        this.waterFreeze = new MatterbridgeEndpoint([waterFreezeDetector, bridgedNode], { uniqueStorageKey: 'Water freeze detector' }, this.config.debug)
+        this.waterFreeze = new MatterbridgeEndpoint([waterFreezeDetector, bridgedNode, powerSource], { uniqueStorageKey: 'Water freeze detector' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Water freeze detector', 'serial_98745631223', 0xfff1, 'Matterbridge', 'Matterbridge WaterFreezeDetector', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
+            .createDefaultPowerSourceRechargeableBatteryClusterServer()
             .createDefaultBooleanStateClusterServer(false)
             .addRequiredClusterServers()
             .addOptionalClusterServers();
@@ -812,8 +815,9 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         else {
             this.waterFreeze = undefined;
         }
-        this.rain = new MatterbridgeEndpoint([rainSensor, bridgedNode], { uniqueStorageKey: 'Rain sensor' }, this.config.debug)
+        this.rain = new MatterbridgeEndpoint([rainSensor, bridgedNode, powerSource], { uniqueStorageKey: 'Rain sensor' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Rain sensor', 'serial_98745631224', 0xfff1, 'Matterbridge', 'Matterbridge RainSensor', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
+            .createDefaultPowerSourceRechargeableBatteryClusterServer()
             .createDefaultIdentifyClusterServer()
             .createDefaultBooleanStateClusterServer(false)
             .createDefaultBooleanStateConfigurationClusterServer();
@@ -825,10 +829,11 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         else {
             this.rain = undefined;
         }
-        this.smokeCo = new MatterbridgeEndpoint([smokeCoAlarm, bridgedNode], { uniqueStorageKey: 'SmokeCo alarm sensor' }, this.config.debug)
+        this.smokeCo = new MatterbridgeEndpoint([smokeCoAlarm, bridgedNode, powerSource], { uniqueStorageKey: 'SmokeCo alarm sensor' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('SmokeCo alarm sensor', 'serial_94745631225', 0xfff1, 'Matterbridge', 'Matterbridge SmokeCoAlarm', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
             .createDefaultIdentifyClusterServer()
-            .createDefaultSmokeCOAlarmClusterServer(SmokeCoAlarm.AlarmState.Normal, SmokeCoAlarm.AlarmState.Normal);
+            .createDefaultSmokeCOAlarmClusterServer(SmokeCoAlarm.AlarmState.Normal, SmokeCoAlarm.AlarmState.Normal)
+            .createDefaultPowerSourceReplaceableBatteryClusterServer();
         if (this.config.enableConcentrationMeasurements === true)
             this.smokeCo.createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(100);
         this.setSelectDevice(this.smokeCo.serialNumber ?? '', this.smokeCo.deviceName ?? '', undefined, 'hub');
@@ -839,10 +844,11 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         else {
             this.smokeCo = undefined;
         }
-        this.smokeOnly = new MatterbridgeEndpoint([smokeCoAlarm, bridgedNode], { uniqueStorageKey: 'Smoke only SmokeCo alarm sensor' }, this.config.debug)
-            .createDefaultBridgedDeviceBasicInformationClusterServer('Smoke only SmokeCo alarm sensor', 'serial_94755661225', 0xfff1, 'Matterbridge', 'Matterbridge SmokeCoAlarm', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
+        this.smokeOnly = new MatterbridgeEndpoint([smokeCoAlarm, bridgedNode, powerSource], { uniqueStorageKey: 'Smoke alarm sensor' }, this.config.debug)
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Smoke alarm sensor', 'serial_94755661225', 0xfff1, 'Matterbridge', 'Matterbridge SmokeCoAlarm', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
             .createDefaultIdentifyClusterServer()
-            .createSmokeOnlySmokeCOAlarmClusterServer(SmokeCoAlarm.AlarmState.Normal);
+            .createSmokeOnlySmokeCOAlarmClusterServer(SmokeCoAlarm.AlarmState.Normal)
+            .createDefaultPowerSourceReplaceableBatteryClusterServer();
         this.setSelectDevice(this.smokeOnly.serialNumber ?? '', this.smokeOnly.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(this.smokeOnly.deviceName ?? '')) {
             await this.registerDevice(this.smokeOnly);
@@ -851,10 +857,11 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         else {
             this.smokeOnly = undefined;
         }
-        this.coOnly = new MatterbridgeEndpoint([smokeCoAlarm, bridgedNode], { uniqueStorageKey: 'Co only SmokeCo alarm sensor' }, this.config.debug)
-            .createDefaultBridgedDeviceBasicInformationClusterServer('Co only SmokeCo alarm sensor', 'serial_947456317488', 0xfff1, 'Matterbridge', 'Matterbridge SmokeCoAlarm', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
+        this.coOnly = new MatterbridgeEndpoint([smokeCoAlarm, bridgedNode, powerSource], { uniqueStorageKey: 'Co alarm sensor' }, this.config.debug)
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Co alarm sensor', 'serial_947456317488', 0xfff1, 'Matterbridge', 'Matterbridge SmokeCoAlarm', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
             .createDefaultIdentifyClusterServer()
-            .createCoOnlySmokeCOAlarmClusterServer(SmokeCoAlarm.AlarmState.Normal);
+            .createCoOnlySmokeCOAlarmClusterServer(SmokeCoAlarm.AlarmState.Normal)
+            .createDefaultPowerSourceReplaceableBatteryClusterServer();
         if (this.config.enableConcentrationMeasurements === true)
             this.coOnly.createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(100);
         this.setSelectDevice(this.coOnly.serialNumber ?? '', this.coOnly.deviceName ?? '', undefined, 'hub');
@@ -865,8 +872,9 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         else {
             this.coOnly = undefined;
         }
-        this.airQuality = new MatterbridgeEndpoint([airQualitySensor, bridgedNode], { uniqueStorageKey: 'Air quality sensor' }, this.config.debug)
+        this.airQuality = new MatterbridgeEndpoint([airQualitySensor, bridgedNode, powerSource], { uniqueStorageKey: 'Air quality sensor' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Air quality sensor', 'serial_987484318322', 0xfff1, 'Matterbridge', 'Matterbridge Air Quality Sensor', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
+            .createDefaultPowerSourceReplaceableBatteryClusterServer(50, PowerSource.BatChargeLevel.Warning, 2900, 'CR2450', 1)
             .addRequiredClusterServers()
             .addClusterServers([TemperatureMeasurement.Cluster.id, RelativeHumidityMeasurement.Cluster.id]);
         if (this.config.enableConcentrationMeasurements === true) {
@@ -940,12 +948,14 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             this.bridgedDevices.set(dishwasherDevice.deviceName ?? '', dishwasherDevice);
         }
         const refrigeratorDevice = new Appliances(refrigerator, 'Refrigerator', '9987654322');
+        refrigeratorDevice.addFixedLabel('composed', 'Refrigerator');
         this.setSelectDevice(refrigeratorDevice.serialNumber ?? '', refrigeratorDevice.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(refrigeratorDevice.deviceName ?? '')) {
             await this.registerDevice(refrigeratorDevice);
             this.bridgedDevices.set(refrigeratorDevice.deviceName ?? '', refrigeratorDevice);
         }
         const ovenDevice = new Appliances(oven, 'Oven', '1298867891');
+        ovenDevice.addFixedLabel('composed', 'Oven');
         this.setSelectDevice(ovenDevice.serialNumber ?? '', ovenDevice.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(ovenDevice.deviceName ?? '')) {
             await this.registerDevice(ovenDevice);
@@ -973,7 +983,6 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     async onConfigure() {
         await super.onConfigure();
         this.log.info('onConfigure called');
-        this.log.notice('<iframe width="500" height="500" src="https://www.youtube.com/embed/DLzxrzFCyOs?hl=en_US&version=3&rel=0&autoplay=1" frameborder="1" allowfullscreen></iframe>');
         await this.switch?.setAttribute(OnOff.Cluster.id, 'onOff', this.intervalOnOff, this.switch.log);
         await this.mountedOnOffSwitch?.setAttribute(OnOff.Cluster.id, 'onOff', this.intervalOnOff, this.mountedOnOffSwitch.log);
         this.switch?.log.info(`Set switch initial onOff to ${this.intervalOnOff}`);

package/matterbridge-example-dynamic-platform.schema.json

@@ -40,7 +40,7 @@
       "default": true
     },
     "enableConcentrationMeasurements": {
-      "description": "Enable the ConcentrationMeasurements in the Air Quality device and SmokeCoSensor devices (Apple Home 18.4 will discard these devices when enabled)",
+      "description": "Enable the ConcentrationMeasurements in the Air Quality device and SmokeCoSensor device (Apple Home 18.4 will discard these devices when enabled)",
       "type": "boolean",
       "default": true
     },

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.0-edge.10",
+  "version": "1.2.0-edge.11",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.2.0-edge.10",
+      "version": "1.2.0-edge.11",
       "license": "MIT",
       "dependencies": {
         "node-ansi-logger": "3.0.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.0-edge.10",
+  "version": "1.2.0-edge.11",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "MIT",