homebridge-foxess 1.0.1

package/.eslintrc

@@ -0,0 +1,11 @@
+{
+  "env": {
+      "es2021": true,
+      "node": true
+  },
+  "extends": "standard-with-typescript",
+  "parserOptions": {
+      "ecmaVersion": "latest",
+      "sourceType": "module"
+  }
+}

package/.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+      
+  # Maintain dependencies for npm
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "monthly"

package/.github/workflows/build.yml

@@ -0,0 +1,26 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4.0.1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm run build --if-present
+      env:
+        CI: true

package/.github/workflows/npmpublish.yml

@@ -0,0 +1,34 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4.0.1
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm run prepublishOnly
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4.0.1
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Current TS File",
+            "type": "node",
+            "request": "launch",
+            "args": ["${relativeFile}"],
+            "runtimeArgs": ["-r", "ts-node/register"],
+            "cwd": "${workspaceRoot}",
+            "internalConsoleOptions": "openOnSessionStart"
+        },
+        {
+            "name": "Main",
+            "type": "node",
+            "request": "launch",
+            "args": ["src/index.ts"],
+            "runtimeArgs": ["-r", "ts-node/register"],
+            "cwd": "${workspaceFolder}",
+            "internalConsoleOptions": "openOnSessionStart"
+        }
+    ]
+}

package/.vscode/tasks.json

@@ -0,0 +1,31 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "command": "npm",
+    "tasks": [
+        {
+            "label": "build",
+            "type": "shell",
+            "args": [
+                "run",
+                "build"
+            ],
+            "problemMatcher": [],
+            "group": {
+                "_id": "build",
+                "isDefault": false
+            }
+        },
+        {
+            "label": "test",
+            "type": "shell",
+            "args": [
+                "run",
+                "mocha",
+                "-r ts-node/register ${relativeFile}"
+            ],
+            "problemMatcher": []
+        }
+    ]
+}

package/README.md

@@ -0,0 +1,51 @@
+![node](https://img.shields.io/node/v/homebridge-foxess)
+[![npm](https://img.shields.io/npm/dt/homebridge-foxess.svg)](https://www.npmjs.com/package/homebridge-foxess)
+[![npm version](https://badge.fury.io/js/homebridge-foxess.svg)](https://badge.fury.io/js/homebridge-foxess)
+![Node.js CI](https://github.com/teh-hippo/homebridge-foxess/workflows/Node.js%20CI/badge.svg)
+
+# Homebridge FoxESS
+
+This plugin exposes HomeKit to solar data provided by FoxESS and those who use its platform, such as [Energizer Solar](https://portal.energizersolar.com/).
+
+Created are various accessories that help power-optimising automations in HomeKit.
+
+Currently, only a light sensor is exposed that indicates the current solar generation.
+
+*This plugin is still in early development.*
+
+Example `config.json`:
+
+```json
+    "platforms": [
+        {
+            "name": "FoxESS",
+            "platform": "HomebridgeFoxESS",
+            "apiKey": "<your-api-key>",
+            "interval": "60000"
+        }
+    ]
+```
+
+## Parameters
+
+| Parameter | Description | Required | Default
+| --------- | ----- | ------- | ------ |
+| `apiKey`| API Key provided by FoxESS Cloud. | `true` | |
+| `interval`| How often to update current usage | `false` | `300000` (5 minutes) |
+
+## Obtaining an API Key
+
+1. Login to [FoxESS Cloud](https://www.foxesscloud.com)
+1. Click on the top-right user icon, and select [User Profile](https://www.foxesscloud.com/user/center)
+1. Under 'API Management', hit 'Generate API Key'.
+
+Note: There is currently a limit of 1440 calls per day for an API Key, equating to once per minute.
+
+## TODOs
+
+| Area | Item |
+| ---- | ---- |
+| Optimise API Usage | Allow device SNs to be specified in config, instead of requesting data from FoxESS. |
+| Optimise API Usage | Use a global timer to look-up real-time inverter data for all inverters, instead of 1 call per inverter. |
+| Functionality | Add a motion sensor to show when power usage is from the grid. |
+| Other | Move FoxESS Library into its own Node package |

package/config.schema.json

@@ -0,0 +1,32 @@
+{
+    "pluginAlias": "HomebridgeFoxESS",
+    "pluginType": "platform",
+    "singular": false,
+    "headerDisplay": "FoxESS for HomeKit",
+    "footerDisplay": "Created by teh-hippo",
+    "schema": {
+        "type": "object",
+        "properties": {
+            "name": {
+                "title": "Accessory Name",
+                "description": "Name for the accessory",
+                "type": "string",
+                "required": true
+            },
+            "apiKey": {
+                "title": "API Key",
+                "description": "API Key provided by FoxESS",
+                "type": "string",
+                "required": true
+            },
+            "interval": {
+                "title": "Polling Time in Milliseconds",
+                "description": "Time between each call to the FoxESS API",
+                "type": "integer",
+                "default": 60000,
+                "required": true,
+                "minimum": 60000
+            }
+        }
+    }
+  }

package/dist/accessories/realTimeUsage.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RealTimeUsageAccessory = exports.RealTimeType = void 0;
+const minLightLevel = 0.0001;
+var RealTimeType;
+(function (RealTimeType) {
+    RealTimeType[RealTimeType["LoadsPower"] = 1] = "LoadsPower";
+    RealTimeType[RealTimeType["GenerationPower"] = 2] = "GenerationPower";
+    RealTimeType[RealTimeType["FeedInPower"] = 3] = "FeedInPower";
+    RealTimeType[RealTimeType["GridConsumptionPower"] = 4] = "GridConsumptionPower";
+})(RealTimeType || (exports.RealTimeType = RealTimeType = {}));
+class RealTimeUsageAccessory {
+    constructor(platform, accessory, type) {
+        var _a;
+        this.platform = platform;
+        this.accessory = accessory;
+        this.type = type;
+        this.currentValue = minLightLevel;
+        this.service = (_a = this.accessory.getService(this.platform.Service.LightSensor)) !== null && _a !== void 0 ? _a : this.accessory.addService(this.platform.Service.LightSensor);
+        this.inverter = this.accessory.context;
+        this.service.setCharacteristic(this.platform.Characteristic.Name, `${this.inverter.deviceSN}-${RealTimeType[type]}`);
+        this.service.getCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel)
+            .onGet(() => { return this.currentValue; });
+        const informationService = this.accessory.getService(this.platform.Service.AccessoryInformation);
+        if (informationService === undefined) {
+            throw new Error('No information service was provided.');
+        }
+        informationService
+            .setCharacteristic(this.platform.Characteristic.Manufacturer, 'FoxESS')
+            .setCharacteristic(this.platform.Characteristic.Model, `${this.inverter.deviceType} (${RealTimeType[type]})`)
+            .setCharacteristic(this.platform.Characteristic.SerialNumber, this.inverter.deviceSN)
+            .setCharacteristic(this.platform.Characteristic.HardwareRevision, this.inverter.productType);
+        this.platform.log.debug(`Accessory for inverter: ${JSON.stringify(this.inverter)}`);
+    }
+    update(value) {
+        const newValue = this.getValue(value, this.type);
+        this.currentValue = Math.max(minLightLevel, newValue);
+        this.platform.log.debug('Current Usage', RealTimeType[this.type], newValue);
+        this.service.getCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel).updateValue(this.currentValue);
+    }
+    getValue(value, realTimeType) {
+        switch (realTimeType) {
+            case RealTimeType.LoadsPower:
+                return value.loadsPower;
+            case RealTimeType.GenerationPower:
+                return value.generationPower;
+            case RealTimeType.FeedInPower:
+                return value.feedinPower;
+            case RealTimeType.GridConsumptionPower:
+                return value.gridConsumptionPower;
+        }
+    }
+}
+exports.RealTimeUsageAccessory = RealTimeUsageAccessory;
+//# sourceMappingURL=realTimeUsage.js.map

package/dist/accessories/realTimeUsage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"realTimeUsage.js","sourceRoot":"","sources":["../../src/accessories/realTimeUsage.ts"],"names":[],"mappings":";;;AASA,MAAM,aAAa,GAAG,MAAM,CAAA;AAE5B,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,2DAAc,CAAA;IACd,qEAAmB,CAAA;IACnB,6DAAe,CAAA;IACf,+EAAwB,CAAA;AAC1B,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAED,MAAa,sBAAsB;IAKjC,YAA8B,QAAwB,EAAmB,SAAsC,EAAmB,IAAkB;;QAAtH,aAAQ,GAAR,QAAQ,CAAgB;QAAmB,cAAS,GAAT,SAAS,CAA6B;QAAmB,SAAI,GAAJ,IAAI,CAAc;QAF5I,iBAAY,GAAW,aAAa,CAAA;QAG1C,IAAI,CAAC,OAAO,GAAG,MAAA,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,mCAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QAC3I,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAA;QACtC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACpH,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,wBAAwB,CAAC;aAClF,KAAK,CAAC,GAAG,EAAE,GAAG,OAAO,IAAI,CAAC,YAAY,CAAA,CAAC,CAAC,CAAC,CAAA;QAE5C,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;QAChG,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,CAAC;QAED,kBAAkB;aACf,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,CAAC;aACtE,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,KAAK,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;aAC5G,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;aACpF,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,gBAAgB,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QAE9F,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IACrF,CAAC;IAEM,MAAM,CAAE,KAAwB;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAChD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;QACrD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAA;QAC3E,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IACtH,CAAC;IAEO,QAAQ,CAAE,KAAwB,EAAE,YAA0B;QACpE,QAAQ,YAAY,EAAE,CAAC;YACrB,KAAK,YAAY,CAAC,UAAU;gBAC1B,OAAO,KAAK,CAAC,UAAU,CAAA;YACzB,KAAK,YAAY,CAAC,eAAe;gBAC/B,OAAO,KAAK,CAAC,eAAe,CAAA;YAC9B,KAAK,YAAY,CAAC,WAAW;gBAC3B,OAAO,KAAK,CAAC,WAAW,CAAA;YAC1B,KAAK,YAAY,CAAC,oBAAoB;gBACpC,OAAO,KAAK,CAAC,oBAAoB,CAAA;QACrC,CAAC;IACH,CAAC;CACF;AA7CD,wDA6CC"}

package/dist/foxess/api.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllRealTimeData = exports.getRealTimeData = exports.getDeviceList = void 0;
+const getDeviceList_1 = require("./getDeviceList");
+Object.defineProperty(exports, "getDeviceList", { enumerable: true, get: function () { return getDeviceList_1.getDeviceList; } });
+const realTimeData_1 = require("./realTimeData");
+Object.defineProperty(exports, "getRealTimeData", { enumerable: true, get: function () { return realTimeData_1.getRealTimeData; } });
+Object.defineProperty(exports, "getAllRealTimeData", { enumerable: true, get: function () { return realTimeData_1.getAllRealTimeData; } });
+//# sourceMappingURL=api.js.map

package/dist/foxess/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/foxess/api.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAEtC,8FAFA,6BAAa,OAEA;AADtB,iDAAoE;AAC5C,gGADf,8BAAe,OACe;AAAE,mGADf,iCAAkB,OACe"}

package/dist/foxess/base.js

@@ -0,0 +1,54 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.call = void 0;
+const ts_md5_1 = require("ts-md5");
+function calculateSignature(path, apiKey, timestamp) {
+    return ts_md5_1.Md5.hashStr(`${path}\\r\\n${apiKey}\\r\\n${timestamp.toString()}`);
+}
+function call(path, apiKey, request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const timestamp = Date.now();
+        const signature = calculateSignature(path, apiKey, timestamp);
+        const response = yield fetch(`https://www.foxesscloud.com${path}`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                token: apiKey,
+                signature,
+                timestamp: timestamp.toString(),
+                lang: 'en'
+            },
+            body: JSON.stringify(request)
+        });
+        if (response.status !== 200) {
+            throw new Error(`Invalid response code: ${response.status}`);
+        }
+        else {
+            const json = yield response.text();
+            try {
+                const result = JSON.parse(json);
+                return result;
+            }
+            catch (e) {
+                const mine = `Unable to parse JSON: ${json}\nRoot: `;
+                if (e instanceof Error) {
+                    throw new Error(`${mine}${e.message}\n${e.stack}`);
+                }
+                else {
+                    throw new Error(`${mine}${e === null || e === void 0 ? void 0 : e.toString()}`);
+                }
+            }
+        }
+    });
+}
+exports.call = call;
+//# sourceMappingURL=base.js.map

package/dist/foxess/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/foxess/base.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAA4B;AAE5B,SAAS,kBAAkB,CAAE,IAAY,EAAE,MAAc,EAAE,SAAiB;IAC1E,OAAO,YAAG,CAAC,OAAO,CAAC,GAAG,IAAI,SAAS,MAAM,SAAS,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;AAC3E,CAAC;AAED,SAAsB,IAAI,CAAuB,IAAY,EAAE,MAAc,EAAE,OAAiB;;QAC9F,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC5B,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;QAC7D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,8BAA8B,IAAI,EAAE,EAAE;YACjE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,KAAK,EAAE,MAAM;gBACb,SAAS;gBACT,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE;gBAC/B,IAAI,EAAE,IAAI;aACX;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CAAC,CAAA;QACF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;QAC9D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAW,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;YAC1C,IAAI,CAAC;gBACH,MAAM,MAAM,GAAc,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAC1C,OAAO,MAAM,CAAA;YACf,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,IAAI,GAAG,yBAAyB,IAAI,UAAU,CAAA;gBACpD,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;oBACvB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;gBACpD,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,EAAE,EAAE,CAAC,CAAA;gBAC5C,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CAAA;AA9BD,oBA8BC"}

package/dist/foxess/devices.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Inverter = void 0;
+var InverterStatus;
+(function (InverterStatus) {
+    InverterStatus[InverterStatus["Online"] = 1] = "Online";
+    InverterStatus[InverterStatus["Fault"] = 2] = "Fault";
+    InverterStatus[InverterStatus["Offline"] = 3] = "Offline";
+})(InverterStatus || (InverterStatus = {}));
+class Inverter {
+    constructor() {
+        this.deviceSN = '';
+        this.moduleSN = '';
+        this.plantID = '';
+        this.status = InverterStatus.Offline;
+        this.hasPV = false;
+        this.hasBattery = false;
+        this.deviceType = '';
+        this.productType = '';
+    }
+}
+exports.Inverter = Inverter;
+//# sourceMappingURL=devices.js.map

package/dist/foxess/devices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devices.js","sourceRoot":"","sources":["../../src/foxess/devices.ts"],"names":[],"mappings":";;;AAAA,IAAK,cAIJ;AAJD,WAAK,cAAc;IACjB,uDAAU,CAAA;IACV,qDAAS,CAAA;IACT,yDAAW,CAAA;AACb,CAAC,EAJI,cAAc,KAAd,cAAc,QAIlB;AAED,MAAa,QAAQ;IAArB;QACS,aAAQ,GAAW,EAAE,CAAA;QACrB,aAAQ,GAAW,EAAE,CAAA;QACrB,YAAO,GAAW,EAAE,CAAA;QACpB,WAAM,GAAmB,cAAc,CAAC,OAAO,CAAA;QAC/C,UAAK,GAAY,KAAK,CAAA;QACtB,eAAU,GAAY,KAAK,CAAA;QAC3B,eAAU,GAAW,EAAE,CAAA;QACvB,gBAAW,GAAW,EAAE,CAAA;IACjC,CAAC;CAAA;AATD,4BASC"}

package/dist/foxess/getDeviceList.js

@@ -0,0 +1,41 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDeviceList = void 0;
+const base_1 = require("./base");
+class GetDeviceListRequest {
+    constructor() {
+        this.currentPage = 1;
+        this.pageSize = 10;
+    }
+}
+class GetDeviceListResponse {
+}
+class GetDeviceListResponsePage {
+    constructor() {
+        this.pageSize = 0;
+        this.total = 0;
+        this.data = [];
+    }
+}
+function getDeviceList(apiKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, base_1.call)('/op/v0/device/list', apiKey, new GetDeviceListRequest());
+        if (response.errno === 0 && response.result !== undefined) {
+            return response.result.data;
+        }
+        else {
+            throw new Error(`Invalid response code: ${response.errno}`);
+        }
+    });
+}
+exports.getDeviceList = getDeviceList;
+//# sourceMappingURL=getDeviceList.js.map

package/dist/foxess/getDeviceList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDeviceList.js","sourceRoot":"","sources":["../../src/foxess/getDeviceList.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,iCAA6B;AAE7B,MAAM,oBAAoB;IAA1B;QACS,gBAAW,GAAW,CAAC,CAAA;QACvB,aAAQ,GAAW,EAAE,CAAA;IAC9B,CAAC;CAAA;AAED,MAAM,qBAAqB;CAG1B;AAED,MAAM,yBAAyB;IAA/B;QACS,aAAQ,GAAW,CAAC,CAAA;QACpB,UAAK,GAAW,CAAC,CAAA;QACjB,SAAI,GAAe,EAAE,CAAA;IAC9B,CAAC;CAAA;AAED,SAAsB,aAAa,CAAE,MAAc;;QACjD,MAAM,QAAQ,GAA0B,MAAM,IAAA,WAAI,EAAC,oBAAoB,EAAE,MAAM,EAAE,IAAI,oBAAoB,EAAE,CAAC,CAAA;QAC5G,IAAI,QAAQ,CAAC,KAAK,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC1D,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAA;QAC7B,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;CAAA;AAPD,sCAOC"}

package/dist/foxess/realTimeData.js

@@ -0,0 +1,126 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllRealTimeData = exports.getRealTimeData = exports.BasicRealTimeData = void 0;
+const base_1 = require("./base");
+const TodayYield = 'todayYield'; // Today Yield (kW)
+const PvPower = 'pvPower'; // pvPower (kW)
+const LoadsPower = 'loadsPower'; // Load Power (kW)
+const GenerationPower = 'generationPower'; // Output Power (kW)
+const FeedInPower = 'feedinPower'; // Feed-in Power (kW)
+const GridConsumptionPower = 'gridConsumptionPower'; // GridConsumption Power (kW)
+class BasicRealTimeData {
+    constructor() {
+        this.deviceSN = '';
+        this.todayYield = 0;
+        this.pvPower = 0;
+        this.loadsPower = 0;
+        this.generationPower = 0;
+        this.feedinPower = 0;
+        this.gridConsumptionPower = 0;
+    }
+}
+exports.BasicRealTimeData = BasicRealTimeData;
+class RealTimeData {
+    constructor() {
+        this.deviceSN = '';
+        this.datas = [];
+        this.time = '';
+    }
+}
+class RealTimeDataItem {
+    constructor() {
+        this.variable = '';
+        this.unit = '';
+        this.name = '';
+        this.value = 0;
+    }
+}
+class RealTimeDataRequest {
+    constructor() {
+        this.variables = [
+            TodayYield,
+            PvPower,
+            LoadsPower,
+            GenerationPower,
+            FeedInPower,
+            GridConsumptionPower
+        ];
+        this.sn = '';
+    }
+}
+class RealTimeDataResponse {
+}
+function toBasicData(data) {
+    const result = new BasicRealTimeData();
+    result.deviceSN = data.deviceSN;
+    data.datas.forEach(i => {
+        switch (i.variable) {
+            case PvPower:
+                result.pvPower = i.value;
+                break;
+            case LoadsPower:
+                result.loadsPower = i.value;
+                break;
+            case GenerationPower:
+                result.generationPower = i.value;
+                break;
+            case FeedInPower:
+                result.feedinPower = i.value;
+                break;
+            case GridConsumptionPower:
+                result.gridConsumptionPower = i.value;
+                break;
+            case TodayYield:
+                result.todayYield = i.value;
+                break;
+        }
+    });
+    return result;
+}
+function getRealTimeData(apiKey, inverter) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const request = new RealTimeDataRequest();
+        if (inverter !== undefined) {
+            request.sn = inverter.deviceSN;
+        }
+        const response = yield (0, base_1.call)('/op/v0/device/real/query', apiKey, request);
+        if (response.errno === 0) {
+            if (response.result !== undefined && response.result.length > 0) {
+                return toBasicData(response.result[0]);
+            }
+            else {
+                throw new Error(`No data returned for inverter: ${inverter.deviceSN}`);
+            }
+        }
+        else {
+            throw new Error(`Invalid response code: ${response.errno}`);
+        }
+    });
+}
+exports.getRealTimeData = getRealTimeData;
+function getAllRealTimeData(apiKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, base_1.call)('/op/v0/device/real/query', apiKey, new RealTimeDataRequest());
+        if (response.errno === 0 && response.result !== undefined) {
+            const result = [];
+            response.result.forEach(i => {
+                result.push(toBasicData(i));
+            });
+            return result;
+        }
+        else {
+            throw new Error(`Invalid response code: ${response.errno}`);
+        }
+    });
+}
+exports.getAllRealTimeData = getAllRealTimeData;
+//# sourceMappingURL=realTimeData.js.map

package/dist/foxess/realTimeData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"realTimeData.js","sourceRoot":"","sources":["../../src/foxess/realTimeData.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,iCAA6B;AAE7B,MAAM,UAAU,GAAG,YAAY,CAAA,CAAC,mBAAmB;AACnD,MAAM,OAAO,GAAG,SAAS,CAAA,CAAC,eAAe;AACzC,MAAM,UAAU,GAAG,YAAY,CAAA,CAAC,kBAAkB;AAClD,MAAM,eAAe,GAAG,iBAAiB,CAAA,CAAC,oBAAoB;AAC9D,MAAM,WAAW,GAAG,aAAa,CAAA,CAAC,qBAAqB;AACvD,MAAM,oBAAoB,GAAG,sBAAsB,CAAA,CAAC,6BAA6B;AAEjF,MAAa,iBAAiB;IAA9B;QACS,aAAQ,GAAW,EAAE,CAAA;QACrB,eAAU,GAAW,CAAC,CAAA;QACtB,YAAO,GAAW,CAAC,CAAA;QACnB,eAAU,GAAW,CAAC,CAAA;QACtB,oBAAe,GAAW,CAAC,CAAA;QAC3B,gBAAW,GAAW,CAAC,CAAA;QACvB,yBAAoB,GAAW,CAAC,CAAA;IACzC,CAAC;CAAA;AARD,8CAQC;AAED,MAAM,YAAY;IAAlB;QACS,aAAQ,GAAW,EAAE,CAAA;QACrB,UAAK,GAAuB,EAAE,CAAA;QAC9B,SAAI,GAAW,EAAE,CAAA;IAC1B,CAAC;CAAA;AAED,MAAM,gBAAgB;IAAtB;QACS,aAAQ,GAAW,EAAE,CAAA;QACrB,SAAI,GAAW,EAAE,CAAA;QACjB,SAAI,GAAW,EAAE,CAAA;QACjB,UAAK,GAAW,CAAC,CAAA;IAC1B,CAAC;CAAA;AAED,MAAM,mBAAmB;IAAzB;QACS,cAAS,GAAa;YAC3B,UAAU;YACV,OAAO;YACP,UAAU;YACV,eAAe;YACf,WAAW;YACX,oBAAoB;SACrB,CAAA;QAEM,OAAE,GAAW,EAAE,CAAA;IACxB,CAAC;CAAA;AAED,MAAM,oBAAoB;CAGzB;AAED,SAAS,WAAW,CAAE,IAAkB;IACtC,MAAM,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAA;IACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;IAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QACrB,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;YACnB,KAAK,OAAO;gBACV,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,KAAK,CAAA;gBACxB,MAAK;YACP,KAAK,UAAU;gBACb,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,KAAK,CAAA;gBAC3B,MAAK;YACP,KAAK,eAAe;gBAClB,MAAM,CAAC,eAAe,GAAG,CAAC,CAAC,KAAK,CAAA;gBAChC,MAAK;YACP,KAAK,WAAW;gBACd,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,KAAK,CAAA;gBAC5B,MAAK;YACP,KAAK,oBAAoB;gBACvB,MAAM,CAAC,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAA;gBACrC,MAAK;YACP,KAAK,UAAU;gBACb,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,KAAK,CAAA;gBAC3B,MAAK;QACT,CAAC;IACH,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAsB,eAAe,CAAE,MAAc,EAAE,QAAkB;;QACvE,MAAM,OAAO,GAAG,IAAI,mBAAmB,EAAE,CAAA;QACzC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAA;QAChC,CAAC;QAED,MAAM,QAAQ,GAAyB,MAAM,IAAA,WAAI,EAAC,0BAA0B,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9F,IAAI,QAAQ,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChE,OAAO,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;YACxC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAA;YACxE,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;CAAA;AAhBD,0CAgBC;AAED,SAAsB,kBAAkB,CAAE,MAAc;;QACtD,MAAM,QAAQ,GAAyB,MAAM,IAAA,WAAI,EAAC,0BAA0B,EAAE,MAAM,EAAE,IAAI,mBAAmB,EAAE,CAAC,CAAA;QAChH,IAAI,QAAQ,CAAC,KAAK,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC1D,MAAM,MAAM,GAAwB,EAAE,CAAA;YACtC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;gBAC1B,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;YAC7B,CAAC,CAAC,CAAA;YACF,OAAO,MAAM,CAAA;QACf,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;CAAA;AAXD,gDAWC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+const settings_1 = require("./settings");
+const platform_1 = require("./platform");
+module.exports = (api) => {
+    api.registerPlatform(settings_1.PLATFORM_NAME, platform_1.FoxESSPlatform);
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,yCAA0C;AAC1C,yCAA2C;AAE3C,iBAAS,CAAC,GAAQ,EAAE,EAAE;IACpB,GAAG,CAAC,gBAAgB,CAAC,wBAAa,EAAE,yBAAc,CAAC,CAAA;AACrD,CAAC,CAAA"}

package/dist/local.js

@@ -0,0 +1,52 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const FoxESS = __importStar(require("./foxess/api"));
+/*
+* Basic example showing how to retrieve data from the FoxESS API.
+*/
+(() => __awaiter(void 0, void 0, void 0, function* () {
+    const apiKey = process.env.API_KEY;
+    if (apiKey === undefined) {
+        throw new Error('API_KEY is not set.');
+    }
+    const inverters = yield FoxESS.getDeviceList(apiKey);
+    console.info(`Returned ${inverters.length} inverter(s):`);
+    for (const inverter of inverters) {
+        console.log(`\t${JSON.stringify(inverter)}:`);
+        const data = yield FoxESS.getRealTimeData(apiKey, inverter);
+        console.log(JSON.stringify(data));
+    }
+}))().catch(e => { console.error(e); });
+//# sourceMappingURL=local.js.map

package/dist/local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.js","sourceRoot":"","sources":["../src/local.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAsC;AAEtC;;EAEE;AACF,CAAC,GAAS,EAAE;IACV,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAA;IAClC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;IACxC,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;IACpD,OAAO,CAAC,IAAI,CAAC,YAAY,SAAS,CAAC,MAAM,eAAe,CAAC,CAAA;IACzD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC7C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QAC3D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;IACnC,CAAC;AACH,CAAC,CAAA,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,CAAC,CAAA"}