homebridge-solaxcloud-api 2.1.6 → 2.1.7

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v2.1.7] - 2022-05-03
+### Changes
+* Bumped dependencies.
+* Unit testing for multiple inverters.
+### Fixed
+* Documentation updates.
+
 ## [v2.1.6] - 2022-04-07
 ### Changes
 * Battery totals SoC updated to "All inverters".
@@ -13,11 +20,10 @@ All notable changes to this project will be documented in this file.
 * New inverter accessory **Battery** for State of Charge (SoC) information.
 * Support for battery charge level, charge state and low battery handler (<10%).
 
-
 ## [v2.1.4] - 2022-04-06
 ### Changed
 * Added "All inverters" virtual inverter for totalizing inverter figures for all sensors.
-* Preliminary battery support with **From Battery** and **To Battery** charge power ([#02]).
+* Preliminary battery support with **From Battery** and **To Battery** charge power ([#02](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/2)).
 
 ## [v2.1.2] - 2022-03-31
 ### Fixed
@@ -31,8 +37,8 @@ All notable changes to this project will be documented in this file.
 
 ## [v2.0.2] - 2022-01-24
 ### Changed
-* Added support for "pure" Home app accessories (power consumption displayed as Ambient Light Sensors) ([#01]).
-* Created option accessories to display smooth value from raw API data (minimizing sporadic events like a cloud passing).
+* Added support for "pure" Home app accessories (power consumption displayed as Ambient Light Sensors) ([#01](https://github.com/AllMightySauron/homebride-solaxcloud-api/issues/1)).
+* Created optional accessories to display smooth value from raw API data (minimizing sporadic events like a cloud passing).
 
 ## [v1.5.1] - 2022-01-08
 ### Fixed

package/README.md

@@ -13,7 +13,7 @@
 
 The Solax Cloud Plugin for [Homebridge](https://homebridge.io/) was created as a platform plugin to gather data exposed by Solax inverters to the cloud through the [Solax Cloud API](https://www.solaxcloud.com/phoebus/resource/files/userGuide/Solax_API.pdf). 
 
-Now with **support for multiple inverters**! Sensors will be created for each of the inverters present in the configuration. Additionally, a virtual inverter named "All inverters" will be created whenever a multiple inverters configuration is present. This inverter will present summarized power and consumption figures derived from data for all the physical inverters.
+Now with support for **multiple inverters**! Sensors will be created for each of the inverters present in the configuration. Additionally, a virtual inverter named "All inverters" will be created whenever a multiple inverters configuration is present. This inverter will present summarized power and consumption figures derived from data for all the physical inverters.
 
 As HomeKit is still clueless about what a solar panel is, this plugin exposes a set of standard HomeKit accessories though Homebridge for each configured inverter that will allow interacting and automating your smart home based on the data made available from the Solax platform:
 
@@ -190,4 +190,4 @@ Next planned plugin releases should include:
 - [x] Enable support for "pure" Home App accessories (power meters will be exposed as Ambient Light sensors)
 - [x] Add "smooth" accessories for power meters (compensating for sporadic scenarios like cloud a passing)
 - [x] Support for multiple inverters
-- [ ] Accessories for battery state and consumptions (work in progress)
+- [x] Accessories for battery state and consumptions

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "displayName": "Homebridge Solax Cloud API",
   "name": "homebridge-solaxcloud-api",
-  "version": "2.1.6",
+  "version": "2.1.7",
   "description": "Integrates solar production info using public Solax Cloud API into Homebridge accessories.",
   "license": "Apache-2.0",
   "repository": {
@@ -14,7 +14,7 @@
   },
   "engines": {
     "node": ">=14.18.1",
-    "homebridge": ">=1.3.5"
+    "homebridge": ">=1.3.8"
   },
   "main": "dist/index.js",
   "scripts": {
@@ -34,8 +34,8 @@
     "jshint": "^2.13.1",
     "sync-fetch": "^0.3.1",
     "string-hash-64": "^1.0.3",
-    "homebridge-lib": "^5.1.21",
-    "fakegato-history": "^0.6.2"
+    "homebridge-lib": "^5.4.0",
+    "fakegato-history": "^0.6.3"
   },
   "devDependencies": {
     "@types/mocha": "^9.0.0",

package/test/solaxcloudapi.test.ts

@@ -1,6 +1,6 @@
 import { SolaxCloudAPI, SolaxCloudAPIResponse } from '../src/solaxcloudapi';
 
-import assert = require('assert');
+import assert from 'assert';
 
 describe('SolaxCloudAPI: Static methods', () => {
 
@@ -40,11 +40,11 @@ describe('SolaxCloudAPI: Static methods', () => {
     assert.strictEqual(25, SolaxCloudAPI.getBatterySoC(sampleReply.result));
   });
 
-  it('DC From Battery', () => {
+  it('From Battery', () => {
     assert.strictEqual(21, SolaxCloudAPI.getInverterPowerFromBattery(sampleReply.result));
   });
 
-  it('DC To Battery', () => {
+  it('To Battery', () => {
     assert.strictEqual(0, SolaxCloudAPI.getInverterPowerToBattery(sampleReply.result));
   });
 
@@ -69,4 +69,96 @@ describe('SolaxCloudAPI: Static methods', () => {
     assert.strictEqual(0, SolaxCloudAPI.getGridPowerToHouse(sampleReply.result));
   });
 
+});
+
+describe('SolaxCloudAPI: Multiple inverters', () => {
+
+  const inverter1Data: SolaxCloudAPIResponse = {
+    success: true,
+    exception: 'Query success!',
+    result: {
+      inverterSN: 'XPTO1',
+      sn: 'ABC123',
+      acpower: -522.0,
+      yieldtoday: 0.3,
+      yieldtotal: 6726.6,
+      feedinpower: -48.0,
+      feedinenergy: 4820.32,
+      consumeenergy: 4743.47,
+      feedinpowerM2: 0.0,
+      soc: 22.0,
+      peps1: 0.0,
+      peps2: 0.0,
+      peps3 : 0.0,
+      inverterType: '5',
+      inverterStatus: '102',
+      uploadTime: '2022-04-05 10:10:27',
+      batPower: 2326.0,
+      powerdc1: 1182.0,
+      powerdc2: 698.0,
+      powerdc3: null,
+      powerdc4: null,
+    },
+  };
+  const inverter2Data: SolaxCloudAPIResponse = {
+    success: true,
+    exception: 'Query success !',
+    result: {
+      inverterSN: 'XPTO2',
+      sn: 'ABC123',
+      acpower: 1056.0,
+      yieldtoday: 1.3,
+      yieldtotal: 3989.1,
+      feedinpower: 0.0,
+      feedinenergy: 0.0,
+      consumeenergy: 0.0,
+      feedinpowerM2: 0.0,
+      soc: 0.0,
+      peps1: 0.0,
+      peps2: 0.0,
+      peps3 : 0.0,
+      inverterType: '7',
+      inverterStatus: '102',
+      uploadTime: '2022-04-05 10:10:13',
+      batPower: 0.0,
+      powerdc1: 479.0,
+      powerdc2: 683.0,
+      powerdc3: null,
+      powerdc4: null,
+    },
+  };
+
+  it('PV Power', () => {
+    assert.strictEqual(3042, SolaxCloudAPI.getPVPower(inverter1Data.result) + SolaxCloudAPI.getPVPower(inverter2Data.result));
+  });
+
+  it('Battery SoC', () => {
+    assert.strictEqual(22, SolaxCloudAPI.getBatterySoC(inverter1Data.result) + SolaxCloudAPI.getBatterySoC(inverter2Data.result));
+  });
+
+  it('From Battery', () => {
+    assert.strictEqual(0, SolaxCloudAPI.getInverterPowerFromBattery(inverter1Data.result) +
+                          SolaxCloudAPI.getInverterPowerFromBattery(inverter2Data.result));
+  });
+
+  it('To Battery', () => {
+    assert.strictEqual(2326, SolaxCloudAPI.getInverterPowerToBattery(inverter1Data.result) +
+                             SolaxCloudAPI.getInverterPowerToBattery(inverter2Data.result));
+  });
+
+  it('Inverter AC Power', () => {
+    assert.strictEqual(534, SolaxCloudAPI.getInverterACPower(inverter1Data.result) +
+                           SolaxCloudAPI.getInverterACPower(inverter2Data.result));
+  });
+
+  it('Inverter power to grid', () => {
+    assert.strictEqual(0, SolaxCloudAPI.getInverterPowerToGrid(inverter1Data.result) +
+                          SolaxCloudAPI.getInverterPowerToGrid(inverter2Data.result));
+  });
+
+  it('Grid power to house', () => {
+    assert.strictEqual(48, SolaxCloudAPI.getGridPowerToHouse(inverter1Data.result) +
+                           SolaxCloudAPI.getGridPowerToHouse(inverter2Data.result));
+  });
+
 });