iobroker.senec 1.1.1 → 1.3.3

package/main.js

@@ -1,16 +1,9 @@
 'use strict';
 
-/*
- * Created with @iobroker/create-adapter v1.17.0
- */
-
 const utils = require('@iobroker/adapter-core');
 const request = require('request');
-const mode_desc = require(__dirname + '/lib/mode_desc.js');
-const sys_type_desc = require(__dirname + '/lib/sys_type_desc.js');
-const country_desc = require(__dirname + '/lib/country_desc.js');
-const batt_type_desc = require(__dirname + '/lib/batt_type_desc.js');
 const state_attr = require(__dirname + '/lib/state_attr.js');
+const state_trans = require(__dirname + '/lib/state_trans.js');
 
 let retry = 0; // retry-counter
 let retryLowPrio = 0; // retry-counter
@@ -61,7 +54,7 @@ class Senec extends utils.Adapter {
                 clearTimeout(this.timerLowPrio);
             }
             this.log.info('cleaned everything up...');
-            this.setState('info.connection', false, false);
+            this.setState('info.connection', false, true);
             callback();
         } catch (e) {
             callback();
@@ -163,24 +156,14 @@ class Senec extends utils.Adapter {
         form += ',"PWR_UNIT":{"POWER_L1":"","POWER_L2":"","POWER_L3":""}';
         form += ',"PM1OBJ1":{"FREQ":"","U_AC":"","I_AC":"","P_AC":"","P_TOTAL":""}';
         form += ',"PM1OBJ2":{"FREQ":"","U_AC":"","I_AC":"","P_AC":"","P_TOTAL":""}';
+		form += ',"STATISTIC":{"LIVE_GRID_EXPORT":"","LIVE_GRID_IMPORT":"","LIVE_HOUSE_CONS":"","LIVE_PV_GEN":"","LIVE_BAT_CHARGE_MASTER":"","LIVE_BAT_DISCHARGE_MASTER":""}';
         form += '}';
-
+			
         try {
             const body = await this.doGet(url, form, this, this.config.pollingTimeout);
             var obj = JSON.parse(body, reviverNumParse);
-
             await this.evalPoll(obj);
 
-            // this isn't part of the JSON but we supply it as an additional state for easier reading of system-mode
-            const key = "ENERGY.STAT_STATE_Text";
-            const desc = (state_attr[key] !== undefined) ? state_attr[key].name : "undefined";
-            const unit = (state_attr[key] !== undefined) ? state_attr[key].unit : "";
-            if (mode_desc[obj.ENERGY.STAT_STATE] === undefined) {
-                this.log.warn('Senec mode definition missing for + ' + obj.ENERGY.STAT_STATE);
-            }
-            var value = (mode_desc[obj.ENERGY.STAT_STATE] !== undefined) ? mode_desc[obj.ENERGY.STAT_STATE].name : "unknown";
-            this.doState(key, value, desc, unit);
-
             retry = 0;
             this.timer = setTimeout(() => this.readSenecV21(), this.config.interval * 1000);
         } catch (error) {
@@ -204,7 +187,7 @@ class Senec extends utils.Adapter {
         // we are polling all known objects ...
 
         const url = 'http://' + this.config.senecip + '/lala.cgi';
-        const form = '{"STATISTIC":{},"ENERGY":{},"FEATURES":{},"LOG":{},"SYS_UPDATE":{},"WIZARD":{},"BMS":{},"BAT1":{},"BAT1OBJ1":{},"BAT1OBJ2":{},"BAT1OBJ2":{},"BAT1OBJ3":{},"BAT1OBJ4":{},"PWR_UNIT":{},"PV1":{},"FACTORY":{},"GRIDCONFIG":{}}';
+        const form = '{"STATISTIC":{},"ENERGY":{},"FEATURES":{},"LOG":{},"SYS_UPDATE":{},"WIZARD":{},"BMS":{},"BAT1":{},"BAT1OBJ1":{},"BAT1OBJ2":{},"BAT1OBJ2":{},"BAT1OBJ3":{},"BAT1OBJ4":{},"PWR_UNIT":{},"PM1OBJ1":{},"PM1OBJ2":{},"PV1":{},"FACTORY":{},"GRIDCONFIG":{},"EG_CONTROL":{},"RTC":{},"PM1":{},"TEMPMEASURE":{},"DEBUG":{},"SOCKETS":{},"CASC":{},"WALLBOX":{},"CONNX50":{},"STECA":{}}';
 
         try {
             const body = await this.doGet(url, form, this, this.config.pollingTimeout);
@@ -229,7 +212,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) {
+    async doState(name, value, description, unit, write) {
         await this.setObjectNotExistsAsync(name, {
             type: 'state',
             common: {
@@ -238,7 +221,7 @@ class Senec extends utils.Adapter {
                 role: 'value',
                 unit: unit,
                 read: true,
-                write: false
+                write: write
             },
             native: {}
         });
@@ -257,19 +240,59 @@ 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) {
-            if (oldState.val === value)
+            if (oldState.val === value) {
+				await this.checkUpdateSelfStat(name);
                 return;
+			}
             this.log.silly('Update: ' + name + ': ' + oldState.val + ' -> ' + value);
         }
         await this.setStateAsync(name, {
             val: value,
             ack: true
         });
-    }
+		await this.checkUpdateSelfStat(name);
+		await this.doDecode(name, value);
+	}
+		
+	/**
+	 * Checks if there is decoding possible for a given value and creates/updates a decoded state
+	 * Language used for translations is the language of the SENEC appliance
+	 */
+	async doDecode(name, value) {
+		// Lang: WIZARD.GUI_LANG 0=German, 1=English, 2=Italian
+		var lang = 1; // fallback to english
+		var langState = await this.getStateAsync('WIZARD.GUI_LANG');
+		if (langState) lang = langState.val;
+		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);
+		
+		if (state_trans[key + "." + lang] !== undefined) {
+			this.log.silly("Trans found for: " + key + "." + lang);
+			const trans = (state_trans[key + "." + lang] !== undefined ? (state_trans[key + "." + lang][value] !== undefined ? state_trans[key + "." + lang][value] : "(unknown)") : "(unknown)");
+			this.log.debug("Trans " + key + ":" + value + " = " + trans);
+			const desc = (state_attr[key + "_Text"] !== undefined) ? state_attr[key + "_Text"].name : key;
+			await this.doState(name + "_Text", trans, desc, "", true);
+		}
+	}
 
+	/** 
+	 * 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") {
+			await this.updateSelfStat(name);
+		}
+	}
+	
 	/**
 	 * evaluates data polled from SENEC system.
 	 * creates / updates the state.
@@ -287,15 +310,112 @@ class Senec extends utils.Adapter {
 
                     if (Array.isArray(value2)) {
                         for (var i = 0; i < value2.length; i++) {
-                            this.doState(key + '.' + i, ValueTyping(key, value2[i]), desc + '[' + i + ']', unit);
+                            this.doState(key + '.' + i, ValueTyping(key, value2[i]), desc + '[' + i + ']', unit, false);
                         }
                     } else {
-                        this.doState(key, ValueTyping(key, value2), desc, unit);
+                        this.doState(key, ValueTyping(key, value2), desc, unit, false);
                     }
                 }
             }
         }
     }
+	
+	async updateSelfStat(name, value) {
+		await this.updateSelfStatHelper(name, value, ".today", ".yesterday", ".refValue", "Day", getCurDay());
+		await this.updateSelfStatHelper(name, value, ".week", ".lastWeek", ".refValueWeek", "Week", getCurWeek());
+		await this.updateSelfStatHelper(name, value, ".month", ".lastMonth", ".refValueMonth", "Month", getCurMonth());
+		await this.updateSelfStatHelper(name, value, ".year", ".lastYear", ".refValueYear", "Year", getCurYear());
+		return;		
+	}
+	
+	async updateSelfStatHelper(name, value, today, yesterday, refValue, day, curDay) {
+		const key = "_calc." + name.substring(10);
+		
+		const refDayObj = await this.getStateAsync(key + ".ref" + day);
+		const refDay = refDayObj ? refDayObj.val : -1;
+		
+		const valCurObj = await this.getStateAsync(name);
+		const valCur = valCurObj ? valCurObj.val : 0;
+		
+		const valRefObj = await this.getStateAsync(key + refValue);
+		const valRef = valRefObj ? valRefObj.val : 0;
+		const valTodayObj = await this.getStateAsync(key + today);
+		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 : "";
+		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 descRef = (state_attr[key + refValue] !== undefined) ? state_attr[key + refValue].name : key;
+        const unitRef = (state_attr[key + refValue] !== undefined) ? state_attr[key + refValue].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 stat data for: " + name.substring(10));
+			// 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);
+			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));
+			// update today's value
+			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
+		}
+		this.log.debug("Updating Autarky " + day +" value for: " + key + today);
+		// update today's value - but beware of div/0
+		if (valHouseCons > 0) await this.doState(key + today, Number((((valPVGen - valGridExp - valBatCharge + valBatDischarge) / valHouseCons) * 100).toFixed(0)), descToday, unitToday, false);
+	}
+
 }
 
 /**
@@ -304,15 +424,6 @@ class Senec extends utils.Adapter {
  */
 const ValueTyping = (key, value) => {
 	if (!isNaN(value)) value = Number(value); // otherwise iobroker will note it as string
-	if (key === "FACTORY.SYS_TYPE") {
-        return (sys_type_desc[value] !== undefined) ? sys_type_desc[value].name : "unknown";
-	}
-	if (key === "FACTORY.COUNTRY") {
-        return (country_desc[value] !== undefined) ? country_desc[value].name : "unknown";
-	}
-	if (key === "FACTORY.BAT_TYPE") {
-        return (batt_type_desc[value] !== undefined) ? batt_type_desc[value].name : "unknown";
-	}
     if (state_attr[key] === undefined) {
         return value;
     }
@@ -430,8 +541,44 @@ const reviverNumParse = (key, value) => {
     }
 }
 
-// @ts-ignore parent is a valid property on module
-if (module.parent) {
+/**
+ * Returns the current day of the year
+ */
+const getCurDay = () => {
+	return (Math.round((new Date().setHours(23) - new Date(new Date().getYear()+1900, 0, 1, 0, 0, 0))/1000/60/60/24));
+}
+
+/**
+ * Returns the current month of the year
+ */
+const getCurMonth = () => {
+	return (new Date().getMonth());
+}
+
+/**
+ * Returns the current year
+ */
+const getCurYear = () => {
+	return (new Date().getFullYear());
+}
+
+/**
+ * Returns the current week of the year
+ * Using Standard ISO8601
+ */
+const getCurWeek = () => {
+	var tdt = new Date();
+    var dayn = (tdt.getDay() + 6) % 7;
+    tdt.setDate(tdt.getDate() - dayn + 3);
+    var firstThursday = tdt.valueOf();
+    tdt.setMonth(0, 1);
+    if (tdt.getDay() !== 4) {
+		tdt.setMonth(0, 1 + ((4 - tdt.getDay()) + 7) % 7);
+    }
+    return 1 + Math.ceil((firstThursday - tdt) / 604800000);
+}
+
+if (require.main !== module) {
     // Export the constructor in compact mode
     /**
      * @param {Partial<ioBroker.AdapterOptions>} [options={}]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.senec",
-  "version": "1.1.1",
+  "version": "1.3.3",
   "description": "Senec Home",
   "author": {
     "name": "NoBl",
@@ -25,38 +25,49 @@
   },
   "dependencies": {
     "request": "^2.88.2",
-    "@iobroker/adapter-core": "^2.4.0"
+    "@iobroker/adapter-core": "^2.5.1"
   },
   "devDependencies": {
-    "@iobroker/testing": "^2.3.0",
-    "@types/chai": "^4.2.14",
-    "@types/chai-as-promised": "^7.1.3",
-    "@types/gulp": "^4.0.7",
-    "@types/mocha": "^8.0.4",
-    "@types/node": "^14.14.10",
+	"@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.9",
-    "@types/sinon-chai": "^3.2.5",
-    "axios": "^0.21.1",
-    "chai": "^4.2.0",
+    "@types/sinon": "^10.0.6",
+    "@types/sinon-chai": "^3.2.8",
+    "axios": "^0.25.0",
+    "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^7.14.0",
+    "eslint": "^8.8.0",
     "gulp": "^4.0.2",
-    "mocha": "^8.2.1",
+    "mocha": "^9.1.3",
     "proxyquire": "^2.1.3",
-    "sinon": "^9.2.1",
-    "sinon-chai": "^3.5.0",
-	"typescript": "^4.1.2"
+    "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/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): 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
-	}