iobroker.senec 1.3.0 → 1.3.4

package/main.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const utils = require('@iobroker/adapter-core');
-const request = require('request');
+const axios = require('axios');
 const state_attr = require(__dirname + '/lib/state_attr.js');
 const state_trans = require(__dirname + '/lib/state_trans.js');
 
@@ -110,30 +110,43 @@ class Senec extends utils.Adapter {
     }
 
     /**
-     * Read from url via request
+     * Read from url via axios
      * @param url to read from
      * @param form to post
      */
-    async doGet(pUrl, pForm, caller, pollingTimeout) {
-        return new Promise(function (resolve, reject) {
-            const options = {
-                url: pUrl,
-                method: 'POST',
-                form: pForm,
-                timeout: pollingTimeout
-            };
-            request(options, function (error, response, body) {
-                if (error)
-                    return reject(error);
-                caller.log.debug('Status: ' + response.statusCode);
-                if (!response || response.statusCode !== 200)
-                    return reject('Cannot read from SENEC: ' + response.statusCode);
-                caller.log.debug('Response: ' + JSON.stringify(response));
-                caller.log.debug('Body: ' + body);
-                resolve(body);
-            });
-        });
-    }
+	async doGet(pUrl, pForm, caller, pollingTimeout) {
+		return new Promise(function (resolve, reject) {
+			axios({
+				method: 'post',
+				url: pUrl,
+				data: pForm,
+				timeout: pollingTimeout
+			}).then(
+				async (response) => {
+                        const content = response.data;
+                        caller.log.debug('received data (' + response.status + '): ' + JSON.stringify(content));
+						resolve(JSON.stringify(content));
+                    }
+                ).catch(
+                    (error) => {
+                        if (error.response) {
+                            // The request was made and the server responded with a status code
+                            caller.log.warn('received error ' + error.response.status + ' response from SENEC with content: ' + JSON.stringify(error.response.data));
+							reject(error.response.status);
+                        } else if (error.request) {
+                            // The request was made but no response was received
+                            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of http.ClientRequest in node.js<div></div>
+                            caller.log.info(error.message);
+							reject(error.message);
+                        } else {
+                            // Something happened in setting up the request that triggered an Error
+                            caller.log.info(error.message);
+							reject(error.status);
+                        }
+                    }
+                );
+		});
+	}
 
     /**
      * Read values from Senec Home V2.1
@@ -213,6 +226,7 @@ class Senec extends utils.Adapter {
      * sets a state's value and creates the state if it doesn't exist yet
      */
     async doState(name, value, description, unit, write) {
+		this.log.silly('Update: ' + name + ': ' + value);
         await this.setObjectNotExistsAsync(name, {
             type: 'state',
             common: {
@@ -240,6 +254,10 @@ class Senec extends utils.Adapter {
 			this.log.debug("Updating object: " + name + " (unit): " + obj.common.unit + " -> " + unit);
 			await this.extendObject(name, {common: {unit: unit}});
 		}
+		if (obj.common.write != write) {
+			this.log.debug("Updating object: " + name + " (write): " + obj.common.write + " -> " + write);
+			await this.extendObject(name, {common: {write: write}});
+		}
 
         var oldState = await this.getStateAsync(name);
         if (oldState) {
@@ -266,7 +284,7 @@ class Senec extends utils.Adapter {
 		var lang = 1; // fallback to english
 		var langState = await this.getStateAsync('WIZARD.GUI_LANG');
 		if (langState) lang = langState.val;
-		this.log.debug("Senec language: " + lang);
+		this.log.silly("Senec language: " + lang);
 		var key = name;
 		if (!isNaN(name.substring(name.lastIndexOf('.')) + 1)) key = name.substring(0, name.lastIndexOf('.'));
 		this.log.silly("Checking: " + name + " -> " + key);
@@ -284,7 +302,7 @@ class Senec extends utils.Adapter {
 	 * Helper routine
 	 */
 	async checkUpdateSelfStat(name) {
-		if (name == "STATISTIC.LIVE_GRID_EXPORT" || name == "STATISTIC.LIVE_GRID_IMPORT" || name == "STATISTIC.LIVE_HOUSE_CONS" || name == "STATISTIC.LIVE_PV_GEN" || name == "STATISTIC.LIVE_BAT_CHARGE_MASTER" || name == "STATISTIC.LIVE_BAT_DISCHARGE_MASTER") {
+		if (name === "STATISTIC.LIVE_GRID_EXPORT" || name === "STATISTIC.LIVE_GRID_IMPORT" || name === "STATISTIC.LIVE_HOUSE_CONS" || name === "STATISTIC.LIVE_PV_GEN" || name === "STATISTIC.LIVE_BAT_CHARGE_MASTER" || name === "STATISTIC.LIVE_BAT_DISCHARGE_MASTER") {
 			await this.updateSelfStat(name);
 		}
 	}
@@ -328,17 +346,15 @@ class Senec extends utils.Adapter {
 		const key = "_calc." + name.substring(10);
 		
 		const refDayObj = await this.getStateAsync(key + ".ref" + day);
-		var refDay = refDayObj ? refDayObj.val : -1;
+		const refDay = refDayObj ? refDayObj.val : -1;
 		
 		const valCurObj = await this.getStateAsync(name);
-		var valCur = valCurObj ? valCurObj.val : 0;
+		const valCur = valCurObj ? valCurObj.val : 0;
 		
 		const valRefObj = await this.getStateAsync(key + refValue);
-		var valRef = valRefObj ? valRefObj.val : 0;
+		const valRef = valRefObj ? valRefObj.val : 0;
 		const valTodayObj = await this.getStateAsync(key + today);
-		var valToday = valTodayObj ? valTodayObj.val : 0;
-		const valYesterdayObj = await this.getStateAsync(key + yesterday);
-		var valYesterday = valYesterdayObj ? valYesterdayObj.val : 0;
+		const valToday = valTodayObj ? valTodayObj.val : 0;
 		
 		const descToday = (state_attr[key + today] !== undefined) ? state_attr[key + today].name : key;
         const unitToday = (state_attr[key + today] !== undefined) ? state_attr[key + today].unit : "";
@@ -352,17 +368,69 @@ class Senec extends utils.Adapter {
 		if (refDay != curDay) {
 			this.log.debug("New " + day + " (or first value seen). Updating stat data for: " + name.substring(10));
 			// Change of day
-			await this.doState(key + ".ref" + day, curDay, descRefDay, unitRefDay, true);
-			await this.doState(key + yesterday, valToday, descYesterday, unitYesterday, true);
-			await this.doState(key + today, 0, descToday, unitToday, true);
-			await this.doState(key + refValue, valCur, descRef, unitRef, true);
+			await this.doState(key + ".ref" + day, curDay, descRefDay, unitRefDay, false);
+			await this.doState(key + yesterday, valToday, descYesterday, unitYesterday, false);
+			await this.doState(key + today, 0, descToday, unitToday, false);
+			if (valRef < valCur) {
+				await this.doState(key + refValue, valCur, descRef, unitRef, true);
+			} else {
+				this.log.warning("Not updating reference value for: " + name.substring(10) + "! Old RefValue (" + valRef + ") >= new RefValue (" + valCur + "). Impossible situation. If this is intentional, please update via admin!");
+			}
 		} else {
-			this.log.debug("Updating " + day +" value for: " + name.substring(10));
+			this.log.debug("Updating " + day +" value for: " + name.substring(10) + ": " + Number((valCur - valRef).toFixed(2)));
 			// update today's value
-			await this.doState(key + today, Number((valCur - valRef).toFixed(2)), descToday, unitToday, true);
+			await this.doState(key + today, Number((valCur - valRef).toFixed(2)), descToday, unitToday, false);
 		}
+		
+		if (name === "STATISTIC.LIVE_HOUSE_CONS") await this.updateAutarkyHelper(today, yesterday, day, curDay); // otherwise we get way too many updates
 
 	}
+	
+	async updateAutarkyHelper(today, yesterday, day, curDay) {
+		const key = "_calc.Autarky";
+		
+		// reference object to decide on change of day
+		const refDayObj = await this.getStateAsync(key + ".ref" + day);
+		const refDay = refDayObj ? refDayObj.val : -1;
+		// current day's value (needed in case of day-change)
+		const valTodayObj = await this.getStateAsync(key + today);
+		const valToday = valTodayObj ? valTodayObj.val : 0;
+		
+		// reading values required for calc
+		const valBatChargeObj = await this.getStateAsync("_calc.LIVE_BAT_CHARGE_MASTER" + today);
+		const valBatCharge = valBatChargeObj ? valBatChargeObj.val : 0;
+		const valBatDischargeObj = await this.getStateAsync("_calc.LIVE_BAT_DISCHARGE_MASTER" + today);
+		const valBatDischarge = valBatDischargeObj ? valBatDischargeObj.val : 0;
+		const valGridExpObj = await this.getStateAsync("_calc.LIVE_GRID_EXPORT" + today);
+		const valGridExp = valGridExpObj ? valGridExpObj.val : 0;
+		const valGridImpObj = await this.getStateAsync("_calc.LIVE_GRID_IMPORT" + today);
+		const valGridImp = valGridImpObj ? valGridImpObj.val : 0;
+		const valHouseConsObj = await this.getStateAsync("_calc.LIVE_HOUSE_CONS" + today);
+		const valHouseCons = valHouseConsObj ? valHouseConsObj.val : 1;
+		const valPVGenObj = await this.getStateAsync("_calc.LIVE_PV_GEN" + today);
+		const valPVGen = valPVGenObj ? valPVGenObj.val : 0;
+			
+		const descToday = (state_attr[key + today] !== undefined) ? state_attr[key + today].name : key;
+        const unitToday = (state_attr[key + today] !== undefined) ? state_attr[key + today].unit : "%";
+		const descYesterday = (state_attr[key + yesterday] !== undefined) ? state_attr[key + yesterday].name : key;
+        const unitYesterday = (state_attr[key + yesterday] !== undefined) ? state_attr[key + yesterday].unit : "%";
+		const descRefDay = (state_attr[key + ".ref" + day] !== undefined) ? state_attr[key + ".ref" + day].name : key;
+        const unitRefDay = (state_attr[key + ".ref" + day] !== undefined) ? state_attr[key + ".ref" + day].unit : "";
+		
+		if (refDay != curDay) {
+			this.log.debug("New " + day + " (or first value seen). Updating Autarky data for: " + key + " " + day);
+			// Change of day
+			await this.doState(key + ".ref" + day, curDay, descRefDay, unitRefDay, false);
+			await this.doState(key + yesterday, valToday, descYesterday, unitYesterday, false);
+			// await this.doState(key + today, 0, descToday, unitToday, false); // we don't need to reset autarky to 0 because it is calculated by reference values.
+			// instead do the regular calc right after the change of day
+		}
+		// update today's value - but beware of div/0
+		var newVal = 0;
+		if (valHouseCons > 0) newVal = Number((((valPVGen - valGridExp - valBatCharge + valBatDischarge) / valHouseCons) * 100).toFixed(0));
+		this.log.debug("Updating Autarky " + day +" value for: " + key + today + ": " + newVal);
+		if (valHouseCons > 0) await this.doState(key + today, newVal, descToday, unitToday, false);
+	}
 
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.senec",
-  "version": "1.3.0",
+  "version": "1.3.4",
   "description": "Senec Home",
   "author": {
     "name": "NoBl",
@@ -24,39 +24,49 @@
     "url": "https://github.com/nobl/ioBroker.senec.git"
   },
   "dependencies": {
-    "request": "^2.88.2",
-    "@iobroker/adapter-core": "^2.4.0"
+    "axios": "^0.25.0",
+    "@iobroker/adapter-core": "^2.5.1"
   },
   "devDependencies": {
-    "@iobroker/testing": "^2.4.4",
-    "@types/chai": "^4.2.16",
-    "@types/chai-as-promised": "^7.1.3",
-    "@types/gulp": "^4.0.8",
-    "@types/mocha": "^8.2.2",
-    "@types/node": "^14.14.37",
+    "@alcalzone/release-script": "^3.5.2",
+    "@iobroker/testing": "^2.5.2",
+    "@types/chai": "^4.3.0",
+    "@types/chai-as-promised": "^7.1.4",
+    "@types/gulp": "^4.0.9",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^17.0.17",
     "@types/proxyquire": "^1.3.28",
-    "@types/sinon": "^9.0.11",
-    "@types/sinon-chai": "^3.2.5",
-    "axios": "^0.21.1",
-    "chai": "^4.3.4",
+    "@types/sinon": "^10.0.6",
+    "@types/sinon-chai": "^3.2.8",
+    "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^7.23.0",
+    "eslint": "^8.8.0",
     "gulp": "^4.0.2",
-    "mocha": "^8.3.2",
+    "mocha": "^9.1.3",
     "proxyquire": "^2.1.3",
-    "sinon": "^10.0.0",
-    "sinon-chai": "^3.6.0",
-	"typescript": "^4.2.3"
+    "sinon": "^12.0.1",
+    "sinon-chai": "^3.7.0",
+    "typescript": "~4.5.5"
   },
   "main": "main.js",
+  "files": [
+    "admin{,/!(src)/**}/!(tsconfig|tsconfig.*).json",
+    "admin{,/!(src)/**}/*.{html,css,png,svg,jpg,js}",
+    "lib/",
+    "www/",
+    "io-package.json",
+    "LICENSE",
+    "main.js"
+  ],
   "scripts": {
     "test:js": "mocha --config test/mocharc.custom.json \"{!(node_modules|test)/**/*.test.js,*.test.js,test/**/test!(PackageFiles|Startup).js}\"",
-	    "test:package": "mocha test/package --exit",
-	    "test:unit": "mocha test/unit --exit",
-	    "test:integration": "mocha test/integration --exit",
-	    "test": "npm run test:js && npm run test:package",
-	    "check": "tsc --noEmit -p tsconfig.check.json",
-	    "lint": "eslint"
+    "test:package": "mocha test/package --exit",
+    "test:unit": "mocha test/unit --exit",
+    "test:integration": "mocha test/integration --exit",
+    "test": "npm run test:js && npm run test:package",
+    "check": "tsc --noEmit -p tsconfig.check.json",
+    "lint": "eslint",
+    "release": "release-script"
   },
   "bugs": {
     "url": "https://github.com/nobl/ioBroker.senec/issues"

package/CHANGELOG_old.md

@@ -1,68 +0,0 @@
-The newest change log is [README.md](README.md)
-
-### 1.0.13 (NoBl)
-* Added System Description 19 for Senec.Home V3 Hybrid (Credits to noffycws)
-* Added Mode Descriptions for 86-91. (Credits to noffycws)
-
-### 1.0.12 (NoBl)
-* Just set 'supportCustoms' to false so it won't show up in admin custom config.
-
-### 1.0.11 (NoBl)
-* Update to current adapter template
-* Added Datapoints: PV1.MPP_CUR, MPP_VOL, MPP_POWER (former: MPP_INT which is unused at this moment but does still exist)
-* Added Datapoints (please feedback any improvements for their descriptions, ...): FEATURES.SGREADY, WIZARD.SETUP_WALLBOX_MAX_TOTAL_CURRENT_BY_GRID, WIZARD.SG_READY_CURR_MODE, BMS.ERROR, BMS.RECOVERLOCKED, BMS.SERIAL, BMS.START_SELFTEST, BAT1.RESET, BAT1.SELFTEST_ACT, BAT1.SELFTEST_LIMIT, BAT1.SELFTEST_OFF, BAT1.SELFTEST_OVERALL_STATE, BAT1.SELFTEST_STATE, BAT1.SELFTEST_STEP, BAT1.SELFTEST_TIME, BAT1.SERIAL, BAT1.TRIG_ITALY_SELF, BAT1OBJ1.COMM, GRIDCONFIG.AU_SOFT_RAMP_EN, GRIDCONFIG.AU_VRR_MAX, GRIDCONFIG.AU_VRR_MIN, GRIDCONFIG.AU_VVAR_PERCENTAGE, GRIDCONFIG.AU_VVAR_P_MAX, GRIDCONFIG.AU_VVAR_P_MIN, GRIDCONFIG.AU_VVAR_VOLTAGE, GRIDCONFIG.AU_VWC_VOLTAGE, GRIDCONFIG.AU_VWD_VOLTAGE, GRIDCONFIG.CEI_SEGNALE_ESTERNO, GRIDCONFIG.VDELVFRTDISABLE, GRIDCONFIG.VDEURMSMAX10
-
-### 1.0.10 (NoBl, smartpran)
-* DateType objects are stored as date again
-* changed WIZARD.SETUP_POWER_RULE unit to '%'
-* changed name of STATISTIC.STAT_SUM_E_PU to "STAT_SUM Energy PowerUnit"
-* changed name of STATISTIC.STAT_SUM_E_WB to "STAT_SUM Energy Wallbox"
-* changed name of STATISTIC.LIVE_WB_ENERGY to "Live Wallbox Energy"
-* changed name of STATISTIC.LIVE_PU_ENERGY to "Live PowerUnit Energy"
-* changed name of WIZARD.PWRCFG_PEAK_PV_POWER to "Configured Peak PV Power"
-* enforcing conversion of number values to Number(). Otherwise they are created as String in ioBroker (manually delete existing datapoints in ioBroker to change them!)
-* fixed representation for temp values (off by *10)
-* json delivers a non-value (apparently an error message produced by senec itself). Ignoring that.
-* Added variable mpp_int to high priority and changed unit it. (smartpran)
-
-### 1.0.9 (NoBl)
-* IP types are shown as IP again.
-* added datapoints for FACTORY along with more state descriptions for Battery Type, Country and System Type.
-* added datapoints for GRIDCONFIG
-
-### 1.0.8 (NoBl)
-* Added more states to known states (please feedback if they need special handling (unit, special description, value modification, ...))
-* Bugfix in creating debug data
-* Unknown states are now reported in debug instead of info.
-* Code cleanup
-
-### 1.0.7 (NoBl)
-* Reading all known states from SENEC.
-* Split states into high/low priority (heavy requesting the SENEC system renders it unable to sync with the SENEC datacenter!).
-* Updated adapter-core and testing versions along with current dev dependencies. Removed node 8 support.
-* Added more state descriptions to manual. But need input on these and those that are still not documented.
-
-### 1.0.6 (NoBl)
-* Moved senec states and state attributes to libs
-* Added missing state descriptions
-
-### 1.0.5 (2020-03-07) (NoBl)
-* Added States for: Energy: GUI_BAT_DATA_VOLTAGE, GUI_BAT_DATA_CURRENT, STAT_HOURS_OF_OPERATION; Sys_update: NPU_VER, NPU_IMAGE_VERSION, Wizard: APPLICATION_VERSION, INTERFACE_VERSION
-* Readme and Documentation (EN exists, now) updated
-* Changed behavior for unknown values completely. They will now be stored as string plus prefixed with "REPORT TO DEV:" so users can easily report back what needs updating.
-* added handling for "st_" values in json
-* added additional configuration options
-* changed retry-behaviour in case of connection issues, ...
-
-### 1.0.4 (2020-03-06)
-* (NoBl) Repo URL updated
-### 1.0.3 (2020-03-06)
-* (NoBl) added link to documentation in german
-### 1.0.2 (2020-03-04)
-* (NoBl) added missing status codes (85 in total now)
-* (NoBl) added status code to status message for easier reference
-* (NoBl) added states for wallboxes and battery modules
-### 1.0.1
-* (NoBl) updated readme
-### 1.0.0
-* (NoBl) initial release

package/admin/admin.d.ts

@@ -1,93 +0,0 @@
-declare let systemDictionary: Record<string, Record<string, string>>;
-	
-	declare let load: (settings: Record<string, unknown>, onChange: (hasChanges: boolean) => void) => void;
-	declare let save: (callback: (settings: Record<string, unknown>) => void) => void;
-	
-	// make load and save exist on the window object
-	interface Window {
-	    load: typeof load;
-	    save: typeof save;
-	}
-	
-	declare const instance: number;
-	declare const adapter: string;
-	/** Translates text */
-	declare function _(text: string, arg1?: string, arg2?: string, arg3?: string): string;
-	declare const socket: ioBrokerSocket;
-	declare function sendTo(
-	    instance: any | null,
-	    command: string,
-	    message: any,
-	    callback: (result: SendToResult) => void | Promise<void>,
-	): void;
-	
-	interface SendToResult {
-	    error?: string | Error;
-	    result?: any;
-	}
-	
-	// tslint:disable-next-line:class-name
-	interface ioBrokerSocket {
-	    emit(
-	        command: 'subscribeObjects',
-	        pattern: string,
-	        callback?: (err?: string) => void | Promise<void>,
-	    ): void;
-	    emit(
-	        command: 'subscribeStates',
-	        pattern: string,
-	        callback?: (err?: string) => void | Promise<void>,
-	    ): void;
-	    emit(
-	        command: 'unsubscribeObjects',
-	        pattern: string,
-	        callback?: (err?: string) => void | Promise<void>,
-	    ): void;
-	    emit(
-	        command: 'unsubscribeStates',
-	        pattern: string,
-	        callback?: (err?: string) => void | Promise<void>,
-	    ): void;
-	
-	    emit(
-	        event: 'getObjectView',
-	        view: 'system',
-	        type: 'device',
-	        options: ioBroker.GetObjectViewParams,
-	        callback: (
-	            err: string | undefined,
-	            result?: any,
-	        ) => void | Promise<void>,
-	    ): void;
-	    emit(
-	        event: 'getStates',
-	        callback: (
-	            err: string | undefined,
-	            result?: Record<string, any>,
-	        ) => void,
-	    ): void;
-	    emit(
-	        event: 'getState',
-	        id: string,
-	        callback: (err: string | undefined, result?: ioBroker.State) => void,
-	    ): void;
-	    emit(
-	        event: 'setState',
-	        id: string,
-	        state: unknown,
-	        callback: (err: string | undefined, result?: any) => void,
-	    ): void;
-	
-	    on(event: 'objectChange', handler: ioBroker.ObjectChangeHandler): void;
-	    on(event: 'stateChange', handler: ioBroker.StateChangeHandler): void;
-	    removeEventHandler(
-	        event: 'objectChange',
-	        handler: ioBroker.ObjectChangeHandler,
-	    ): void;
-	    removeEventHandler(
-	        event: 'stateChange',
-	        handler: ioBroker.StateChangeHandler,
-	    ): void;
-	
-	    // TODO: other events
-	}