myenergi-api 2.5.0 → 2.7.0

package/README.md

@@ -83,6 +83,28 @@ In ECO and ECO+ you can use the boosts to top up your battery quickly.  There ar
 const result = await myenergi.setZappiBoostMode(sno, ZappiBoostMode.Smart, 22, '0615');
 console.log(result);
 ```
+### Get Zappi boost times
+Gets the boost charge times schedule. Returns the times as list of 4 available slots.
+```typescript
+const result = await myenergi.getZappiBoostTimes(sno);
+console.log(result);
+```
+### Set Zappi boost time
+Sets the boost time schedule. 
+
+The arguments are:
+1. Serial number of zappi device
+2. The slot number (obtained by calling getZappiBoostTimes and likely to be 11-14)
+3. Start hour (0-23)
+4. Start minutes (must be 0, 15, 30 or 45)
+5. Duration hours (0-9)
+6. Duration minutes (must be 0, 15, 30 or 45)
+7. Day enablements (always starts with zero and the following seven digits are Monday-Sunday))
+
+```typescript
+const result = await myenergi.setZappiBoostTime(sno, 11, 23, 45, 2, 30, '01111111');
+console.log(result);
+```
 
 ### Get status for all Harvi devices
 Return status of all Harvi devices connected to the hub.

package/dist/src/MyEnergi.d.ts

@@ -1,8 +1,9 @@
 import { AppKeyValues } from './models/AppKeyValues';
 import { Eddi } from "./models/Eddi";
 import { Harvi } from "./models/Harvi";
+import { HistoryRecord } from './models/HistoryRecord';
 import { KeyValue } from './models/KeyValue';
-import { EddiBoost, EddiMode, ZappiBoostMode, ZappiChargeMode } from "./models/Types";
+import { EddiBoost, EddiMode, ZappiBoostMode, ZappiChargeMode, ZappiPhaseSetting } from "./models/Types";
 import { Zappi } from "./models/Zappi";
 export declare class MyEnergi {
     private _config;
@@ -14,6 +15,10 @@ export declare class MyEnergi {
     setZappiChargeMode(serialNo: string, chargeMode: ZappiChargeMode): Promise<any>;
     setZappiBoostMode(serialNo: string, boostMode: ZappiBoostMode, kwh?: number, completeTime?: string): Promise<any>;
     setZappiGreenLevel(serialNo: string, percentage: number): Promise<any>;
+    setZappiPhaseSetting(serialNo: string, phaseSetting: ZappiPhaseSetting): Promise<any>;
+    getDayHourHistory(id: string, year: number, month: number, day: number, startHour?: number, noHours?: number): Promise<HistoryRecord[]>;
+    getZappiBoostTimes(serialNo: string): Promise<any>;
+    setZappiBoostTime(serialNo: string, slot: number, startHour: number, startMinute: number, durationHour: number, durationMinute: number, daySpec: string): Promise<any>;
     getStatusEddiAll(): Promise<Eddi[]>;
     getStatusEddi(serialNumber: string): Promise<Eddi | null>;
     setEddiMode(serialNo: string, mode: EddiMode): Promise<any>;

package/dist/src/MyEnergi.js

@@ -25,6 +25,8 @@ class MyEnergi {
             dayhour_url: "/cgi-jdayhour-",
             zappi_mode_url: "/cgi-zappi-mode-Z",
             zappi_min_green_url: "/cgi-set-min-green-Z",
+            zappi_phase_setting_url: "/cgi-zappi-phase-setting-Z",
+            zappi_boost_time_url: "/cgi-boost-time-Z",
             eddi_mode_url: "/cgi-eddi-mode-E",
             eddi_boost_url: "/cgi-eddi-boost-E",
             get_app_key_url: "/cgi-get-app-key",
@@ -128,6 +130,67 @@ class MyEnergi {
             }
         });
     }
+    setZappiPhaseSetting(serialNo, phaseSetting) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const url = new URL(`${this._config.zappi_phase_setting_url}${serialNo}-${phaseSetting}`, this._config.base_url);
+                const data = yield this._digest.get(url);
+                const jsonData = JSON.parse(data);
+                return jsonData;
+            }
+            catch (error) {
+                return {};
+            }
+        });
+    }
+    getDayHourHistory(id, year, month, day, startHour, noHours) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let path = `${this._config.dayhour_url}${id}-${year}-${month}-${day}`;
+                if (startHour !== undefined) {
+                    path += `-${startHour}`;
+                    if (noHours !== undefined) {
+                        path += `-${noHours}`;
+                    }
+                }
+                const url = new URL(path, this._config.base_url);
+                const data = yield this._digest.get(url);
+                const jsonData = JSON.parse(data);
+                const key = Object.keys(jsonData)[0];
+                const records = key ? jsonData[key] : undefined;
+                return Array.isArray(records) ? records : [];
+            }
+            catch (error) {
+                return [];
+            }
+        });
+    }
+    getZappiBoostTimes(serialNo) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const url = new URL(`${this._config.zappi_boost_time_url}${serialNo}`, this._config.base_url);
+                const data = yield this._digest.get(url);
+                const jsonData = JSON.parse(data);
+                return jsonData;
+            }
+            catch (error) {
+                return {};
+            }
+        });
+    }
+    setZappiBoostTime(serialNo, slot, startHour, startMinute, durationHour, durationMinute, daySpec) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const url = new URL(`${this._config.zappi_boost_time_url}${serialNo}-${slot}-${startHour.toString().padStart(2, '0')}${startMinute.toString().padStart(2, '0')}-${durationHour}${durationMinute.toString().padStart(2, '0')}-${daySpec}`, this._config.base_url);
+                const data = yield this._digest.get(url);
+                const jsonData = JSON.parse(data);
+                return jsonData;
+            }
+            catch (error) {
+                return {};
+            }
+        });
+    }
     getStatusEddiAll() {
         return __awaiter(this, void 0, void 0, function* () {
             try {

package/dist/src/index.d.ts

@@ -1,6 +1,7 @@
 import { Eddi } from "./models/Eddi";
 import { Harvi } from "./models/Harvi";
-import { EddiBoost, EddiHeaterStatus, EddiMode, ZappiBoostMode, ZappiChargeMode, ZappiStatus } from "./models/Types";
+import { HistoryRecord } from "./models/HistoryRecord";
+import { EddiBoost, EddiHeaterStatus, EddiMode, ZappiBoostMode, ZappiChargeMode, ZappiPhaseSetting, ZappiStatus } from "./models/Types";
 import { Zappi } from "./models/Zappi";
 import { MyEnergi } from "./MyEnergi";
-export { MyEnergi, Eddi, Zappi, Harvi, EddiBoost, EddiMode, EddiHeaterStatus, ZappiBoostMode, ZappiChargeMode, ZappiStatus };
+export { MyEnergi, Eddi, Zappi, Harvi, HistoryRecord, EddiBoost, EddiMode, EddiHeaterStatus, ZappiBoostMode, ZappiChargeMode, ZappiPhaseSetting, ZappiStatus };

package/dist/src/index.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZappiStatus = exports.ZappiChargeMode = exports.ZappiBoostMode = exports.EddiHeaterStatus = exports.EddiMode = exports.EddiBoost = exports.MyEnergi = void 0;
+exports.ZappiStatus = exports.ZappiPhaseSetting = exports.ZappiChargeMode = exports.ZappiBoostMode = exports.EddiHeaterStatus = exports.EddiMode = exports.EddiBoost = exports.MyEnergi = void 0;
 const Types_1 = require("./models/Types");
 Object.defineProperty(exports, "EddiBoost", { enumerable: true, get: function () { return Types_1.EddiBoost; } });
 Object.defineProperty(exports, "EddiHeaterStatus", { enumerable: true, get: function () { return Types_1.EddiHeaterStatus; } });
 Object.defineProperty(exports, "EddiMode", { enumerable: true, get: function () { return Types_1.EddiMode; } });
 Object.defineProperty(exports, "ZappiBoostMode", { enumerable: true, get: function () { return Types_1.ZappiBoostMode; } });
 Object.defineProperty(exports, "ZappiChargeMode", { enumerable: true, get: function () { return Types_1.ZappiChargeMode; } });
+Object.defineProperty(exports, "ZappiPhaseSetting", { enumerable: true, get: function () { return Types_1.ZappiPhaseSetting; } });
 Object.defineProperty(exports, "ZappiStatus", { enumerable: true, get: function () { return Types_1.ZappiStatus; } });
 const MyEnergi_1 = require("./MyEnergi");
 Object.defineProperty(exports, "MyEnergi", { enumerable: true, get: function () { return MyEnergi_1.MyEnergi; } });

package/dist/src/models/HistoryRecord.d.ts

@@ -0,0 +1,27 @@
+export interface HistoryRecord {
+    min?: number;
+    hr?: number;
+    dow?: string;
+    dom?: number;
+    mon?: number;
+    yr?: number;
+    imp?: number;
+    exp?: number;
+    gep?: number;
+    gen?: number;
+    h1d?: number;
+    h1b?: number;
+    h2d?: number;
+    h2b?: number;
+    h3d?: number;
+    h3b?: number;
+    pect1?: number;
+    nect1?: number;
+    pect2?: number;
+    nect2?: number;
+    pect3?: number;
+    nect3?: number;
+    v1?: number;
+    frq?: number;
+    pst?: string;
+}

package/dist/src/models/HistoryRecord.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/models/Types.d.ts

@@ -40,3 +40,8 @@ export declare enum ZappiStatus {
     Charging = "C2",
     Fault = "F"
 }
+export declare enum ZappiPhaseSetting {
+    SinglePhase = 0,
+    ThreePhase = 1,
+    Auto = 2
+}

package/dist/src/models/Types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZappiStatus = exports.ZappiChargeMode = exports.ZappiBoostMode = exports.EddiMode = exports.EddiHeaterStatus = exports.EddiBoost = void 0;
+exports.ZappiPhaseSetting = exports.ZappiStatus = exports.ZappiChargeMode = exports.ZappiBoostMode = exports.EddiMode = exports.EddiHeaterStatus = exports.EddiBoost = void 0;
 var EddiBoost;
 (function (EddiBoost) {
     EddiBoost["CancelHeater1"] = "1-1";
@@ -49,3 +49,9 @@ var ZappiStatus;
     ZappiStatus["Charging"] = "C2";
     ZappiStatus["Fault"] = "F";
 })(ZappiStatus = exports.ZappiStatus || (exports.ZappiStatus = {}));
+var ZappiPhaseSetting;
+(function (ZappiPhaseSetting) {
+    ZappiPhaseSetting[ZappiPhaseSetting["SinglePhase"] = 0] = "SinglePhase";
+    ZappiPhaseSetting[ZappiPhaseSetting["ThreePhase"] = 1] = "ThreePhase";
+    ZappiPhaseSetting[ZappiPhaseSetting["Auto"] = 2] = "Auto";
+})(ZappiPhaseSetting = exports.ZappiPhaseSetting || (exports.ZappiPhaseSetting = {}));

package/dist/src/models/Zappi.d.ts

@@ -46,4 +46,5 @@ export interface Zappi {
     rrac: number;
     zs: number;
     zsl: number;
+    phaseSetting?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "myenergi-api",
-    "version": "2.5.0",
+    "version": "2.7.0",
     "description": "NodeJS implementation of MyEnergi API for controlling Zappi, Eddi and other MyEnergi products",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",