homebridge-solaxcloud-api 1.5.1 → 2.0.3

package/dist/statistics.js

@@ -1,19 +1,89 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable no-console */
-const solaxcloudapi_1 = require("./solaxcloudapi");
-const fs_1 = __importDefault(require("fs"));
-const config = JSON.parse(fs_1.default.readFileSync('config.json').toString());
-const api = new solaxcloudapi_1.SolaxCloudAPI(config.platforms[0].tokenId, config.platforms[0].sn);
-const result = api.getAPIData();
-console.log(`PV Power: ${solaxcloudapi_1.SolaxCloudAPI.getPVPower(result.result)}W`);
-console.log(`Inverter AC Power: ${solaxcloudapi_1.SolaxCloudAPI.getInverterACPower(result.result)}W`);
-console.log(`Grid Power to House: ${solaxcloudapi_1.SolaxCloudAPI.getGridPowerToHouse(result.result)}W`);
-console.log(`Inverter Power to Grid: ${solaxcloudapi_1.SolaxCloudAPI.getInverterPowerToGrid(result.result)}W`);
-console.log(`Inverter Power to House: ${solaxcloudapi_1.SolaxCloudAPI.getInverterPowerToHouse(result.result)}W`);
-console.log(`Yield Today: ${solaxcloudapi_1.SolaxCloudAPI.getYieldToday(result.result)}KWh`);
-console.log(`Yield Total: ${solaxcloudapi_1.SolaxCloudAPI.getYieldTotal(result.result)}KWh`);
+exports.Statistics = void 0;
+/**
+ * Statistics.
+ * This class is used for statistical calculations for the purpose of smoothing a series of value.
+ */
+class Statistics {
+    /**
+       * Simple moving average calculation from a series of values.
+       * Formula is
+       *    SMA = (V1 + V2 + ... + Vn) / n
+       * where
+       *    Vn = Series value for period n
+       *    n = number values in period
+       * @param {number[]} series Array with series of values.
+       * @param {number} windowSize Size of moving average window.
+       * @param {number} maxCalculations Maximum calculations to be performed.
+       * @returns {number[]} Array with simple moving averages from series.
+       */
+    static simpleMovingAverage(series, windowSize, maxCalculations = Infinity) {
+        const result = [];
+        // sanity check
+        if (!series || !windowSize || series.length < windowSize) {
+            return result;
+        }
+        // first index to compute
+        let index = windowSize - 1;
+        // max series lenght
+        const length = series.length + 1;
+        // number of simple moving averages calculated
+        let numberOfSMAsCalculated = 0;
+        // loop over series array
+        while (++index < length && numberOfSMAsCalculated++ < maxCalculations) {
+            // create array with window slice only
+            const windowSlice = series.slice(index - windowSize, index);
+            // compute slice sum
+            const sum = windowSlice.reduce((prev, curr) => prev + curr, 0);
+            // push new moving average to result
+            result.push(sum / windowSize);
+        }
+        return result;
+    }
+    /**
+       * Exponential moving average calculation from a series of values.
+       * Formula is
+       *    EMAn = (Vn - EMAn-1) * weight + EMAn-1
+       * where
+       *    EMAn = Exponential Moving Average for period n
+       *    EMAn-1 = Exponential Moving Average for period n - 1
+       *    Vn = Series value for period n
+       *    weight = multiplier to use lower weights for older value
+       *    w = window size
+       * and
+       *    weight = 2 / (w + 1)
+       * @param {number[]} series Array with series of values.
+       * @param {number} windowSize Size of moving average window.
+       * @returns {number[]} Array with exponential moving averages from series.
+       */
+    static exponentialMovingAverage(series, windowSize) {
+        const result = [];
+        // sanity check
+        if (!series || !windowSize || series.length < windowSize) {
+            return result;
+        }
+        // first index to compute
+        let index = windowSize - 1;
+        // set previous EMA index
+        let previousEmaIndex = 0;
+        // setup smoothing factor
+        const smoothingFactor = 2 / (windowSize + 1);
+        // calculate first EMA using SMA
+        const [SMA] = Statistics.simpleMovingAverage(series, windowSize, 1);
+        result.push(SMA);
+        // loop over series array
+        while (++index < series.length) {
+            // get current value
+            const value = series[index];
+            // get previous EMA
+            const previousEMA = result[previousEmaIndex++];
+            // calculate current EMA
+            const currentEMA = (value - previousEMA) * smoothingFactor + previousEMA;
+            result.push(currentEMA);
+        }
+        return result;
+    }
+}
+exports.Statistics = Statistics;
 //# sourceMappingURL=statistics.js.map

package/dist/statistics.js.map

@@ -1 +1 @@
-{"version":3,"file":"statistics.js","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,mDAAgD;AAEhD,4CAAoB;AAEpB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AACrE,MAAM,GAAG,GAAG,IAAI,6BAAa,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAEnF,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC;AAEhC,OAAO,CAAC,GAAG,CAAC,aAAa,6BAAa,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACrE,OAAO,CAAC,GAAG,CAAC,sBAAsB,6BAAa,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACtF,OAAO,CAAC,GAAG,CAAC,wBAAwB,6BAAa,CAAC,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACzF,OAAO,CAAC,GAAG,CAAC,2BAA2B,6BAAa,CAAC,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC/F,OAAO,CAAC,GAAG,CAAC,4BAA4B,6BAAa,CAAC,uBAAuB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAEjG,OAAO,CAAC,GAAG,CAAC,gBAAgB,6BAAa,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC7E,OAAO,CAAC,GAAG,CAAC,gBAAgB,6BAAa,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC"}
+{"version":3,"file":"statistics.js","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAa,UAAU;IAErB;;;;;;;;;;;SAWK;IACE,MAAM,CAAC,mBAAmB,CAAC,MAAgB,EAAE,UAAkB,EAAE,eAAe,GAAG,QAAQ;QAChG,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,eAAe;QACf,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,MAAM,GAAG,UAAU,EAAE;YACxD,OAAO,MAAM,CAAC;SACf;QAED,yBAAyB;QACzB,IAAI,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;QAE3B,oBAAoB;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QAEjC,8CAA8C;QAC9C,IAAI,sBAAsB,GAAG,CAAC,CAAC;QAE/B,yBAAyB;QACzB,OAAO,EAAE,KAAK,GAAG,MAAM,IAAI,sBAAsB,EAAE,GAAG,eAAe,EAAE;YACrE,sCAAsC;YACtC,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,UAAU,EAAE,KAAK,CAAC,CAAC;YAE5D,oBAAoB;YACpB,MAAM,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;YAE/D,oCAAoC;YACpC,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,CAAC;SAC/B;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;SAeK;IACE,MAAM,CAAC,wBAAwB,CAAC,MAAgB,EAAE,UAAkB;QACzE,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,eAAe;QACf,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,MAAM,GAAG,UAAU,EAAE;YACxD,OAAO,MAAM,CAAC;SACf;QAED,yBAAyB;QACzB,IAAI,KAAK,GAAG,UAAU,GAAG,CAAC,CAAC;QAE3B,yBAAyB;QACzB,IAAI,gBAAgB,GAAG,CAAC,CAAC;QAEzB,yBAAyB;QACzB,MAAM,eAAe,GAAG,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE7C,gCAAgC;QAChC,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,mBAAmB,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEjB,yBAAyB;QACzB,OAAO,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE;YAC9B,oBAAoB;YACpB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B,mBAAmB;YACnB,MAAM,WAAW,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAE/C,wBAAwB;YACxB,MAAM,UAAU,GAAG,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,eAAe,GAAG,WAAW,CAAC;YAEzE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACzB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CAEF;AApGD,gCAoGC"}

package/package.json

@@ -2,8 +2,8 @@
   "private": false,
   "displayName": "Homebridge Solax Cloud API",
   "name": "homebridge-solaxcloud-api",
-  "version": "1.5.1",
-  "description": "Integrates solar production info using public Solax Cloud API into Homebrigde acessories.",
+  "version": "2.0.3",
+  "description": "Integrates solar production info using public Solax Cloud API into Homebrigde accessories.",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -18,7 +18,7 @@
   },
   "main": "dist/index.js",
   "scripts": {
-    "test": "mocha --timeout 0",
+    "test": "mocha --require ts-node/register test/**/*.test.ts",
     "lint": "eslint src/**.ts --max-warnings=0",
     "watch": "npm run build && npm link && nodemon",
     "build": "rimraf ./dist && tsc",

package/test/solaxcloudapi.test.ts

@@ -2,7 +2,7 @@ import { SolaxCloudAPI, SolaxCloudAPIResponse } from '../src/solaxcloudapi';
 
 import assert = require('assert');
 
-describe('Static methods', () => {
+describe('SolaxCloudAPI: Static methods', () => {
 
   const sampleReply: SolaxCloudAPIResponse = {
     success: true,

package/test/statistics.test.ts

@@ -0,0 +1,51 @@
+import { Statistics } from '../src/statistics';
+
+import assert = require('assert');
+
+describe('Statistics: Smoothing methods', () => {
+  const sampleSeries = [1, 3, 5, 3, 7, 6, 8, 5, 8, 8, 4, 5];
+
+  it('Simple Moving Average (sanity checks)', () => {
+    // window size too big
+    assert.deepEqual(Statistics.simpleMovingAverage(sampleSeries, 100), []);
+  });
+
+  it('Simple Moving Average', () => {
+    assert.deepEqual(
+      Statistics.simpleMovingAverage(sampleSeries, 4),
+      [
+        3,
+        4.5,
+        5.25,
+        6,
+        6.5,
+        6.75,
+        7.25,
+        6.25,
+        6.25],
+    );
+  });
+
+  it('Exponential Moving Average (sanity checks)', () => {
+    // window size too big
+    assert.deepEqual(Statistics.exponentialMovingAverage(sampleSeries, 100), []);
+  });
+
+  it('Exponential Moving Average', () => {
+    assert.deepEqual(
+      Statistics.exponentialMovingAverage(sampleSeries, 4),
+      [
+        3,
+        4.6,
+        5.16,
+        6.296,
+        5.7776000000000005,
+        6.6665600000000005,
+        7.199936,
+        5.9199616,
+        5.55197696,
+      ],
+    );
+  });
+
+});