homebridge-solaxcloud-api 2.4.1 → 2.5.0

package/test/platformConfig.test.ts

@@ -1,188 +1,188 @@
-import { Logging, PlatformConfig } from 'homebridge';
-
-import assert = require('assert');
-
-import { SolaxCloudAPIPlatform } from '../src/platform';
-
-interface TestLog extends Logging {
-  errors: string[];
-}
-
-function createLog(): TestLog {
-  const noop = () => undefined;
-  const log = Object.assign(noop, {
-    debug: noop,
-    info: noop,
-    warn: noop,
-    log: noop,
-    prefix: '',
-    errors: [] as string[],
-    error(message: string) {
-      this.errors.push(message);
-    },
-  }) as unknown as TestLog;
-
-  return log;
-}
-
-function createConfig(pollingFrequency = 300): PlatformConfig {
-  return {
-    platform: 'SolaxCloudAPI',
-    inverters: [
-      {
-        brand: 'solax',
-        tokenId: '20200722185111234567890',
-        name: 'Test inverter',
-        sn: 'ABCDEFGHIJ',
-      },
-    ],
-    pollingFrequency,
-  };
-}
-
-function createPlatformForConfigCheck(log: Logging): SolaxCloudAPIPlatform {
-  const platform = Object.create(SolaxCloudAPIPlatform.prototype);
-
-  platform.log = log;
-
-  return platform as SolaxCloudAPIPlatform;
-}
-
-describe('SolaxCloudAPIPlatform config checks', () => {
-  [
-    {
-      name: 'missing inverters',
-      config: { platform: 'SolaxCloudAPI' } as PlatformConfig,
-      error: 'mandatory parameter "inverters"',
-    },
-    {
-      name: 'non-array inverters',
-      config: { ...createConfig(), inverters: 'invalid' },
-      error: 'Incorrect type for mandatory parameter "inverters"',
-    },
-    {
-      name: 'inverter missing mandatory fields',
-      config: { ...createConfig(), inverters: [{ brand: 'solax', name: 'Test inverter', sn: 'ABCDEFGHIJ' }] },
-      error: 'Invalid type for inverter under "inverters"',
-    },
-    {
-      name: 'null inverter entry',
-      config: { ...createConfig(), inverters: [null] },
-      error: 'Invalid type for inverter under "inverters"',
-    },
-    {
-      name: 'unsupported inverter brand',
-      config: {
-        ...createConfig(),
-        inverters: [
-          {
-            brand: 'unsupported',
-            tokenId: '20200722185111234567890',
-            name: 'Test inverter',
-            sn: 'ABCDEFGHIJ',
-          },
-        ],
-      },
-      error: 'Invalid type for inverter under "inverters"',
-    },
-    {
-      name: 'duplicate inverter names',
-      config: {
-        ...createConfig(),
-        inverters: [
-          {
-            brand: 'solax',
-            tokenId: '20200722185111234567890',
-            name: 'Test inverter',
-            sn: 'ABCDEFGHIJ',
-          },
-          {
-            brand: 'qcells',
-            tokenId: '20200722185111234567891',
-            name: 'Test inverter',
-            sn: 'KLMNOPQRST',
-          },
-        ],
-      },
-      error: 'Duplicate inverter names',
-    },
-    {
-      name: 'duplicate inverter serial numbers',
-      config: {
-        ...createConfig(),
-        inverters: [
-          {
-            brand: 'solax',
-            tokenId: '20200722185111234567890',
-            name: 'Test inverter 1',
-            sn: 'ABCDEFGHIJ',
-          },
-          {
-            brand: 'qcells',
-            tokenId: '20200722185111234567891',
-            name: 'Test inverter 2',
-            sn: 'ABCDEFGHIJ',
-          },
-        ],
-      },
-      error: 'Duplicate inverter SNs',
-    },
-  ].forEach(testCase => {
-    it(`rejects invalid config: ${testCase.name}`, () => {
-      const log = createLog();
-      const platform = createPlatformForConfigCheck(log);
-
-      assert.equal(platform['checkConfig'](testCase.config as PlatformConfig), false);
-      assert.equal(log.errors.length, 1);
-      assert.match(log.errors[0], new RegExp(testCase.error));
-    });
-  });
-
-  it('rejects polling frequencies that would produce an empty smoothing window', () => {
-    const log = createLog();
-    const platform = createPlatformForConfigCheck(log);
-    const config = createConfig(901);
-
-    assert.throws(
-      () => platform['checkConfig'](config),
-      /Polling frequency cannot be higher than 900 seconds/,
-    );
-    assert.equal(log.errors.length, 1);
-  });
-
-  it('accepts the largest polling frequency that keeps one smoothing period', () => {
-    const log = createLog();
-    const platform = createPlatformForConfigCheck(log);
-    const config = createConfig(900);
-
-    assert.equal(platform['checkConfig'](config), true);
-    assert.equal(config.pollingFrequency, 900);
-  });
-
-  it('defaults history to enabled when not configured', () => {
-    const log = createLog();
-    const platform = createPlatformForConfigCheck(log);
-    const config = createConfig();
-
-    assert.equal(platform['checkConfig'](config), true);
-    assert.equal(config.enableHistory, true);
-  });
-
-  it('keeps history disabled when configured', () => {
-    const log = createLog();
-    const platform = createPlatformForConfigCheck(log);
-    const config = { ...createConfig(), enableHistory: false };
-
-    assert.equal(platform['checkConfig'](config), true);
-    assert.equal(config.enableHistory, false);
-  });
-
-  it('defaults invalid history config to enabled', () => {
-    const log = createLog();
-    const platform = createPlatformForConfigCheck(log);
-    const config = { ...createConfig(), enableHistory: 'invalid' };
-
-    assert.equal(platform['checkConfig'](config), true);
-    assert.equal(config.enableHistory, true);
-  });
-});
+import { Logging, PlatformConfig } from 'homebridge';
+
+import assert from 'assert';
+
+import { SolaxCloudAPIPlatform } from '../src/platform.js';
+
+interface TestLog extends Logging {
+  errors: string[];
+}
+
+function createLog(): TestLog {
+  const noop = () => undefined;
+  const log = Object.assign(noop, {
+    debug: noop,
+    info: noop,
+    warn: noop,
+    log: noop,
+    prefix: '',
+    errors: [] as string[],
+    error(message: string) {
+      this.errors.push(message);
+    },
+  }) as unknown as TestLog;
+
+  return log;
+}
+
+function createConfig(pollingFrequency = 300): PlatformConfig {
+  return {
+    platform: 'SolaxCloudAPI',
+    inverters: [
+      {
+        brand: 'solax',
+        tokenId: '20200722185111234567890',
+        name: 'Test inverter',
+        sn: 'ABCDEFGHIJ',
+      },
+    ],
+    pollingFrequency,
+  };
+}
+
+function createPlatformForConfigCheck(log: Logging): SolaxCloudAPIPlatform {
+  const platform = Object.create(SolaxCloudAPIPlatform.prototype);
+
+  platform.log = log;
+
+  return platform as SolaxCloudAPIPlatform;
+}
+
+describe('SolaxCloudAPIPlatform config checks', () => {
+  [
+    {
+      name: 'missing inverters',
+      config: { platform: 'SolaxCloudAPI' } as PlatformConfig,
+      error: 'mandatory parameter "inverters"',
+    },
+    {
+      name: 'non-array inverters',
+      config: { ...createConfig(), inverters: 'invalid' },
+      error: 'Incorrect type for mandatory parameter "inverters"',
+    },
+    {
+      name: 'inverter missing mandatory fields',
+      config: { ...createConfig(), inverters: [{ brand: 'solax', name: 'Test inverter', sn: 'ABCDEFGHIJ' }] },
+      error: 'Invalid type for inverter under "inverters"',
+    },
+    {
+      name: 'null inverter entry',
+      config: { ...createConfig(), inverters: [null] },
+      error: 'Invalid type for inverter under "inverters"',
+    },
+    {
+      name: 'unsupported inverter brand',
+      config: {
+        ...createConfig(),
+        inverters: [
+          {
+            brand: 'unsupported',
+            tokenId: '20200722185111234567890',
+            name: 'Test inverter',
+            sn: 'ABCDEFGHIJ',
+          },
+        ],
+      },
+      error: 'Invalid type for inverter under "inverters"',
+    },
+    {
+      name: 'duplicate inverter names',
+      config: {
+        ...createConfig(),
+        inverters: [
+          {
+            brand: 'solax',
+            tokenId: '20200722185111234567890',
+            name: 'Test inverter',
+            sn: 'ABCDEFGHIJ',
+          },
+          {
+            brand: 'qcells',
+            tokenId: '20200722185111234567891',
+            name: 'Test inverter',
+            sn: 'KLMNOPQRST',
+          },
+        ],
+      },
+      error: 'Duplicate inverter names',
+    },
+    {
+      name: 'duplicate inverter serial numbers',
+      config: {
+        ...createConfig(),
+        inverters: [
+          {
+            brand: 'solax',
+            tokenId: '20200722185111234567890',
+            name: 'Test inverter 1',
+            sn: 'ABCDEFGHIJ',
+          },
+          {
+            brand: 'qcells',
+            tokenId: '20200722185111234567891',
+            name: 'Test inverter 2',
+            sn: 'ABCDEFGHIJ',
+          },
+        ],
+      },
+      error: 'Duplicate inverter SNs',
+    },
+  ].forEach(testCase => {
+    it(`rejects invalid config: ${testCase.name}`, () => {
+      const log = createLog();
+      const platform = createPlatformForConfigCheck(log);
+
+      assert.equal(platform['checkConfig'](testCase.config as PlatformConfig), false);
+      assert.equal(log.errors.length, 1);
+      assert.match(log.errors[0], new RegExp(testCase.error));
+    });
+  });
+
+  it('rejects polling frequencies that would produce an empty smoothing window', () => {
+    const log = createLog();
+    const platform = createPlatformForConfigCheck(log);
+    const config = createConfig(901);
+
+    assert.throws(
+      () => platform['checkConfig'](config),
+      /Polling frequency cannot be higher than 900 seconds/,
+    );
+    assert.equal(log.errors.length, 1);
+  });
+
+  it('accepts the largest polling frequency that keeps one smoothing period', () => {
+    const log = createLog();
+    const platform = createPlatformForConfigCheck(log);
+    const config = createConfig(900);
+
+    assert.equal(platform['checkConfig'](config), true);
+    assert.equal(config.pollingFrequency, 900);
+  });
+
+  it('defaults history to enabled when not configured', () => {
+    const log = createLog();
+    const platform = createPlatformForConfigCheck(log);
+    const config = createConfig();
+
+    assert.equal(platform['checkConfig'](config), true);
+    assert.equal(config.enableHistory, true);
+  });
+
+  it('keeps history disabled when configured', () => {
+    const log = createLog();
+    const platform = createPlatformForConfigCheck(log);
+    const config = { ...createConfig(), enableHistory: false };
+
+    assert.equal(platform['checkConfig'](config), true);
+    assert.equal(config.enableHistory, false);
+  });
+
+  it('defaults invalid history config to enabled', () => {
+    const log = createLog();
+    const platform = createPlatformForConfigCheck(log);
+    const config = { ...createConfig(), enableHistory: 'invalid' };
+
+    assert.equal(platform['checkConfig'](config), true);
+    assert.equal(config.enableHistory, true);
+  });
+});

package/test/platformTotalizer.test.ts

@@ -1,97 +1,123 @@
-import { API, Logging, PlatformConfig } from 'homebridge';
-
-import assert = require('assert');
-
-import { SolaxCloudAPIPlatform } from '../src/platform';
-import { SolaxCloudAPIPlatformInverter } from '../src/platformInverter';
-import { createApi, createLog } from './helpers';
-
-interface InverterCreation {
-  brand: number;
-  tokenId: string;
-  sn: string;
-  name: string;
-  hasBattery: boolean;
-  smoothingWindow: number;
-  virtual: boolean;
-  brandName?: string;
-}
-
-let inverterCreations: InverterCreation[] = [];
-
-class TestSolaxCloudAPIPlatform extends SolaxCloudAPIPlatform {
-  protected createPlatformInverter(log: Logging, config: PlatformConfig, api: API,
-    brand: number, tokenId: string, sn: string,
-    name: string, hasBattery: boolean,
-    smoothingWindow: number,
-    virtual = false,
-    brandName?: string): SolaxCloudAPIPlatformInverter {
-    inverterCreations.push({ brand, tokenId, sn, name, hasBattery, smoothingWindow, virtual, brandName });
-
-    return {
-      getAccessories: () => [],
-      hasBattery: () => hasBattery,
-    } as unknown as SolaxCloudAPIPlatformInverter;
-  }
-
-  protected async fetchDataPeriodically(): Promise<void> {
-    return;
-  }
-}
-
-function createConfig(brands: string[]): PlatformConfig {
-  return {
-    platform: 'SolaxCloudAPI',
-    pollingFrequency: 300,
-    inverters: brands.map((brand, index) => ({
-      brand,
-      tokenId: `2020072218511123456789${index}`,
-      name: `Test inverter ${index}`,
-      sn: `ABCDEFGHI${index}`,
-      hasBattery: index === 0,
-    })),
-  };
-}
-
-function createPlatform(config: PlatformConfig): void {
-  inverterCreations = [];
-
-  new TestSolaxCloudAPIPlatform(createLog(), config, createApi());
-}
-
-describe('SolaxCloudAPIPlatform totalizer inverter creation', () => {
-  it('creates a virtual totalizer without cloud credentials when all inverters use Solax', () => {
-    createPlatform(createConfig(['solax', 'solax']));
-
-    const totalizer = inverterCreations[2];
-
-    assert.equal(inverterCreations.length, 3);
-    assert.equal(totalizer.name, 'All inverters');
-    assert.equal(totalizer.tokenId, '');
-    assert.equal(totalizer.virtual, true);
-    assert.equal(totalizer.brandName, 'Solax');
-    assert.equal(totalizer.hasBattery, true);
-  });
-
-  it('creates a virtual totalizer with QCells as brand when all inverters use QCells', () => {
-    createPlatform(createConfig(['qcells', 'qcells']));
-
-    const totalizer = inverterCreations[2];
-
-    assert.equal(totalizer.name, 'All inverters');
-    assert.equal(totalizer.tokenId, '');
-    assert.equal(totalizer.virtual, true);
-    assert.equal(totalizer.brandName, 'QCells');
-  });
-
-  it('creates a virtual totalizer with mixed brand name when inverter brands differ', () => {
-    createPlatform(createConfig(['solax', 'qcells']));
-
-    const totalizer = inverterCreations[2];
-
-    assert.equal(totalizer.name, 'All inverters');
-    assert.equal(totalizer.tokenId, '');
-    assert.equal(totalizer.virtual, true);
-    assert.equal(totalizer.brandName, 'Solax/QCells');
-  });
-});
+import { API, Logging, PlatformConfig } from 'homebridge';
+
+import assert from 'assert';
+
+import { SolaxCloudAPIPlatform } from '../src/platform.js';
+import { SolaxCloudAPIPlatformInverter } from '../src/platformInverter.js';
+import { createApi, createLog, createMatterApi } from './helpers.js';
+
+interface InverterCreation {
+  brand: number;
+  tokenId: string;
+  sn: string;
+  name: string;
+  hasBattery: boolean;
+  smoothingWindow: number;
+  virtual: boolean;
+  brandName?: string;
+}
+
+let inverterCreations: InverterCreation[] = [];
+
+class TestSolaxCloudAPIPlatform extends SolaxCloudAPIPlatform {
+  protected createPlatformInverter(log: Logging, config: PlatformConfig, api: API,
+    brand: number, tokenId: string, sn: string,
+    name: string, hasBattery: boolean,
+    smoothingWindow: number,
+    virtual = false,
+    brandName?: string): SolaxCloudAPIPlatformInverter {
+    inverterCreations.push({ brand, tokenId, sn, name, hasBattery, smoothingWindow, virtual, brandName });
+
+    return {
+      getAccessories: () => [],
+      hasBattery: () => hasBattery,
+    } as unknown as SolaxCloudAPIPlatformInverter;
+  }
+
+  protected async fetchDataPeriodically(): Promise<void> {
+    return;
+  }
+}
+
+function createConfig(brands: string[]): PlatformConfig {
+  return {
+    platform: 'SolaxCloudAPI',
+    pollingFrequency: 300,
+    inverters: brands.map((brand, index) => ({
+      brand,
+      tokenId: `2020072218511123456789${index}`,
+      name: `Test inverter ${index}`,
+      sn: `ABCDEFGHI${index}`,
+      hasBattery: index === 0,
+    })),
+  };
+}
+
+function createPlatform(config: PlatformConfig): void {
+  inverterCreations = [];
+
+  new TestSolaxCloudAPIPlatform(createLog(), config, createApi());
+}
+
+describe('SolaxCloudAPIPlatform totalizer inverter creation', () => {
+  it('creates a virtual totalizer without cloud credentials when all inverters use Solax', () => {
+    createPlatform(createConfig(['solax', 'solax']));
+
+    const totalizer = inverterCreations[2];
+
+    assert.equal(inverterCreations.length, 3);
+    assert.equal(totalizer.name, 'All inverters');
+    assert.equal(totalizer.tokenId, '');
+    assert.equal(totalizer.virtual, true);
+    assert.equal(totalizer.brandName, 'Solax');
+    assert.equal(totalizer.hasBattery, true);
+  });
+
+  it('publishes only applicable meters through Matter', () => {
+    const matter = createMatterApi();
+    const config = {
+      enableHistory: false,
+      pureHomeApp: true,
+      smoothMeters: false,
+      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, 5);
+    assert.equal(inverter.getAccessories().length, 6);
+  });
+
+  it('creates a virtual totalizer with QCells as brand when all inverters use QCells', () => {
+    createPlatform(createConfig(['qcells', 'qcells']));
+
+    const totalizer = inverterCreations[2];
+
+    assert.equal(totalizer.name, 'All inverters');
+    assert.equal(totalizer.tokenId, '');
+    assert.equal(totalizer.virtual, true);
+    assert.equal(totalizer.brandName, 'QCells');
+  });
+
+  it('creates a virtual totalizer with mixed brand name when inverter brands differ', () => {
+    createPlatform(createConfig(['solax', 'qcells']));
+
+    const totalizer = inverterCreations[2];
+
+    assert.equal(totalizer.name, 'All inverters');
+    assert.equal(totalizer.tokenId, '');
+    assert.equal(totalizer.virtual, true);
+    assert.equal(totalizer.brandName, 'Solax/QCells');
+  });
+});