iobroker.senec 1.5.2 → 1.6.0

package/README.md

@@ -366,8 +366,9 @@ 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.5.2 (NoBl)
-* Added more datapoints. If you experience messages in log - feel free to add them yourself to state_attr on github (pull request)
+### 1.6.0 (NoBl)
+* Added option to also poll SENEC App API. This requires user credentials for mein-senec.de
+* We are starting with just some information - more to follow. But with Dashboard we at least have current values and day statistics back.
 
 ### 1.5.1 (NoBl)
 * Added more datapoints. If you experience messages in log - feel free to add them yourself to state_attr on github (pull request)

package/admin/jsonConfig.json

@@ -1086,6 +1086,163 @@
 					"newLine": false
 				}
 			}
+		},
+		"_api": {
+			"type": "panel",
+			"label": {
+				"en": "SENEC API",
+				"de": "SENEC API",
+				"ru": "SENEC API",
+				"pt": "API SENEC",
+				"nl": "SENEC",
+				"fr": "SENEC API",
+				"it": "API SENEC",
+				"es": "SENEC API",
+				"pl": "SENEC API",
+				"uk": "СЕНЕК API",
+				"zh-cn": "SENECAPI"
+			},
+			"items": {
+				"api_use": {
+					"type": "checkbox",
+					"sm": 12,
+                    "md": 6,
+                    "lg": 6,
+					"label": {
+						"en": "Use SENEC API?",
+						"de": "SENEC API nutzen?",
+						"ru": "Используйте SENEC API?",
+						"pt": "Usar API SENEC?",
+						"nl": "SENEC API gebruiken?",
+						"fr": "Utilisez l'API SENEC?",
+						"it": "Utilizzare API SENEC?",
+						"es": "¿Usar SENEC API?",
+						"pl": "Zastosowanie API SENEC?",
+						"uk": "Використовуйте SENEC API?",
+						"zh-cn": "使用ENECAPI?"
+					},
+					"help": {
+						"en": "Check if the adapter shall make use of the SENEC API.",
+						"de": "Aktivieren, falls der Adapter die SENEC API nutzen soll.",
+						"ru": "Проверьте, следует ли адаптер использовать SENEC API.",
+						"pt": "Verifique se o adaptador deve fazer uso da API SENEC.",
+						"nl": "Kijk of de adapter gebruik maakt van de SENEC API.",
+						"fr": "Vérifiez si l'adaptateur doit utiliser l'API SENEC.",
+						"it": "Controllare se l'adattatore deve utilizzare l'API SENEC.",
+						"es": "Compruebe si el adaptador hará uso de la API SENEC.",
+						"pl": "W przypadku, gdy adapter będzie korzystał z API SENEC.",
+						"uk": "Перевірте, чи використовує адаптер SENEC API.",
+						"zh-cn": "如果适应者应使用ENECAPI。."
+					},
+					"default": "",
+					"newLine": true
+				},
+				"api_mail": {
+					"type": "text",
+					"sm": 12,
+                    "md": 6,
+                    "lg": 6,
+					"label": {
+						"en": "Email-Address",
+						"de": "E-Mail-Adresse",
+						"ru": "Email-Адрес",
+						"pt": "Endereço de email",
+						"nl": "E-Addres",
+						"fr": "Email-Address",
+						"it": "Indirizzo e-mail",
+						"es": "Email-Address",
+						"pl": "Email-Addresser",
+						"uk": "Електронна пошта",
+						"zh-cn": "Email-Addres"
+					},
+					"help": {
+						"en": "Email-Address used to login to mein-senec.de",
+						"de": "Email-Adresse, um sich bei mein-senec.de anzumelden",
+						"ru": "Email-адрес используется для входа в mein-senec.de",
+						"pt": "Email-Endereço usado para login para mein-senec.de",
+						"nl": "Email-Address loge in mein-senec",
+						"fr": "Email-Adresse utilisé pour se connecter à mein-senec.de",
+						"it": "Email-Address usato per accedere a mein-senec.de",
+						"es": "Email-Address solía iniciar sesión en mein-senec.de",
+						"pl": "Email-Address używany do logowania mein-senec",
+						"uk": "Email-Address використовується для входу в mein-senec.de",
+						"zh-cn": "Email-Address used to mein-senec.de"
+					},
+					"default": "",
+					"newLine": true
+				},
+				"api_pwd": {
+					"type": "password",
+					"visible": true,
+					"sm": 12,
+                    "md": 6,
+                    "lg": 6,
+					"label": {
+						"en": "Password",
+						"de": "Passwort",
+						"ru": "Пароль",
+						"pt": "Senha",
+						"nl": "Wachtwoord",
+						"fr": "Mot de passe",
+						"it": "Password",
+						"es": "Contraseña",
+						"pl": "Password",
+						"uk": "Логін",
+						"zh-cn": "护照"
+					},
+					"help": {
+						"en": "Password used to login to mein-senec.de",
+						"de": "Passwort für die Anmeldung an mein-senec.de",
+						"ru": "Пароль используется для входа в mein-senec.de",
+						"pt": "Senha usada para login para mein-senec.de",
+						"nl": "Het wachtwoord loginde in mein-senec",
+						"fr": "Mot de passe utilisé pour se connecter à mein-senec.de",
+						"it": "Password usata per accedere a mein-senec.de",
+						"es": "Contraseña usada para iniciar sesión en mein-senec.de",
+						"pl": "Miecz używany do logowania na mein-senec.de",
+						"uk": "Пароль використовується для входу в mein-senec.de",
+						"zh-cn": "目 录"
+					},
+					"default": "",
+					"newLine": false
+				},
+				"api_interval": {
+					"type": "number",
+					"sm": 12,
+                    "md": 6,
+                    "lg": 6,
+					"label": {
+						"en": "Polling Interval (minutes)",
+						"de": "Polling Interval (Minuten)",
+						"ru": "Поллинг Интервал (минуты)",
+						"pt": "Polling Interval (minutos)",
+						"nl": "Polling Interval (minuten)",
+						"fr": "Intervalle de vote (minutes)",
+						"it": "Polling Interval (minuti)",
+						"es": "Intervalo de votación (minutos)",
+						"pl": "Polling Interval (ang.)",
+						"uk": "Поллінг Інтервал (хвилини)",
+						"zh-cn": "中间(分钟)"
+					},
+					"help": {
+						"en": "Here you can define the polling interval [min 3, max 1440 minutes]. Default = 5. SENEC updates API Data every 5 minutes.",
+						"de": "Hier können Sie das Abfrageintervall definieren [min 3, max 1440 Minuten]. Standard = 5. SENEC aktualisiert die API-Daten alle 5 Minuten.",
+						"ru": "Здесь вы можете определить интервал опроса [мин 3, макс 1440 минут]. По умолчанию = 5. SENEC обновление API Данные каждые 5 минут.",
+						"pt": "Aqui você pode definir o intervalo de votação [min 3, max 1440 minutes]. Padrão = 5. API de atualizações do SENEC Dados a cada 5 minutos.",
+						"nl": "Hier kun je de peiling interval definiëren. SenEC updates Data om de vijf minuten.",
+						"fr": "Ici vous pouvez définir l'intervalle de vote [min 3, max 1440 minutes]. Défaut = 5. Données toutes les 5 minutes.",
+						"it": "Qui è possibile definire l'intervallo di polling [min 3, max 1440 minuti]. Default = 5. Aggiornamenti SENEC API Dati ogni 5 minuti.",
+						"es": "Aquí puede definir el intervalo de votación [min 3, max 1440 minutos]. Default = 5. Actualización de SENEC API Datos cada 5 minutos.",
+						"pl": "Może ona zdefiniować przedział wyborczy (min 3, max 1440 minut). Default = 5. Dane co 5 minut.",
+						"uk": "Тут можна визначити інтервал опитування [min 3, макс. 1440 хвилин]. JavaScript licenses API Веб-сайт Дані кожні 5 хвилин.",
+						"zh-cn": "在此,你可以界定投票间隔[3, max1440分钟]。 Default=5 SENEC最新情况 数据每5分钟。."
+					},
+					"default": 5,
+					"min": 3,
+					"max": 1440,
+					"newLine": true
+				},
+			}
 		}
 	}
 }

package/io-package.json

@@ -1,8 +1,21 @@
 {
     "common": {
         "name": "senec",
-        "version": "1.5.2",
+        "version": "1.6.0",
         "news": {
+			"1.6.0": {
+				"en": "You can now configure to request SENEC App API.",
+				"de": "Sie können nun die SENEC App API abfragen.",
+				"ru": "Теперь вы можете настроить для запроса SENEC App API.",
+				"pt": "Agora você pode configurar para solicitar a API do SENEC App.",
+				"nl": "Je kunt nu configureren om SENEC App API te vragen.",
+				"fr": "Vous pouvez maintenant configurer pour demander l'API App SENEC.",
+				"it": "Ora è possibile configurare per richiedere l'API SENEC App.",
+				"es": "Ahora puede configurarse para solicitar SENEC App API.",
+				"pl": "Możesz teraz skonfigurować żądanie SENEC App API.",
+				"uk": "Ви можете налаштувати запит на SENEC App API.",
+				"zh-cn": "如今,你可以准备要求SENECSP。."
+			},
 			"1.5.2": {
 				"en": "Added more datapoints. If you experience messages in log - feel free to add them yourself to state_attr on github (pull request)",
 				"de": "Weitere Datenpunkte hinzugefügt. Du kennst weitere? Bitte PullRequest auf Github für state_attr.",
@@ -195,7 +208,13 @@
 		"highPrio_BAT1OBJ4": "",
 		"highPrio_BAT1OBJ4_active": false,
 		"highPrio_TEMPMEASURE": "",
-		"highPrio_TEMPMEASURE_active": false
+		"highPrio_TEMPMEASURE_active": false,
+		"api_use": false,
+		"api_interval": 5
+    },
+	"nativeEncrypted": {
+        "api_mail": "",
+        "api_pwd": ""
     },
     "objects": [],
     "instanceObjects": [{

package/main.js

@@ -8,10 +8,19 @@ const agent = new https.Agent({
 });
 
 const utils = require('@iobroker/adapter-core');
+
 const axios = require('axios').default;
+axios.defaults.headers.common['Content-Type'] = "application/json";
+
 const state_attr = require(__dirname + '/lib/state_attr.js');
 const state_trans = require(__dirname + '/lib/state_trans.js');
+const apiUrl = "https://app-gateway-prod.senecops.com/v1/senec";
+const apiLoginUrl = apiUrl + "/login";
+const apiSystemsUrl = apiUrl + "/anlagen";
+const apiKnownSystems = []
 
+let apiConnected = false;
+let apiLoginToken = "";
 let retry = 0; // retry-counter
 let retryLowPrio = 0; // retry-counter
 let connectVia = "http://";
@@ -52,8 +61,12 @@ class Senec extends utils.Adapter {
             await this.checkConfig();
 			await this.initPollSettings();
             await this.checkConnection();
+			await this.initSenecAppApi();
+			if (apiConnected) await this.getApiSystems();
 			await this.pollSenec(true, 0); // highPrio
 			await this.pollSenec(false, 0); // lowPrio
+			await this.pollSenecAppApi(0); // App API
+			this.setState('info.connection', true, true);
         } catch (error) {
             this.log.error(error);
             this.setState('info.connection', false, true);
@@ -70,8 +83,8 @@ class Senec extends utils.Adapter {
             if (this.timer) {
                 clearTimeout(this.timer);
             }
-            if (this.timerLowPrio) {
-                clearTimeout(this.timerLowPrio);
+            if (this.timerAPI) {
+                clearTimeout(this.timerAPI);
             }
             this.log.info('cleaned everything up...');
             this.setState('info.connection', false, true);
@@ -207,6 +220,11 @@ class Senec extends utils.Adapter {
 			connectVia = "https://";
 			this.log.debug("(checkConf) Switching to https ... " + this.config.useHttps);
 		}
+		this.log.debug("(checkConf) Configured api polling interval: " + this.config.api_interval);
+        if (this.config.api_interval < 3 || this.config.api_interval > 1440) {
+            this.log.warn("(checkConf) Config api polling interval " + this.config.api_interval + " not [3..1440] seconds. Using default: 5");
+            this.config.api_interval = 5;
+        }
     }
 
     /**
@@ -217,23 +235,74 @@ class Senec extends utils.Adapter {
         const form = '{"ENERGY":{"STAT_STATE":""}}';
         try {
             this.log.info('connecting to Senec: ' + url);
-            const body = await this.doGet(url, form, this, this.config.pollingTimeout);
+            const body = await this.doGet(url, form, this, this.config.pollingTimeout, true);
             this.log.info('connected to Senec: ' + url);
-            this.setState('info.connection', true, true);
         } catch (error) {
             throw new Error("Error connecting to Senec (IP: " + connectVia + this.config.senecip + "). Exiting! (" + error + "). Try to toggle https-mode in settings and check FQDN of SENEC appliance.");
         }
     }
+	
+	/**
+     * Inits connection to senec app api
+     */
+    async initSenecAppApi() {
+		if (!this.config.api_use) {
+			this.log.info('Usage of SENEC App API not configured. Not using it');
+			return;
+		}
+        this.log.info('connecting to Senec App API: ' + apiLoginUrl);
+		const loginData = JSON.stringify({
+			password: this.config.api_pwd,
+			username: this.config.api_mail
+		});
+		try {
+            const body = await this.doGet(apiLoginUrl, loginData, this, this.config.pollingTimeout, true);
+            this.log.info('connected to Senec AppAPI.');
+			apiLoginToken = JSON.parse(body).token;
+			apiConnected = true;
+			axios.defaults.headers.common['authorization'] = apiLoginToken;
+        } catch (error) {
+            throw new Error("Error connecting to Senec AppAPI. Exiting! (" + error + ").");
+        }
+    }
+	
+	/**
+     * Reads system data from senec app api
+     */
+    async getApiSystems() {
+		const pfx = "_api.Anlagen.";
+		if (!this.config.api_use || !apiConnected) {
+			this.log.info('Usage of SENEC App API not configured or not connected.');
+			return;
+		}
+        this.log.info('Reading Systems Information from Senec App API ' + apiSystemsUrl);
+		try {
+            const body = await this.doGet(apiSystemsUrl, "", this, this.config.pollingTimeout, false);
+            this.log.info('Read Systems Information from Senec AppAPI.');
+			var obj = JSON.parse(body);
+			const systems = [];
+			for (const[key, value] of Object.entries(obj)) {
+				const systemId = value.id;
+				apiKnownSystems.push(systemId);
+				for (const[key2, value2] of Object.entries(value)) {
+					this.doState(pfx + systemId + "." + key2, JSON.stringify(value2), "", "", false);
+				}
+			}
+			this.doState(pfx + 'IDs', JSON.stringify(apiKnownSystems), "Anlagen IDs", "", false);
+        } catch (error) {
+            throw new Error("Error reading Systems Information from Senec AppAPI. (" + error + ").");
+        }
+    }
 
     /**
      * Read from url via axios
      * @param url to read from
      * @param form to post
      */
-	doGet(pUrl, pForm, caller, pollingTimeout) {
+	doGet(pUrl, pForm, caller, pollingTimeout, isPost) {
 		return new Promise(function (resolve, reject) {
 			axios({
-				method: 'post',
+				method: isPost ? 'post' : 'get',
 				httpsAgent: agent,
 				url: pUrl,
 				data: pForm,
@@ -251,6 +320,10 @@ class Senec extends utils.Adapter {
 					if (error.response) {
 						// The request was made and the server responded with a status code
 						caller.log.warn('(Poll) received error ' + error.response.status + ' response from SENEC with content: ' + JSON.stringify(error.response.data));
+						if (error.response.status == 403 && apiConnected) {
+							apiConnected = false; // apparently the api is inaccessible
+							this.initSenecAppApi();
+						}
 						reject(error.response.status);
 					} else if (error.request) {
 						// The request was made but no response was received
@@ -280,7 +353,7 @@ class Senec extends utils.Adapter {
 		}
 		
 		try {
-            var body = await this.doGet(url, (isHighPrio ? highPrioForm : lowPrioForm), this, this.config.pollingTimeout);
+            var body = await this.doGet(url, (isHighPrio ? highPrioForm : lowPrioForm), this, this.config.pollingTimeout, true);
 			if (body.includes('\\"')) { 
 				// in rare cases senec reports back extra escape sequences on some machines ...
 				this.log.info("(Poll) Double escapes detected!  Body inc: " + body);
@@ -303,6 +376,53 @@ class Senec extends utils.Adapter {
                 this.timer = setTimeout(() => this.pollSenec(isHighPrio, retry), interval * this.config.retrymultiplier * retry);
             }
         }
+	}
+	
+	/**
+     * Read values from Senec App API
+     */
+	async pollSenecAppApi(retry) {
+		var interval = this.config.api_interval * 60000;
+		this.log.debug("Polling API ...");
+		var body = "";
+		try {
+			for (let i = 0; i < apiKnownSystems.length; i++) {
+				// dashboard
+				var url = apiSystemsUrl + "/" + apiKnownSystems[i] + "/dashboard";
+				body = await this.doGet(url, "", this, this.config.pollingTimeout, false);
+				await this.decodeDashboard(apiKnownSystems[i], JSON.parse(body));
+				// // 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);
+				//this.log.info("Abilities: " + body);
+				//await this.decodeWallbox(apiKnownSystems[i], JSON.parse(body));
+			}
+			retry = 0;
+			if (unloaded) return;
+			this.timerAPI = setTimeout(() => this.pollSenecAppApi(retry), interval);
+		} catch (error) {
+            if ((retry == this.config.retries) && this.config.retries < 999) {
+                this.log.error("Error reading from Senec AppAPI. Retried " + retry + " times. Giving up now. Check config and restart adapter. (" + error + ")");
+                this.setState('info.connection', false, true);
+            } else {
+                retry += 1;
+                this.log.warn("Error reading from Senec AppAPI. Retry " + retry + "/" + this.config.retries + " in " + (interval * this.config.retrymultiplier * retry) / 1000 + " seconds! (" + error + ")");
+                this.timerAPI = setTimeout(() => this.pollSenecAppApi(retry), interval * this.config.retrymultiplier * retry);
+            }
+        }
+	}
+	
+	async decodeDashboard(system, obj) {
+		const pfx = "_api.Anlagen." + system + ".Dashboard.";
+		for (const[key, value] of Object.entries(obj)) {
+			if (key == "zeitstempel" || key == "electricVehicleConnected") {
+				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);
+				}
+			}
+		}
 		
 	}
 
@@ -408,7 +528,7 @@ class Senec extends utils.Adapter {
                 if (value2 !== "VARIABLE_NOT_FOUND" && key2 !== "OBJECT_NOT_FOUND") {
                     const key = key1 + '.' + key2;
                     if (state_attr[key] === undefined) {
-                        this.log.info('REPORT_TO_DEV: State attribute definition missing for: ' + key + ', Val: ' + value2);
+                        this.log.debug('REPORT_TO_DEV: State attribute definition missing for: ' + key + ', Val: ' + value2);
                     }	
                     const desc = (state_attr[key] !== undefined) ? state_attr[key].name : key2;
                     const unit = (state_attr[key] !== undefined) ? state_attr[key].unit : "";

package/package.json

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