homebridge-solaxcloud-api 2.4.2 → 2.5.1

package/package.json

@@ -2,23 +2,24 @@
   "private": false,
   "displayName": "Homebridge Solax Cloud API",
   "name": "homebridge-solaxcloud-api",
-  "version": "2.4.2",
+  "type": "module",
+  "version": "2.5.1",
   "description": "Integrates solar production info using public Solax/QCells Cloud API into Homebridge accessories.",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git://github.com/AllMightySauron/homebride-solaxcloud-api.git"
+    "url": "git://github.com/AllMightySauron/homebridge-solaxcloud-api.git"
   },
   "bugs": {
-    "url": "https://github.com/AllMightySauron/homebride-solaxcloud-api/issues"
+    "url": "https://github.com/AllMightySauron/homebridge-solaxcloud-api/issues"
   },
   "engines": {
-    "node": ">=14.18.1",
-    "homebridge": ">=1.3.8"
+    "node": "^22 || ^24 || ^26",
+    "homebridge": ">=2.4.0"
   },
   "main": "dist/index.js",
   "scripts": {
-    "test": "mocha --exit --require ts-node/register test/**/*.test.ts",
+    "test": "tsx ./node_modules/mocha/bin/mocha.js --exit test/**/*.test.ts",
     "lint": "eslint src/**.ts --max-warnings=0",
     "watch": "npm run build && npm link && nodemon",
     "build": "rimraf ./dist && tsc",
@@ -27,29 +28,33 @@
   "keywords": [
     "homebridge",
     "homebridge-plugin",
+    "supports-matter",
+    "supports-hap",
     "solax",
     "qcells",
     "solaxcloud"
   ],
+  "peerDependencies": {
+    "homebridge": "^2.4.0"
+  },
   "dependencies": {
     "fakegato-history": "^0.6.7",
     "homebridge-lib": "^8.1.0",
-    "jshint": "^2.13.6",
     "string-hash-64": "^1.0.3",
     "sync-fetch": "^0.3.1",
     "solax-cloud-api": "^0.2.0"
   },
   "devDependencies": {
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^16.10.9",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
-    "eslint": "^8.0.1",
-    "homebridge": "^1.7.0",
-    "mocha": "^11.0.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.19.2",
+    "@typescript-eslint/eslint-plugin": "^8.72.1",
+    "@typescript-eslint/parser": "^8.72.1",
+    "eslint": "^8.57.1",
+    "homebridge": "^2.4.0",
+    "mocha": "^12.0.3",
     "nodemon": "^3.1.0",
     "rimraf": "^3.0.2",
-    "ts-node": "^10.3.0",
-    "typescript": "^4.4.4"
+    "tsx": "^4.23.15",
+    "typescript": "^5.9.3"
   }
 }

package/test/batteryAccessory.test.ts

@@ -1,7 +1,7 @@
-import assert = require('assert');
+import assert from 'assert';
 
-import { BATTERY_CHARGING_STATE, SolaxBatteryAccessory } from '../src/batteryAccessory';
-import { createApi, createLog } from './helpers';
+import { BATTERY_CHARGING_STATE, SolaxBatteryAccessory } from '../src/batteryAccessory.js';
+import { createApi, createLog } from './helpers.js';
 
 describe('SolaxBatteryAccessory', () => {
   it('keeps charge state getter in sync after updates', () => {

package/test/helpers.ts

@@ -1,10 +1,21 @@
-import { API, Logging } from 'homebridge';
-import { Characteristic, Service } from 'hap-nodejs';
+import { API, Logging, MatterAccessory, MatterAPI } from 'homebridge';
+import { Characteristic, Service, uuid } from '@homebridge/hap-nodejs';
+import { createRequire } from 'module';
 import os from 'os';
 import path from 'path';
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { CharacteristicEventTypes, Formats, Perms } = require('hap-nodejs');
+const require = createRequire(import.meta.url);
+const { CharacteristicEventTypes, Formats, Perms } = require('@homebridge/hap-nodejs');
+
+export interface MatterApiHarness {
+  api: MatterAPI;
+  registrations: MatterAccessory[][];
+  updates: Array<{
+    uuid: string;
+    cluster: string;
+    attributes: Record<string, unknown>;
+  }>;
+}
 
 export function createLog(): Logging {
   const noop = () => undefined;
@@ -19,7 +30,7 @@ export function createLog(): Logging {
   }) as unknown as Logging;
 }
 
-export function createApi(): API {
+export function createApi(matter?: MatterAPI): API {
   return {
     hap: {
       Characteristic,
@@ -27,10 +38,43 @@ export function createApi(): API {
       Formats,
       Perms,
       Service,
+      uuid,
     },
     on: () => undefined,
     user: {
       storagePath: () => path.join(os.tmpdir(), 'homebridge-solaxcloud-api-test'),
     },
+    matter,
   } as unknown as API;
 }
+
+export function createMatterApi(): MatterApiHarness {
+  const registrations: MatterAccessory[][] = [];
+  const updates: MatterApiHarness['updates'] = [];
+
+  const api = {
+    deviceTypes: {
+      ElectricalSensor: { name: 'ElectricalSensor' },
+    },
+    clusterNames: {
+      ElectricalPowerMeasurement: 'electricalPowerMeasurement',
+      ElectricalEnergyMeasurement: 'electricalEnergyMeasurement',
+    },
+    registerPlatformAccessories: async (
+      _pluginIdentifier: string,
+      _platformName: string,
+      accessories: MatterAccessory[],
+    ) => {
+      registrations.push(accessories);
+    },
+    updateAccessoryState: async (
+      uuid: string,
+      cluster: string,
+      attributes: Record<string, unknown>,
+    ) => {
+      updates.push({ uuid, cluster, attributes });
+    },
+  } as unknown as MatterAPI;
+
+  return { api, registrations, updates };
+}

package/test/lightSensorAccessory.test.ts

@@ -1,7 +1,7 @@
-import assert = require('assert');
+import assert from 'assert';
 
-import { SolaxLightSensorAccessory } from '../src/lightSensorAccessory';
-import { createApi, createLog } from './helpers';
+import { SolaxLightSensorAccessory } from '../src/lightSensorAccessory.js';
+import { createApi, createLog, createMatterApi } from './helpers.js';
 
 describe('SolaxLightSensorAccessory', () => {
   it('stores ambient light values and applies the HomeKit minimum', () => {
@@ -24,5 +24,50 @@ describe('SolaxLightSensorAccessory', () => {
     const sensor = new SolaxLightSensorAccessory(createLog(), createApi(), 'Light sensor', 'light-1', 'Model');
 
     assert.equal(sensor.getServices().length, 2);
+    assert.equal(sensor.isMatterAccessory(), false);
+  });
+
+  it('registers and updates a Matter electrical sensor', async () => {
+    const matter = createMatterApi();
+    const sensor = new SolaxLightSensorAccessory(
+      createLog(),
+      createApi(matter.api),
+      'Power sensor',
+      'power-1',
+      'Model',
+      true,
+    );
+
+    assert.equal(sensor.getServices().length, 1);
+    assert.equal(sensor.isMatterAccessory(), true);
+    assert.equal(matter.registrations.length, 1);
+
+    const accessory = matter.registrations[0][0];
+    assert.equal(accessory.deviceType, matter.api.deviceTypes.ElectricalSensor);
+    assert.deepEqual(accessory.clusters, {
+      electricalPowerMeasurement: { activePower: 0 },
+      electricalEnergyMeasurement: {
+        cumulativeEnergyExported: { energy: 0 },
+      },
+    });
+
+    sensor.setAmbientLightLevel(123.456);
+    sensor.setTotalEnergyConsumption(12.345);
+    await new Promise(resolve => setImmediate(resolve));
+
+    assert.deepEqual(matter.updates, [
+      {
+        uuid: accessory.UUID,
+        cluster: 'electricalPowerMeasurement',
+        attributes: { activePower: 123456 },
+      },
+      {
+        uuid: accessory.UUID,
+        cluster: 'electricalEnergyMeasurement',
+        attributes: {
+          cumulativeEnergyExported: { energy: 12345 },
+        },
+      },
+    ]);
   });
 });

package/test/motionAccessory.test.ts

@@ -1,7 +1,7 @@
-import assert = require('assert');
+import assert from 'assert';
 
-import { SolaxMotionAccessory } from '../src/motionAccessory';
-import { createApi, createLog } from './helpers';
+import { SolaxMotionAccessory } from '../src/motionAccessory.js';
+import { createApi, createLog } from './helpers.js';
 
 function sleep(millis: number): Promise<void> {
   return new Promise(resolve => setTimeout(resolve, millis));

package/test/outletAccessory.test.ts

@@ -1,6 +1,6 @@
-import assert = require('assert');
-import { SolaxOutletAccessory } from '../src/outletAccessory';
-import { createApi, createLog } from './helpers';
+import assert from 'assert';
+import { SolaxOutletAccessory } from '../src/outletAccessory.js';
+import { createApi, createLog } from './helpers.js';
 
 describe('SolaxOutletAccessory', () => {
   function withOutlet(test: (outlet: SolaxOutletAccessory) => void): void {

package/test/platformAccessory.test.ts

@@ -1,7 +1,7 @@
-import assert = require('assert');
+import assert from 'assert';
 
-import { SolaxPlatformAccessory } from '../src/platformAccessory';
-import { createApi, createLog } from './helpers';
+import { SolaxPlatformAccessory } from '../src/platformAccessory.js';
+import { createApi, createLog } from './helpers.js';
 
 describe('SolaxPlatformAccessory', () => {
   it('exposes normalized model and stable hashed serial information', () => {

package/test/platformConfig.test.ts

@@ -1,8 +1,8 @@
 import { Logging, PlatformConfig } from 'homebridge';
 
-import assert = require('assert');
+import assert from 'assert';
 
-import { SolaxCloudAPIPlatform } from '../src/platform';
+import { SolaxCloudAPIPlatform } from '../src/platform.js';
 
 interface TestLog extends Logging {
   errors: string[];

package/test/platformTotalizer.test.ts

@@ -1,10 +1,10 @@
 import { API, Logging, PlatformConfig } from 'homebridge';
 
-import assert = require('assert');
+import assert from 'assert';
 
-import { SolaxCloudAPIPlatform } from '../src/platform';
-import { SolaxCloudAPIPlatformInverter } from '../src/platformInverter';
-import { createApi, createLog } from './helpers';
+import { SolaxCloudAPIPlatform } from '../src/platform.js';
+import { SolaxCloudAPIPlatformInverter } from '../src/platformInverter.js';
+import { createApi, createLog, createMatterApi } from './helpers.js';
 
 interface InverterCreation {
   brand: number;
@@ -73,6 +73,66 @@ describe('SolaxCloudAPIPlatform totalizer inverter creation', () => {
     assert.equal(totalizer.hasBattery, true);
   });
 
+  it('publishes and updates applicable meters through Matter without requiring pureHomeApp', async () => {
+    const matter = createMatterApi();
+    const config = {
+      enableHistory: false,
+      pureHomeApp: false,
+      smoothMeters: true,
+      smoothingMethod: 'sma',
+    } as PlatformConfig;
+
+    const inverter = new SolaxCloudAPIPlatformInverter(
+      createLog(),
+      config,
+      createApi(matter.api),
+      0,
+      '',
+      'virtual',
+      'Virtual inverter',
+      false,
+      3,
+      true,
+    );
+
+    assert.equal(matter.registrations.length, 10);
+    assert.equal(inverter.getAccessories().length, 6);
+
+    inverter.setRawPower('inverterAC', 123.456);
+    inverter.setSmoothPower('inverterAC');
+    inverter.setRawEnergy('inverterAC', 12.345);
+    await new Promise(resolve => setImmediate(resolve));
+
+    assert.equal(matter.updates.filter(update =>
+      update.cluster === 'electricalPowerMeasurement' && update.attributes.activePower === 123456).length, 2);
+    assert.equal(matter.updates.some(update =>
+      update.cluster === 'electricalEnergyMeasurement'), true);
+  });
+
+  it('retains pureHomeApp as a non-Matter legacy fallback', () => {
+    const config = {
+      enableHistory: false,
+      pureHomeApp: true,
+      smoothMeters: false,
+      smoothingMethod: 'sma',
+    } as PlatformConfig;
+
+    const inverter = new SolaxCloudAPIPlatformInverter(
+      createLog(),
+      config,
+      createApi(),
+      0,
+      '',
+      'virtual',
+      'Virtual inverter',
+      false,
+      3,
+      true,
+    );
+
+    assert.equal(inverter.getAccessories().length, 11);
+  });
+
   it('creates a virtual totalizer with QCells as brand when all inverters use QCells', () => {
     createPlatform(createConfig(['qcells', 'qcells']));
 

package/test/statistics.test.ts

@@ -1,6 +1,6 @@
-import { Statistics } from '../src/statistics';
+import { Statistics } from '../src/statistics.js';
 
-import assert = require('assert');
+import assert from 'assert';
 
 describe('Statistics: Smoothing methods', () => {
   const sampleSeries = [1, 3, 5, 3, 7, 6, 8, 5, 8, 8, 4, 5];