iobroker.senec 1.6.1 → 1.6.3

package/README.md

@@ -366,6 +366,12 @@ This channel contains calculated values. Currently these are day/week/month/year
    *Read-only number, which designates the number of wallbox [0..3]. This is only available on systems with configured wallboxes.*
 
 ## Changelog
+### 1.6.3 (NoBl)
+* Code optimization
+
+### 1.6.2 (NoBl)
+* Added statistics values from API along with some own calculations.
+
 ### 1.6.1 (NoBl)
 * Bugfixes
 

package/io-package.json

@@ -1,8 +1,34 @@
 {
     "common": {
         "name": "senec",
-        "version": "1.6.1",
+        "version": "1.6.3",
         "news": {
+			"1.6.3": {
+				"en": "Bugfixes for API reading.",
+				"de": "Bugfixes im API Handling.",
+				"ru": "Bugfixes для чтения API.",
+				"pt": "Bugfixes para leitura de API.",
+				"nl": "Bugfixes voor API-lezing.",
+				"fr": "Bugfixes pour la lecture de l'API.",
+				"it": "Bugfixes per la lettura API.",
+				"es": "Bugfixes para la lectura de API.",
+				"pl": "Bugfixes for API reading (ang.).",
+				"uk": "Виправлення помилок для читання API.",
+				"zh-cn": "评 注."
+			},
+			"1.6.2": {
+				"en": "Added statistics values from API along with some own calculations.",
+				"de": "Statistikwerte von API zusammen mit einigen eigenen Berechnungen hinzugefügt.",
+				"ru": "Добавлены статистические значения из API наряду с некоторыми собственными расчетами.",
+				"pt": "Adicionados valores estatísticos da API junto com alguns próprios cálculos.",
+				"nl": "Voeg statistieken toe van API samen met wat eigen berekeningen.",
+				"fr": "Ajout des valeurs statistiques de l'API avec certains propres calculs.",
+				"it": "Aggiunti i valori statistici da API con alcuni propri calcoli.",
+				"es": "Valores estadísticos añadidos de API junto con algunos cálculos propios.",
+				"pl": "Wstępne dane z API wraz z kilkoma własnymi obliczeniami.",
+				"uk": "Додано значення статистичних даних з API разом з деякими власними підрахунками.",
+				"zh-cn": "加上非传染性疾病的统计价值以及一些本身的计算。."
+			},
 			"1.6.1": {
 				"en": "Bugfixes for API reading.",
 				"de": "Bugfixes im API Handling.",
@@ -93,32 +119,6 @@
 				"pl": "Dodana opcja do używania https dla połączenia z SENEC (w sposób aktywowana, jeśli dana osoba obsługuje / wymaga to)",
 				"uk": "Додано можливість використовувати HTTPS для підключення до SENEC (тільки активуйте, якщо підтримує додаток / вимагає цього)",
 				"zh-cn": "增加使用连接到SENEC的网站的选择(如果你的可靠支持/要求这样做)"
-			},
-			"1.4.1": {
-				"en": "Autarky calculations are working again.",
-				"de": "Autarkieberechnungen funktionieren wieder.",
-				"ru": "Расчеты Autarky снова работают.",
-				"pt": "Cálculos autarcos estão a funcionar outra vez.",
-				"nl": "Autarische berekeningen werken weer.",
-				"fr": "Les calculs Autarky fonctionnent à nouveau.",
-				"it": "I calcoli autarky funzionano di nuovo.",
-				"es": "Los cálculos autárquicos están funcionando de nuevo.",
-				"pl": "Ponowne obliczenia autarktyczne działają ponownie.",
-				"uk": "Аутарки знову працюють.",
-				"zh-cn": "Autarky的计算正再次工作。."
-			},
-			"1.4.0": {
-				"en": "Added object caching and minor code updates. Due to the amount of objects we deal with caching is about mandatory.",
-				"de": "Objekt-Caching und kleinere Code-Updates hinzugefügt. Aufgrund der Menge an Objekten, die der Adapter bearbeitet, ist Caching zwingend notwendig.",
-				"ru": "Добавлена кэшировка объекта и незначительные обновления кода. В связи с количеством объектов, с которыми мы занимаемся кэшированием, является обязательным.",
-				"pt": "Adicionado cache de objeto e pequenas atualizações de código. Devido à quantidade de objetos que lidamos com caching é sobre obrigatória.",
-				"nl": "Toegevoegd voorwerp caching en kleine code updates. Gezien de hoeveelheid objecten die we met caching hebben, gaat het over verplichting.",
-				"fr": "Ajout de cache d'objet et de mises à jour de code mineur. En raison de la quantité d'objets que nous traitons avec le cache est environ obligatoire.",
-				"it": "Aggiunti caching oggetto e aggiornamenti di codice minori. A causa della quantità di oggetti che abbiamo a che fare con il caching è circa obbligatorio.",
-				"es": "Añadido objeto caching y actualizaciones de código menor. Debido a la cantidad de objetos que tratamos con el caché es sobre obligatorio.",
-				"pl": "Dodany obiekt caching i drobnych aktualizacji kodu. Ze względu na ilość przedmiotów, które traktują z cachingiem, dotyczy obowiązkowych.",
-				"uk": "Додано кешування об'єкта та оновлення коду неповного розміру. У зв'язку з кількістю об'єктів, які ми маємо справу з кешуванням, є обов'язковим.",
-				"zh-cn": "添加了目标包和小法典的更新。 由于我们所处理的物品数量是强制性的。."
 			}
         },
         "docs": {

package/lib/api_trans.js

@@ -0,0 +1,29 @@
+const api_trans = {
+	'THIS_DAY': {
+		api: 'TAG',
+		dp:	'Today'
+	},
+	'LAST_DAY': {
+		api: 'TAG',
+		dp:	'Yesterday'
+	},
+	'THIS_MONTH': {
+		api: 'MONAT',
+		dp:	'This Month'
+	},
+	'LAST_MONTH': {
+		api: 'MONAT',
+		dp:	'Last Month'
+	},
+	'THIS_YEAR': {
+		api: 'JAHR',
+		dp:	'This Year'
+	},
+	'LAST_YEAR': {
+		api: 'JAHR',
+		dp:	'Last Year'
+	}
+
+}
+
+module.exports = api_trans;

package/main.js

@@ -14,6 +14,9 @@ axios.defaults.headers.post['Content-Type'] = "application/json";
 
 const state_attr = require(__dirname + '/lib/state_attr.js');
 const state_trans = require(__dirname + '/lib/state_trans.js');
+const api_trans = require(__dirname + '/lib/api_trans.js');
+const kiloList = ["W", "Wh"];
+
 const apiUrl = "https://app-gateway-prod.senecops.com/v1/senec";
 const apiLoginUrl = apiUrl + "/login";
 const apiSystemsUrl = apiUrl + "/anlagen";
@@ -26,6 +29,7 @@ let retryLowPrio = 0; // retry-counter
 let connectVia = "http://";
 
 const allKnownObjects = new Set(["BAT1","BAT1OBJ1","BAT1OBJ2","BAT1OBJ3","BMS","BMS_PARA","CASC","DEBUG","DISPLAY","ENERGY","FACTORY","FEATURES","FILE","GRIDCONFIG","ISKRA","LOG","PM1","PM1OBJ1","PM1OBJ2","PV1","PWR_UNIT","RTC","SELFTEST_RESULTS","SOCKETS","STATISTIC","STECA","SYS_UPDATE","TEMPMEASURE","TEST","UPDATE","WALLBOX","WIZARD"]);
+// STATISTICS is faded out by senec. Keeping it while we still have machines getting it. This will also deprecate all calculated valued in the "_calc" branch.
 
 const highPrioObjects = new Map;
 let lowPrioForm = "";
@@ -65,7 +69,7 @@ class Senec extends utils.Adapter {
 			if (apiConnected) await this.getApiSystems();
 			await this.pollSenec(true, 0); // highPrio
 			await this.pollSenec(false, 0); // lowPrio
-			await this.pollSenecAppApi(0); // App API
+			if (apiConnected) await this.pollSenecAppApi(0); // App API
 			this.setState('info.connection', true, true);
         } catch (error) {
             this.log.error(error);
@@ -127,6 +131,7 @@ class Senec extends utils.Adapter {
 					if (this.config.disclaimer && this.config.highPrio_PM1OBJ2_active) this.addUserDps(value, objectsSet, this.config.highPrio_PM1OBJ2);
 				break;
 				case "STATISTIC":
+					// soon to be deprecated
 					["LIVE_GRID_EXPORT","LIVE_GRID_IMPORT","LIVE_HOUSE_CONS","LIVE_PV_GEN","LIVE_BAT_CHARGE_MASTER","LIVE_BAT_DISCHARGE_MASTER"].forEach(item => objectsSet.add(item));
 					if (this.config.disclaimer && this.config.highPrio_STATISTIC_active) this.addUserDps(value, objectsSet, this.config.highPrio_STATISTIC);
 				break;
@@ -262,6 +267,7 @@ class Senec extends utils.Adapter {
 			apiConnected = true;
 			axios.defaults.headers.get['authorization'] = apiLoginToken;
         } catch (error) {
+			apiConnected = false;
             throw new Error("Error connecting to Senec AppAPI. Exiting! (" + error + ").");
         }
     }
@@ -285,7 +291,10 @@ class Senec extends utils.Adapter {
 				const systemId = value.id;
 				apiKnownSystems.push(systemId);
 				for (const[key2, value2] of Object.entries(value)) {
-					this.doState(pfx + systemId + "." + key2, JSON.stringify(value2), "", "", false);
+					if (typeof value2 === "object") 
+						this.doState(pfx + systemId + "." + key2, JSON.stringify(value2), "", "", false);
+					else 
+						this.doState(pfx + systemId + "." + key2, value2, "", "", false);
 				}
 			}
 			this.doState(pfx + 'IDs', JSON.stringify(apiKnownSystems), "Anlagen IDs", "", false);
@@ -382,15 +391,41 @@ class Senec extends utils.Adapter {
      * Read values from Senec App API
      */
 	async pollSenecAppApi(retry) {
-		var interval = this.config.api_interval * 60000;
+		if (!this.config.api_use || !apiConnected) {
+			this.log.info('Usage of SENEC App API not configured or not connected.');
+			return;
+		}
+		const interval = this.config.api_interval * 60000;
+		const dates = new Map([
+			["THIS_DAY", new Date().toISOString().split('T')[0]],
+			["LAST_DAY", new Date(new Date().setDate(new Date().getDate()-1)).toISOString().split('T')[0]],
+			["THIS_MONTH", new Date().toISOString().split('T')[0]],
+			["LAST_MONTH", new Date(new Date().setDate(0)).toISOString().split('T')[0]],
+			["THIS_YEAR", new Date().toISOString().split('T')[0]],
+			["LAST_YEAR", new Date(new Date().getFullYear() - 1, 1, 1).toISOString().split('T')[0]]
+		]);
+				
 		this.log.debug("Polling API ...");
 		var body = "";
 		try {
 			for (let i = 0; i < apiKnownSystems.length; i++) {
+				const baseUrl = apiSystemsUrl + "/" + apiKnownSystems[i]
+				var url = "";
+				const tzObj = await this.getStateAsync("_api.Anlagen." + apiKnownSystems[i] + ".zeitzone");
+				const tz = tzObj ? encodeURIComponent(tzObj.val) : encodeURIComponent("Europe/Berlin");
+				
 				// dashboard
-				var url = apiSystemsUrl + "/" + apiKnownSystems[i] + "/dashboard";
+				url = baseUrl + "/dashboard";
 				body = await this.doGet(url, "", this, this.config.pollingTimeout, false);
 				await this.decodeDashboard(apiKnownSystems[i], JSON.parse(body));
+				
+				for (let[key, value] of dates.entries()) {
+					// statistik today
+					url = baseUrl + "/statistik?periode=" + api_trans[key].api + "&datum=" + value + "&locale=de_DE&timezone=" + tz;
+					body = await this.doGet(url, "", this, this.config.pollingTimeout, false);
+					await this.decodeStatistik(apiKnownSystems[i], JSON.parse(body), api_trans[key].dp);
+				}
+				
 				// // wallboxes - only if wallbox exists? - Without: error 500
 				//var url = apiSystemsUrl + "/" + apiKnownSystems[i] + "/wallboxes/1";
 				//body = await this.doGet(url, "", this, this.config.pollingTimeout, false);
@@ -419,12 +454,32 @@ class Senec extends utils.Adapter {
 				this.doState(pfx + key, value, "", "", false);
 			} else {
 				for (const[key2, value2] of Object.entries(value)) {
-					this.doState(pfx + key + "." + key2, value2.wert, "", value2.einheit, false);
+					this.doState(pfx + key + "." + key2, (value2.wert).toFixed(2), "", value2.einheit, false);
+					if (kiloList.includes(value2.einheit)) {
+						this.doState(pfx + key + "." + key2 + " (k" + value2.einheit + ")", (value2.wert / 1000).toFixed(2), "", "k" + value2.einheit, false);
+					}
 				}
 			}
 		}
 		
 	}
+	
+	async decodeStatistik(system, obj, period) {
+		const pfx = "_api.Anlagen." + system + ".Statistik." + period + ".";
+		for (const[key, value] of Object.entries(obj.aggregation)) {
+			// only reading 'aggregation' - no interest in fine granular information
+			if (key == "startzeitpunkt") {
+				this.doState(pfx + key, value, "", "", false);
+			} else {
+				this.doState(pfx + key, (value.wert).toFixed(2), "", value.einheit, false);
+				if (kiloList.includes(value.einheit)) {
+					this.doState(pfx + key + " (k"+ value.einheit + ")", (value.wert / 1000).toFixed(2), "", "k" + value.einheit, false);
+				}
+			}
+		}
+		const autarky = (((obj.aggregation.stromerzeugung.wert - obj.aggregation.netzeinspeisung.wert - obj.aggregation.speicherbeladung.wert + obj.aggregation.speicherentnahme.wert) / obj.aggregation.stromverbrauch.wert) * 100).toFixed(2);
+		this.doState(pfx + "Autarkie", autarky, "", "%", false);
+	}
 
     /**
      * sets a state's value and creates the state if it doesn't exist yet
@@ -481,7 +536,7 @@ class Senec extends utils.Adapter {
 			val: value,
 			ack: true
 		});
-		await this.checkUpdateSelfStat(name);
+		await this.checkUpdateSelfStat(name); // soon to be deprecated
 		await this.doDecode(name, value);
 	}
 		
@@ -512,6 +567,7 @@ class Senec extends utils.Adapter {
 	 * Helper routine
 	 */
 	async checkUpdateSelfStat(name) {
+		// soon to be deprecated
 		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);
 		}
@@ -546,6 +602,7 @@ class Senec extends utils.Adapter {
     }
 	
 	async updateSelfStat(name, value) {
+		// soon to be deprecated
 		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());
@@ -554,6 +611,7 @@ class Senec extends utils.Adapter {
 	}
 	
 	async updateSelfStatHelper(name, value, today, yesterday, refValue, day, curDay) {
+		// soon to be deprecated
 		const key = "_calc." + name.substring(10);
 		
 		const refDayObj = await this.getStateAsync(key + ".ref" + day);
@@ -598,6 +656,7 @@ class Senec extends utils.Adapter {
 	}
 	
 	async updateAutarkyHelper(today, yesterday, day, curDay) {
+		// soon to be deprecated
 		const key = "_calc.Autarky";
 		
 		// reference object to decide on change of day

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.senec",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "Senec Home",
   "author": {
     "name": "NoBl",