iobroker.ebus 3.3.8 → 3.4.0

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "ebus",
-    "version": "3.3.8",
+    "version": "3.4.0",
     "news": {
+      "3.4.0": {
+        "en": "migration to jsonConfig\nsee issue #383: add optionally parameters to HTTP call",
+        "de": "migration nach jsonConfig\nsiehe Ausgabe #383: optionale Parameter zum HTTP-Aufruf hinzufügen",
+        "ru": "миграции в jsonConfig\n#383: добавить дополнительные параметры к HTTP-звонку",
+        "pt": "migração para jsonConfig\nveja o problema #383: adicione parâmetros opcionalmente à chamada HTTP",
+        "nl": "migratie naar jsonConfig\nzie probleem #383: voeg optioneel parameters toe aan HTTP-aanroep",
+        "fr": "migration vers jsonConfig\nvoir le numéro #383: ajouter optionnellement des paramètres à l'appel HTTP",
+        "it": "migrazione a jsonConfig\nvedi numero #383: aggiungi parametri opzionalmente alla chiamata HTTP",
+        "es": "migración a jsonConfig\nver número #383: añadir parámetros opcionalmente a la llamada HTTP",
+        "pl": "migracja do jsonConfig\nzobacz numer # 383: dodać opcjonalne parametry do wywołania HTTP",
+        "uk": "міграції в jsonConfig\nпереглянути номер #383: додавати додаткові параметри до HTTP виклику",
+        "zh-cn": "迁移到 jsonConfig\n参见第383期: 在 HTTP 调用中添加可选参数"
+      },
       "3.3.8": {
         "en": "update dependencies\nissue  #381: install widgets again",
         "de": "aktualisierung der abhängigkeiten\nausgabe #381: widgets erneut installieren",
@@ -80,19 +93,6 @@
         "pl": "obniżenie wartości \"socket-socket\" do 7.0.0",
         "uk": "до 7.0.0",
         "zh-cn": "将\"承诺-口袋\"降级为7.0.0"
-      },
-      "3.3.2": {
-        "en": "(René) see issue #338: due to error in ebusd json no data are parsed",
-        "de": "(René) siehe Ausgabe #338: Durch Fehler in ebusd json werden keine Daten pariert",
-        "ru": "(René) см. вопрос #338: из-за ошибки в ebusd json никакие данные не спариваются",
-        "pt": "(René) veja a edição #338: devido ao erro no ebusd json nenhum dado é analisado",
-        "nl": "(René) zie probleem #338: als gevolg van fout in ebusd json geen gegevens worden ontleed",
-        "fr": "(René) voir le numéro 338 : en raison d'une erreur dans ebusd json aucune donnée n'est analysée",
-        "it": "(René) vedi problema #338: a causa di errore in ebusd json non vengono analizzati dati",
-        "es": "(René) ver el número #338: debido al error en ebusd json no se analizan los datos",
-        "pl": "(René) see issue # 338: due to error in ebudd json no data are parsed",
-        "uk": "(René) див. питання #338: через помилку в ebusd json немає даних",
-        "zh-cn": "(René)参见第338期:由于ebusd json中的错误,没有解析数据"
       }
     },
     "titleLang": {
@@ -159,7 +159,7 @@
     "connectionType": "local",
     "dataSource": "push",
     "adminUI": {
-      "config": "materialize"
+      "config": "json"
     },
     "messages": [
       {
@@ -289,13 +289,94 @@
     "interfacetype": "ebusd",
     "targetHTTPPort": 8889,
     "targetTelnetPort": 8890,
-    "PolledValues": "",
-    "HistoryValues": "",
     "parseTimeout": 60,
     "useBoolean4Onoff": false,
     "PolledDPs": [],
     "HistoryDPs": [],
     "maxretries": 5,
-    "readInterval": 5
+    "readInterval": 5,
+    "History4Vis2": false,
+    "HTTPparameter": [
+      {
+        "active": false,
+        "name": "since",
+        "value": 300
+      },
+      {
+        "active": false,
+        "name": "poll",
+        "value": "prio"
+      },
+      {
+        "active": false,
+        "name": "exact",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "verbose",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "indexed",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "numeric",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "valuename",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "full",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "required",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "maxage",
+        "value": "5000"
+      },
+      {
+        "active": false,
+        "name": "write",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "raw",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "def",
+        "value": "true"
+      },
+      {
+        "active": false,
+        "name": "define",
+        "value": "DEFINITION"
+      },
+      {
+        "active": false,
+        "name": "user",
+        "value": "USER"
+      },
+      {
+        "active": false,
+        "name": "secret",
+        "value": "SECRET"
+      }
+    ]
   }
 }

package/main.js

@@ -64,7 +64,7 @@ function startAdapter(options) {
                 switch (obj.command) {
                     case "findParams":
                         // e.g. send email or pushover or whatever
-                        adapter.log.debug("findParams command");
+                        //adapter.log.debug("findParams command");
                         // Send response in callback if required
                         await FindParams(obj);
                         break;
@@ -96,6 +96,7 @@ async function main() {
 
     FillPolledVars();
     FillHistoryVars();
+    FillHTTPParamsVars();
 
     await checkVariables();
 
@@ -256,7 +257,15 @@ function FillHistoryVars() {
     }
 }
 
+let oHTTPParamsVars = [];
+function FillHTTPParamsVars() {
+    if (adapter.config.HTTPparameter !== undefined && adapter.config.HTTPparameter != null && adapter.config.HTTPparameter.length > 0) {
 
+        oHTTPParamsVars = adapter.config.HTTPparameter;
+
+        adapter.log.debug("use optionally HTTP parameter " + JSON.stringify(oHTTPParamsVars));
+    }
+}
 
 
 
@@ -385,6 +394,31 @@ async function ebusd_find(){
 
 //just call http://192.168.0.123:8889/data
 
+
+/*
+    http://localhost:8080/data/mc?verbose&since=1483890000&exact
+
+    since=seconds: limit to messages that have changed since the specified UTC seconds
+    poll=prio: set the poll priority of matching message(s) to prio
+    exact[=true]: exact search for circuit/message name
+    verbose[=true]: include comments and field units
+    indexed[=true]: return field indexes instead of names
+    numeric[=true]: return numeric values of value list entries
+    valuename[=true]: include value and name of value list entries
+    full[=true]: include all available attributes
+    required[=true]: retrieve the data from the bus if not yet cached
+    maxage[=seconds]: retrieve the data from the bus if cached value is older than specified seconds (or not present at all)
+    write[=true]: include write messages in addition to read
+    raw[=true]: include the raw master/slave symbols as int arrays
+    def[=true]: include message/field definition (qq, id, fielddefs)
+    define=DEFINITION: (re-)define the message from DEFINITION (in CSV format)
+    user=USER: authenticate with USER name
+    secret=SECRET: authenticate with user SECRET
+
+
+*/
+
+
 async function subscribeVars() {
     adapter.subscribeStates("cmd");
 
@@ -608,12 +642,28 @@ function VersionCheck() {
 //get data via https in json -> this is the main data receiver; telnet just triggers ebusd to read data;
 //https://github.com/john30/ebusd/wiki/3.2.-HTTP-client
 
+async function ebusd_ReceiveData() {
 
+    let sUrl = "http://" + adapter.config.targetIP + ":" + parseInt(adapter.config.targetHTTPPort) + "/data";
 
+    //Erweiterung mit optionalen parametern
+    var paramsCnt = 0;
+    if (oHTTPParamsVars !== undefined && oHTTPParamsVars != null && oHTTPParamsVars.length > 0) {
+        for (let i = 0; i < oHTTPParamsVars.length; i++) {
 
-async function ebusd_ReceiveData() {
+            if (oHTTPParamsVars[i].active) {
+                if (paramsCnt == 0) {
+                    sUrl += "?"  ;
+                }
+                else {
+                    sUrl += "&";
+                }
+                sUrl += oHTTPParamsVars[i].name + "=" + oHTTPParamsVars[i].value;
+                paramsCnt++;
+            }
+        }
+    }
 
-    const sUrl = "http://" + adapter.config.targetIP + ":" + parseInt(adapter.config.targetHTTPPort) + "/data";
     adapter.log.debug("request data from " + sUrl);
 
     try {
@@ -1257,72 +1307,86 @@ async function ebusd_ReadValues() {
 
 async function FindParams(obj) {
 
-    adapter.log.debug("FindParams " + JSON.stringify(obj));
+    adapter.log.debug("FindParams " + JSON.stringify(obj) + " " + JSON.stringify(obj.message) + " " + JSON.stringify(obj.message.circuit));
 
     const list = [];
+    
 
     try {
-        const circuit = obj.message;
+        //FindParams {"command":"findParams","message":{"circuit":"cc"},"from":"system.adapter.admin.0","callback":{"message":{"circuit":"cc"},"id":90,"ack":false,"time":1733690088670},"_id":39690903}
 
-        const socket = new net.Socket();
-        const promiseSocket = new PromiseSocket(socket);
+        if (obj.message != null) {
 
-        await promiseSocket.connect(parseInt(adapter.config.targetTelnetPort), adapter.config.targetIP);
-        adapter.log.debug("telnet connected for cmd");
-        promiseSocket.setTimeout(5000);
+            const circuit = obj.message.circuit;
 
-        await promiseSocket.write("find -c " + circuit + " -F circuit,name\n");
+            const socket = new net.Socket();
+            const promiseSocket = new PromiseSocket(socket);
 
-        const data = await promiseSocket.read();
+            await promiseSocket.connect(parseInt(adapter.config.targetTelnetPort), adapter.config.targetIP);
+            adapter.log.debug("telnet connected for cmd");
+            promiseSocket.setTimeout(5000);
 
-        if (data.includes("ERR")) {
-            adapter.log.warn("received error! sent find, received " + data + " please check ebusd logs for details!");
-        }
-        else {
-            adapter.log.debug("received " + typeof data + " " + data);
-        }
-        /*
-          received object ehp,AccelerationTestModeehp,AccelerationTestModeehp,ActualEnvironmentPowerehp,ActualEnvironmentPowerehp,ActualEnvironmentPowerPercentageehp,ActualEnvironmentPowerPercentageehp,ApplianceCodeehp,ApplianceCodeehp,Backupehp,Backupehp,BackupHoursehp,BackupHoursHcehp,BackupHoursHwcehp,BackupHysteresisehp,BackupIntegralehp,BackupModeHcehp,BackupModeHwcehp,BackupPowerCutehp,BackupStartsehp,BackupStartsHcehp,BackupStartsHwcehp,BackupTypeehp,BivalentTempehp,Bleedingehp,Bleedingehp,CirPumpehp,CirPumpehp,Code1ehp,Code1Code2Validehp,Code2ehp,Compehp,Compehp,CompControlStateehp,CompCutPressHighCountehp,CompCutPressLowCountehp,CompCutTempCountehp,CompDemandehp,CompHoursehp,CompHoursHcehp,CompHoursHwcehp,CompHysteresisehp,CompIntegralehp,CompPressHighehp,CompPressHighehp,CompPressLowehp,CompPressLowehp,CompStartsehp,CompStartsHcehp,CompStartsHwcehp,CompStateehp,CondensorTempehp,CondensorTempehp,currenterrorehp,Dateehp,DateTimeehp,DeltaTempT6T7ehp,ElectricWiringDiagramehp,ElectricWiringDiagramehp,EnergyBalancingReleaseehp,errorhistoryehp,FlowTempehp,FlowTempehp,FlowtempCoolingMinehp,FlowTempOffsetehp,Hc1Pumpehp,Hc1Pumpehp,Hc1PumpHoursehp,Hc1PumpPortehp,Hc1PumpStartsehp,Hc2Pumpehp,Hc2PumpHoursehp,HcFlowTempehp,HcFlowTempOffsetehp,HcModeDemandHoursehp,HcModeFulfilledHoursehp,HcParallelStorageFillingEnabledehp,HcPressehp,HcReturnTempehp,HcReturnTempehp,HcReturnTempOffsetehp,HeatPumpStatusehp,HeatPumpStatusehp,HeatpumpTypeehp,HwcHcValveehp,HwcHcValveehp,HwcHcValveStartsehp,HwcLaggingTimeehp,HwcLoadingDelayehp,HwcModeDemandHoursehp,HwcModeFulfilledHoursehp,HwcPumpStartsehp,HwcSwitchehp,HwcTempehp,HwcTempehp,HwcTempOffsetehp,HydraulicSchemeehp,ICLOutehp,ICLOutehp,Injectionehp,Integralehp,Mixer1DutyCycleehp,NumberCompStartsehp,OutsideTempehp,OutsideTempOffsetehp,OverpressureThresholdehp,PhaseOrderehp,PhaseOrderehp,PhaseStatusehp,PhaseStatusehp,PowerCutehp,PowerCutPreloadingehp,PressSwitchehp,PressSwitchehp,RebootCounterehp,ReturnTempMaxehp,SetModeehp,SoftwareCodeehp,Source2PumpHoursehp,Sourceehp,Sourceehp,SourceHoursehp,SourcePortehp,SourcePressehp,SourcePumpPrerunTimeehp,SourceStartsehp,SourceSwitchehp,SourceSwitchehp,SourceTempInputehp,SourceTempInputehp,SourceTempInputOffsetehp,SourceTempOutputehp,SourceTempOutputehp,SourceTempOutputOffsetehp,SourceTempOutputT8Minehp,StateSoftwareCodeehp,StateSoftwareCodeehp,Status01ehp,Status02ehp,Status16ehp,Statusehp,StatusCirPumpehp,StorageTempBottomehp,StorageTempBottomehp,StorageTempBottomOffsetehp,StorageTempTopehp,StorageTempTopehp,StorageTempTopOffsetehp,Subcoolingehp,Superheatehp,T19MaxToCompOffehp,TempInputehp,TempInputehp,TempInputOffsetehp,TempOutputehp,TempOutputehp,TempOutputOffsetehp,Timeehp,TimeBetweenTwoCompStartsMinehp,TimeCompOffMinehp,TimeCompOnMinehp,TimeOfNextPredictedPowerCutehp,TimeOfNextPredictedPowerCutehp,Weekdayehp,YieldTotalehp,YieldTotal
-        */
-        const str = new TextDecoder().decode(data);
-        const datas = str.split(/\r?\n/);
+            const cmd = "find -c " + circuit + " -F circuit,name\n";
+            await promiseSocket.write(cmd);
 
-        for (let i = 0; i < datas.length; i++) {
+            const data = await promiseSocket.read();
 
-            //adapter.log.debug(JSON.stringify(datas[i]));
+            if (data.includes("ERR")) {
+                adapter.log.warn("received error! sent find, received " + data + " please check ebusd logs for details! " + cmd);
+            }
+            else {
+                adapter.log.debug("received " + typeof data + " " + data + " " + + cmd);
+            }
+            /*
+              received object ehp,AccelerationTestModeehp,AccelerationTestModeehp,ActualEnvironmentPowerehp,ActualEnvironmentPowerehp,ActualEnvironmentPowerPercentageehp,ActualEnvironmentPowerPercentageehp,ApplianceCodeehp,ApplianceCodeehp,Backupehp,Backupehp,BackupHoursehp,BackupHoursHcehp,BackupHoursHwcehp,BackupHysteresisehp,BackupIntegralehp,BackupModeHcehp,BackupModeHwcehp,BackupPowerCutehp,BackupStartsehp,BackupStartsHcehp,BackupStartsHwcehp,BackupTypeehp,BivalentTempehp,Bleedingehp,Bleedingehp,CirPumpehp,CirPumpehp,Code1ehp,Code1Code2Validehp,Code2ehp,Compehp,Compehp,CompControlStateehp,CompCutPressHighCountehp,CompCutPressLowCountehp,CompCutTempCountehp,CompDemandehp,CompHoursehp,CompHoursHcehp,CompHoursHwcehp,CompHysteresisehp,CompIntegralehp,CompPressHighehp,CompPressHighehp,CompPressLowehp,CompPressLowehp,CompStartsehp,CompStartsHcehp,CompStartsHwcehp,CompStateehp,CondensorTempehp,CondensorTempehp,currenterrorehp,Dateehp,DateTimeehp,DeltaTempT6T7ehp,ElectricWiringDiagramehp,ElectricWiringDiagramehp,EnergyBalancingReleaseehp,errorhistoryehp,FlowTempehp,FlowTempehp,FlowtempCoolingMinehp,FlowTempOffsetehp,Hc1Pumpehp,Hc1Pumpehp,Hc1PumpHoursehp,Hc1PumpPortehp,Hc1PumpStartsehp,Hc2Pumpehp,Hc2PumpHoursehp,HcFlowTempehp,HcFlowTempOffsetehp,HcModeDemandHoursehp,HcModeFulfilledHoursehp,HcParallelStorageFillingEnabledehp,HcPressehp,HcReturnTempehp,HcReturnTempehp,HcReturnTempOffsetehp,HeatPumpStatusehp,HeatPumpStatusehp,HeatpumpTypeehp,HwcHcValveehp,HwcHcValveehp,HwcHcValveStartsehp,HwcLaggingTimeehp,HwcLoadingDelayehp,HwcModeDemandHoursehp,HwcModeFulfilledHoursehp,HwcPumpStartsehp,HwcSwitchehp,HwcTempehp,HwcTempehp,HwcTempOffsetehp,HydraulicSchemeehp,ICLOutehp,ICLOutehp,Injectionehp,Integralehp,Mixer1DutyCycleehp,NumberCompStartsehp,OutsideTempehp,OutsideTempOffsetehp,OverpressureThresholdehp,PhaseOrderehp,PhaseOrderehp,PhaseStatusehp,PhaseStatusehp,PowerCutehp,PowerCutPreloadingehp,PressSwitchehp,PressSwitchehp,RebootCounterehp,ReturnTempMaxehp,SetModeehp,SoftwareCodeehp,Source2PumpHoursehp,Sourceehp,Sourceehp,SourceHoursehp,SourcePortehp,SourcePressehp,SourcePumpPrerunTimeehp,SourceStartsehp,SourceSwitchehp,SourceSwitchehp,SourceTempInputehp,SourceTempInputehp,SourceTempInputOffsetehp,SourceTempOutputehp,SourceTempOutputehp,SourceTempOutputOffsetehp,SourceTempOutputT8Minehp,StateSoftwareCodeehp,StateSoftwareCodeehp,Status01ehp,Status02ehp,Status16ehp,Statusehp,StatusCirPumpehp,StorageTempBottomehp,StorageTempBottomehp,StorageTempBottomOffsetehp,StorageTempTopehp,StorageTempTopehp,StorageTempTopOffsetehp,Subcoolingehp,Superheatehp,T19MaxToCompOffehp,TempInputehp,TempInputehp,TempInputOffsetehp,TempOutputehp,TempOutputehp,TempOutputOffsetehp,Timeehp,TimeBetweenTwoCompStartsMinehp,TimeCompOffMinehp,TimeCompOnMinehp,TimeOfNextPredictedPowerCutehp,TimeOfNextPredictedPowerCutehp,Weekdayehp,YieldTotalehp,YieldTotal
+            */
+            const str = new TextDecoder().decode(data);
+            const datas = str.split(/\r?\n/);
 
-            const names = datas[i].split(",");
+            for (let i = 0; i < datas.length; i++) {
 
-            //doppelte und leere herausfiltern
-            let add = true;
+                //adapter.log.debug(JSON.stringify(datas[i]));
 
-            if (names[0] == "" || names[1] == "") {
-                add = false;
-            }
-            else {
+                const names = datas[i].split(",");
 
-                for (let n = 0; n < list.length; n++) {
+                //doppelte und leere herausfiltern
+                let add = true;
 
-                    if (list[n].circuit == names[0] && list[n].name == names[1]) {
-                        add = false;
-                        //already in list
+                if (names[0] == "" || names[1] == "") {
+                    add = false;
+                }
+                else {
+
+                    for (let n = 0; n < list.length; n++) {
+
+                        if (list[n].circuit == names[0] && list[n].name == names[1]) {
+                            add = false;
+                            //already in list
+                        }
                     }
                 }
-            }
 
-            if (add) {
-                const entry = {
-                    active: false,
-                    circuit: names[0],
-                    name: names[1]
-                };
+                if (add) {
+                    const entry = {
+                        active: false,
+                        circuit: names[0],
+                        name: names[1]
+                    };
 
-                list.push(entry);
+                    list.push(entry);
+                }
             }
         }
+        else {
+            adapter.log.error("no circuit defined where to look for parameter, check values!");
+        }
     } catch (e) {
         adapter.log.error("exception in FindParams " + "[" + e + "]");
     }
+
+    adapter.log.info("parameters " + JSON.stringify(list));
+
+
     adapter.sendTo(obj.from, obj.command, list, obj.callback);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.ebus",
-  "version": "3.3.8",
+  "version": "3.4.0",
   "description": "ioBroker ebus Adapter",
   "author": {
     "name": "René G.",
@@ -23,8 +23,8 @@
     "node": ">= 18"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^3.2.2",
-    "axios": "^1.7.7",
+    "@iobroker/adapter-core": "^3.2.3",
+    "axios": "^1.7.9",
     "flat": "^5.0.2",
     "net": "^1.0.2",
     "promise-socket": "^7.0.0"