homebridge-solaxcloud-api 1.2.0

package/dist/solaxcloudapi.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SolaxCloudAPI = void 0;
+const request_1 = require("./request");
+const SOLAX_CLOUD_URL = 'https://www.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do';
+/**
+ * Main class to retrieve data from Solax API.
+ */
+class SolaxCloudAPI {
+    /**
+       * Class constructor.
+       * @param tokenId Token ID to gather data from Solax Cloud API.
+       * @param sn Unique identifier of inverter (Serial No).
+       */
+    constructor(tokenId, sn) {
+        this.tokenId = tokenId;
+        this.sn = sn;
+        this.tokenId = tokenId;
+        this.sn = sn;
+    }
+    /**
+       * Gets the inverter type description from the corresponding type code.
+       * @param {string} typeCode The Solax inverter type code.
+       * @returns Corresponding inverter type description.
+       */
+    static getInverterType(typeCode) {
+        switch (typeCode) {
+            case '1':
+                return 'X1-LX';
+            case '2':
+                return 'X-Hybrid';
+            case '3':
+                return 'X1-Hybiyd/Fit';
+            case '4':
+                return 'X1-Boost/Air/Mini';
+            case '5':
+                return 'X3-Hybiyd/Fit';
+            case '6':
+                return 'X3-20K/30K';
+            case '7':
+                return 'X3-MIC/PRO';
+            case '8':
+                return 'X1-Smart';
+            case '9':
+                return 'X1-AC';
+            case '10':
+                return 'A1-Hybrid';
+            case '11':
+                return 'A1-Fit';
+            case '12':
+                return 'A1-Grid';
+            case '13':
+                return 'J1-ESS';
+            default:
+                return 'Unknown';
+        }
+    }
+    /**
+       * Gets the inverter status description from the corresponding status code.
+       * @param {string} statusCode The inverter status code.
+       * @returns Corresponding inverter status description.
+       */
+    static getInverterStatus(statusCode) {
+        switch (statusCode) {
+            case '100':
+                return 'Wait Mode';
+            case '101':
+                return 'Check Mode';
+            case '102':
+                return 'Normal Mode';
+            case '103':
+                return 'Fault Mode';
+            case '104':
+                return 'Permanent Fault Mode';
+            case '105':
+                return 'Update Mode';
+            case '106':
+                return 'EPS Check Mode';
+            case '107':
+                return 'EPS Mode';
+            case '108':
+                return 'Self-Test Mode';
+            case '109':
+                return 'Idle Mode';
+            case '110':
+                return 'Standby Mode';
+            case '111':
+                return 'Pv Wake Up Bat Mode';
+            case '112':
+                return 'Gen Check Mode';
+            case '113':
+                return 'Gen Run Mode';
+            default:
+                return 'Unknown';
+        }
+    }
+    /**
+     * Gets the inverter fed photovoltaic DC power (in W) from the retrieved API results.
+     * @param {SolaxCloudAPIResult} data The result data retrieved from the Solax Cloud API.
+     * @returns {number} The measured inverter photovoltaic input DC power (in W).
+     */
+    static getPVPower(data) {
+        return (data.powerdc1 || 0) + (data.powerdc2 || 0) + (data.powerdc3 || 0) + (data.powerdc4 || 0);
+    }
+    /**
+     * Gets the inverter output AC power (in W) from the retrieved API results.
+     * @param {SolaxCloudAPIResult} data The result data retrieved from the Solax Cloud API.
+     * @returns {number} The measured inverter output AC power (in W).
+     */
+    static getInverterACPower(data) {
+        return data.acpower;
+    }
+    /**
+     * Gets the Inverter AC energy out for today (KWh) from the retrieved API results.
+     * @param {SolaxCloudAPIResult} data The result data retrieved from the Solax Cloud API.
+     * @returns {number} The AC energy output by the inverter today (in KWh).
+     */
+    static getYieldToday(data) {
+        return data.yieldtoday;
+    }
+    /**
+     * Gets the Inverter AC energy out total (KWh) from the retrieved API results.
+     * @param {SolaxCloudAPIResult} data The result data retrieved from the Solax Cloud API.
+     * @returns {number} The total AC energy output by the inverter (in KWh).
+     */
+    static getYieldTotal(data) {
+        return data.yieldtotal;
+    }
+    /**
+     * Gets the power currently being fed to the grid by the inverter (in W).
+     * @param {SolaxCloudAPIResult} data The result data retrieved from the Solax Cloud API.
+     * @returns The power currently being sent to the grid (in W).
+     */
+    static getInverterPowerToGrid(data) {
+        return data.feedinpower > 0 ? data.feedinpower : 0;
+    }
+    /**
+     * Gets the power currently being drawn from the grid to the house (in W).
+     * @param {SolaxCloudAPIResult} data The result data retrieved from the Solax Cloud API.
+     * @returns The power currently being drawn from the grid to the house (in W).
+     */
+    static getGridPowerToHouse(data) {
+        return data.feedinpower < 0 ? -data.feedinpower : 0;
+    }
+    /**
+     * Gets the power currently being generated by the inverter to the house (in W).
+     * @param {SolaxCloudAPIResult} data The result data retrieved from the Solax Cloud API.
+     * @returns The power currently being generated by the inverter to the house (in W).
+     */
+    static getInverterPowerToHouse(data) {
+        return this.getInverterACPower(data) - this.getInverterPowerToGrid(data);
+    }
+    /**
+     * Retrieves inverter data using Solax Cloud "real-time" API.
+     * @returns {SolaxCloudAPIResponse} The response by Solax Cloud API.
+     */
+    async getAPIData() {
+        const reply = await (0, request_1.request)('get', SOLAX_CLOUD_URL, { tokenId: this.tokenId, sn: this.sn });
+        return reply.ok ?
+            reply.json() : { exception: reply.statusText, result: {}, success: false };
+    }
+}
+exports.SolaxCloudAPI = SolaxCloudAPI;
+//# sourceMappingURL=solaxcloudapi.js.map

package/dist/solaxcloudapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"solaxcloudapi.js","sourceRoot":"","sources":["../src/solaxcloudapi.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AAwDpC,MAAM,eAAe,GAAG,8DAA8D,CAAC;AAEvF;;GAEG;AACH,MAAa,aAAa;IAExB;;;;SAIK;IACL,YAA6B,OAAe,EAAkB,EAAU;QAA3C,YAAO,GAAP,OAAO,CAAQ;QAAkB,OAAE,GAAF,EAAE,CAAQ;QACtE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;IAED;;;;SAIK;IACE,MAAM,CAAC,eAAe,CAAC,QAAgB;QAC5C,QAAQ,QAAQ,EAAE;YAChB,KAAK,GAAG;gBACN,OAAO,OAAO,CAAC;YACjB,KAAK,GAAG;gBACN,OAAO,UAAU,CAAC;YACpB,KAAK,GAAG;gBACN,OAAO,eAAe,CAAC;YACzB,KAAK,GAAG;gBACN,OAAO,mBAAmB,CAAC;YAC7B,KAAK,GAAG;gBACN,OAAO,eAAe,CAAC;YACzB,KAAK,GAAG;gBACN,OAAO,YAAY,CAAC;YACtB,KAAK,GAAG;gBACN,OAAO,YAAY,CAAC;YACtB,KAAK,GAAG;gBACN,OAAO,UAAU,CAAC;YACpB,KAAK,GAAG;gBACN,OAAO,OAAO,CAAC;YACjB,KAAK,IAAI;gBACP,OAAO,WAAW,CAAC;YACrB,KAAK,IAAI;gBACP,OAAO,QAAQ,CAAC;YAClB,KAAK,IAAI;gBACP,OAAO,SAAS,CAAC;YACnB,KAAK,IAAI;gBACP,OAAO,QAAQ,CAAC;YAClB;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;IAED;;;;SAIK;IACE,MAAM,CAAC,iBAAiB,CAAC,UAAkB;QAChD,QAAQ,UAAU,EAAE;YAClB,KAAK,KAAK;gBACR,OAAO,WAAW,CAAC;YACrB,KAAK,KAAK;gBACR,OAAO,YAAY,CAAC;YACtB,KAAK,KAAK;gBACR,OAAO,aAAa,CAAC;YACvB,KAAK,KAAK;gBACR,OAAO,YAAY,CAAC;YACtB,KAAK,KAAK;gBACR,OAAO,sBAAsB,CAAC;YAChC,KAAK,KAAK;gBACR,OAAO,aAAa,CAAC;YACvB,KAAK,KAAK;gBACR,OAAO,gBAAgB,CAAC;YAC1B,KAAK,KAAK;gBACR,OAAO,UAAU,CAAC;YACpB,KAAK,KAAK;gBACR,OAAO,gBAAgB,CAAC;YAC1B,KAAK,KAAK;gBACR,OAAO,WAAW,CAAC;YACrB,KAAK,KAAK;gBACR,OAAO,cAAc,CAAC;YACxB,KAAK,KAAK;gBACR,OAAO,qBAAqB,CAAC;YAC/B,KAAK,KAAK;gBACR,OAAO,gBAAgB,CAAC;YAC1B,KAAK,KAAK;gBACR,OAAO,cAAc,CAAC;YACxB;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,IAAyB;QAChD,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;IACnG,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAyB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAyB;QACnD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAyB;QACnD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAyB;QAC5D,OAAO,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,IAAyB;QACzD,OAAO,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,uBAAuB,CAAC,IAAyB;QAC7D,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAE,GAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU;QACrB,MAAM,KAAK,GAAG,MAAM,IAAA,iBAAO,EAAC,KAAK,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAE5F,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC;YACa,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAyB,EAAE,SAAS,EAAE,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IACnI,CAAC;CAEF;AApKD,sCAoKC"}

package/dist/statistics.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=statistics.d.ts.map

package/dist/statistics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":""}

package/dist/statistics.js

@@ -0,0 +1,20 @@
+"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);
+api.getAPIData().then(result => {
+    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`);
+});
+//# sourceMappingURL=statistics.js.map

package/dist/statistics.js.map

@@ -0,0 +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,GAAG,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;IAC7B,OAAO,CAAC,GAAG,CAAC,aAAa,6BAAa,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACrE,OAAO,CAAC,GAAG,CAAC,sBAAsB,6BAAa,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACtF,OAAO,CAAC,GAAG,CAAC,wBAAwB,6BAAa,CAAC,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACzF,OAAO,CAAC,GAAG,CAAC,2BAA2B,6BAAa,CAAC,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/F,OAAO,CAAC,GAAG,CAAC,4BAA4B,6BAAa,CAAC,uBAAuB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAEjG,OAAO,CAAC,GAAG,CAAC,gBAAgB,6BAAa,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7E,OAAO,CAAC,GAAG,CAAC,gBAAgB,6BAAa,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/E,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "private": false,
+  "displayName": "Solax Cloud API plugin for Homebridge",
+  "name": "homebridge-solaxcloud-api",
+  "version": "1.2.0",
+  "description": "Integrates solar production info using public Solax Cloud API into Homebrigde acessories.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/AllMightySauron/homebride-solaxcloud-api.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AllMightySauron/homebride-solaxcloud-api/issues"
+  },
+  "engines": {
+    "node": ">=14.18.1",
+    "homebridge": ">=1.3.5"
+  },
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "mocha --timeout 0",
+    "lint": "eslint src/**.ts --max-warnings=0",
+    "watch": "npm run build && npm link && nodemon",
+    "build": "rimraf ./dist && tsc",
+    "prepublishOnly": "npm run lint && npm run build"
+  },
+  "keywords": [
+    "homebridge",
+    "homebridge-plugin",
+    "solax",
+    "solaxcloud"
+  ],
+  "dependencies": {
+    "jshint": "^2.13.1",
+    "xmlhttprequest": "^1.8.0",
+    "homebridge-lib": "^5.1.21"
+  },
+  "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.3.5",
+    "mocha": "^9.1.3",
+    "nodemon": "^2.0.13",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.3.0",
+    "typescript": "^4.4.4"
+  }
+}

package/test/solaxcloudapi.test.ts

@@ -0,0 +1,60 @@
+import { SolaxCloudAPI, SolaxCloudAPIResponse } from '../src/solaxcloudapi';
+
+import assert = require('assert');
+
+describe('Static methods', () => {
+
+  const sampleReply: SolaxCloudAPIResponse = {
+    success: true,
+    exception: 'Query success!',
+    result: {
+      inverterSN: 'HUE512H3456789',
+      sn: 'ABCDEFGHIJ',
+      acpower: 1214,
+      yieldtoday: 1.1,
+      yieldtotal: 121.1,
+      feedinpower: 37,
+      feedinenergy: 24.65,
+      consumeenergy: 433.09,
+      feedinpowerM2: 0,
+      soc: 0,
+      peps1: 0,
+      peps2: null,
+      peps3: null,
+      inverterType: '3',
+      inverterStatus: '102',
+      uploadTime: '2021-12-06 10:16:59',
+      batPower: 0,
+      powerdc1: 0,
+      powerdc2: 1258,
+      powerdc3: null,
+      powerdc4: null,
+    },
+  };
+
+  it('PV Power', () => {
+    assert.strictEqual(1258, SolaxCloudAPI.getPVPower(sampleReply.result));
+  });
+
+  it('Inverter AC Power', () => {
+    assert.strictEqual(1214, SolaxCloudAPI.getInverterACPower(sampleReply.result));
+  });
+
+  it('Yield Today', () => {
+    assert.strictEqual(1.1, SolaxCloudAPI.getYieldToday(sampleReply.result));
+  });
+
+
+  it('Yield Total', () => {
+    assert.strictEqual(121.1, SolaxCloudAPI.getYieldTotal(sampleReply.result));
+  });
+
+  it('Inverter power to grid', () => {
+    assert.strictEqual(37, SolaxCloudAPI.getInverterPowerToGrid(sampleReply.result));
+  });
+
+  it('Grid power to house', () => {
+    assert.strictEqual(0, SolaxCloudAPI.getGridPowerToHouse(sampleReply.result));
+  });
+
+});