matterbridge-example-dynamic-platform 1.2.0-edge.8 → 1.2.0-edge.9

package/CHANGELOG.md

@@ -8,12 +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>
 
-## [1.2.0] - 2025-04-08
+## [1.2.0] - 2025-04-??
 
 ### Added
 
 - [platform]: Added Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and Apple Home).
-- [platform]: Added Laundry Washer deice (supported by SmartThings, Alexa and Home Assistant).
+- [platform]: Added Laundry Washer device (supported by SmartThings, Alexa and Home Assistant).
 - [platform]: Added Dishwasher device (supported by SmartThings, Alexa and Home Assistant).
 - [platform]: Added Temperature Controlled Cabinet Cooler device (supported by SmartThings, Alexa and Home Assistant).
 - [platform]: Added Temperature Controlled Cabinet Heater device (supported by SmartThings, Alexa and Home Assistant).

package/dist/robot.js

@@ -1,8 +1,8 @@
-import { Matterbridge, MatterbridgeServer, MatterbridgeEndpoint, roboticVacuumCleaner } from 'matterbridge';
-import { LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, EndpointServer, logEndpoint, DeviceTypeId, VendorId } from 'matterbridge/matter';
+import { Matterbridge, MatterbridgeServer, MatterbridgeEndpoint, roboticVacuumCleaner, bridge, EndpointNumber, onOffOutlet } from 'matterbridge';
+import { LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, EndpointServer, logEndpoint, DeviceTypeId, VendorId, } from 'matterbridge/matter';
 import { Status } from 'matterbridge/matter/types';
-import { OperationalState, PowerSource, RvcRunMode, RvcCleanMode, RvcOperationalState, ServiceArea } from 'matterbridge/matter/clusters';
-import { RvcCleanModeBehavior, RvcOperationalStateBehavior, RvcRunModeBehavior, ServiceAreaBehavior } from 'matterbridge/matter/behaviors';
+import { OperationalState, PowerSource, RvcRunMode, RvcCleanMode, RvcOperationalState, ServiceArea, Actions } from 'matterbridge/matter/clusters';
+import { ActionsServer, RvcCleanModeBehavior, RvcOperationalStateBehavior, RvcRunModeBehavior, ServiceAreaBehavior } from 'matterbridge/matter/behaviors';
 import { AnsiLogger } from 'matterbridge/logger';
 export class Robot extends MatterbridgeEndpoint {
     constructor(name, serial) {
@@ -68,11 +68,11 @@ export class Robot extends MatterbridgeEndpoint {
         });
         return this;
     }
-    createDefaultRvcOperationalStateClusterServer() {
+    createDefaultRvcOperationalStateClusterServer(phaseList = null, currentPhase = null, operationalStateList, operationalState, operationalError) {
         this.behaviors.require(MatterbridgeRvcOperationalStateServer, {
-            phaseList: [],
-            currentPhase: null,
-            operationalStateList: [
+            phaseList,
+            currentPhase,
+            operationalStateList: operationalStateList ?? [
                 { operationalStateId: RvcOperationalState.OperationalState.Stopped, operationalStateLabel: 'Stopped' },
                 { operationalStateId: RvcOperationalState.OperationalState.Running, operationalStateLabel: 'Running' },
                 { operationalStateId: RvcOperationalState.OperationalState.Paused, operationalStateLabel: 'Paused' },
@@ -81,8 +81,8 @@ export class Robot extends MatterbridgeEndpoint {
                 { operationalStateId: RvcOperationalState.OperationalState.Charging, operationalStateLabel: 'Charging' },
                 { operationalStateId: RvcOperationalState.OperationalState.Docked, operationalStateLabel: 'Docked' },
             ],
-            operationalState: RvcOperationalState.OperationalState.Docked,
-            operationalError: { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' },
+            operationalState: operationalState ?? RvcOperationalState.OperationalState.Docked,
+            operationalError: operationalError ?? { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' },
         });
         return this;
     }
@@ -100,6 +100,8 @@ export class MatterbridgeServiceAreaServer extends ServiceAreaBehavior {
             }
         }
         this.state.selectedAreas = newAreas;
+        this.state.currentArea = newAreas[0];
+        device.log.info(`***MatterbridgeServiceAreaServer selectAreas called with: ${newAreas.map((area) => area.toString()).join(', ')}`);
         return { status: ServiceArea.SelectAreasStatus.Success, statusText: 'Succesfully selected new areas' };
     }
 }
@@ -186,6 +188,13 @@ export class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateBe
         };
     }
 }
+function createEndpointActionsClusterServer(endpoint, endpointLists) {
+    endpoint.behaviors.require(ActionsServer, {
+        actionList: [],
+        endpointLists,
+    });
+    return endpoint;
+}
 if (process.argv.includes('-testRobot')) {
     const matterbridge = await Matterbridge.loadInstance(false);
     matterbridge.log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4, logLevel: "debug" });
@@ -196,12 +205,30 @@ if (process.argv.includes('-testRobot')) {
     matterbridge.environment.vars.set('runtime.exitcode', true);
     matterbridge.environment.vars.set('mdns.networkInterface', 'Wi-Fi');
     await matterbridge.startMatterStorage();
-    const deviceType = roboticVacuumCleaner;
-    const context = await matterbridge.createServerNodeContext('Jest', deviceType.name, DeviceTypeId(deviceType.code), VendorId(0xfff1), 'Matterbridge', 0x8000, 'Matterbridge device');
-    const server = await matterbridge.createServerNode(context);
+    const deviceType = bridge;
+    const context = await matterbridge.createServerNodeContext('Matterbridge', deviceType.name, DeviceTypeId(deviceType.code), VendorId(0xfff1), 'Matterbridge', 0x8000, 'Matterbridge device');
+    const server = (await matterbridge.createServerNode(context));
+    const aggregator = (await matterbridge.createAggregatorNode(context));
+    createEndpointActionsClusterServer(aggregator, [
+        {
+            endpointListId: 1,
+            name: 'Living room',
+            type: Actions.EndpointListType.Room,
+            endpoints: [EndpointNumber(2)],
+        },
+    ]);
+    await server.add(aggregator);
+    const outlet = new MatterbridgeEndpoint(onOffOutlet, { uniqueStorageKey: 'Outlet' }, true)
+        .createDefaultIdentifyClusterServer()
+        .createDefaultBridgedDeviceBasicInformationClusterServer('Outlet', '99914248654', 0xfff1, 'Matterbridge', 'Matterbridge Outlet')
+        .createDefaultOnOffClusterServer()
+        .createDefaultGroupsClusterServer()
+        .createDefaultPowerSourceRechargeableBatteryClusterServer(80, PowerSource.BatChargeLevel.Ok, 5900)
+        .addRequiredClusterServers();
+    await aggregator.add(outlet);
     const device = new Robot('Robot Vacuum', '99914248654');
-    await server.add(device);
-    logEndpoint(EndpointServer.forEndpoint(device));
+    await aggregator.add(device);
     await matterbridge.startServerNode(server);
     logEndpoint(EndpointServer.forEndpoint(server));
+    matterbridge.log.info(`Matterbridge server started. ServerNode id ${server.id}-${server.number}. Aggregator id ${aggregator.id}-${aggregator.number}. Device id ${device.id}-${device.number}.`);
 }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.0-edge.8",
+  "version": "1.2.0-edge.9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.2.0-edge.8",
+      "version": "1.2.0-edge.9",
       "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.8",
+  "version": "1.2.0-edge.9",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "MIT",