iobroker.e3oncan 0.6.14 → 0.6.16

package/README.md

@@ -21,7 +21,7 @@ In parallel **reading of datapoints** (ReadByDid) is supported. Informations not
 
 **Writing of datapoints** via UDSonCAN (WriteByDid) is supported as well. By writing to datapoints it's possible to change setpoints, schedules and so on. It's even possible to add new schedules e.g. for domestic hot water circulation pump.
 
-Writing of data is triggered by storing the corresponding state with `Acknowledged` not checked (ack=false) - yes, it's that simple! The datapoint will be read again from device and stored in the state two seconds after writing. If state not get's acknowledged, please take a look to the logs.
+Writing of data is triggered by storing the corresponding state with `Acknowledged` not checked (ack=false) - yes, it's that simple! The datapoint will be read again from device and stored in the state 2.5 seconds after writing. If state not get's acknowledged, please take a look to the logs.
 
 Writing is restricted to a set of datapoints using a **white list**. The list is stored in the info section of each device, e.g. at `e3oncan.0.vitocal.info.udsDidsWritable`. You can add more datapoints by editing this state. Make sure, **not** to check `Acknowledged` when saving the state.
 
@@ -39,13 +39,13 @@ A python based implementation of a pure listening approach using MQTT messaging
 * Currently only Linux based systems are supported.
 * CAN adapter is up and visible in system, e.g. as "can0" (use ifconfig to check).
 * Refer to open3e project for further details
-* **Make sure, open3e is not running during initial setup!** This could cause communication errors in both applications.
+* **Make sure, no other UDSonCAN client (e.g. Open3Eclient.py) is running during initial setup!** This could cause communication errors in both applications.
 
 All services provided by this adapter are based on device list of your specific Viessmann E3 setup. Therefore you have to follow following steps for first setup:
 
 **Configuration**
 * When installation of adapter has finished a confuration dialog will show up to configure up to two CAN bus adapters (tab "CAN ADAPTER")
-* Edit name of adapter and check the "Connect to adapter" checkbox at least the external adapter
+* Edit name of adapter and check the "Connect to adapter" checkbox at least for the external adapter
 * When you're done, press "SAVE" button to apply the changes. This step is **mandatory**. The instance will restart and connect to the CAN adapter.
 * Go to tab "LIST OF UDS DEVICES" and do a scan for devices available on bus by pressing the scan button. **This will take a few seconds.** You may watch the activities in a 2nd browser tab by looking on the logging info of the adapter.
 * You may change the naming of the devices at 2nd column. Those names will be used to store all collected data in ioBoker's object tree. Again press "SAVE" button when you did your changes.
@@ -65,11 +65,11 @@ You may use datapoints informations on tab "LIST OF DATAPOINTS" for reference (o
 | ID | Data| Unit |
 | ------|:--- |------|
 | 0x250 | Active Power L1, L2, L3, Total |  W |
-| 0x252 | Reactive Power L1, L2, L3, Total | W |
+| 0x252 | Reactive Power L1, L2, L3, Total | VA |
 | 0x254 | Current, L1, L2, L3, cosPhi | A, - |
 | 0x256 | Voltage, L1, L2, L3, Frequency | V, Hz |
 | 0x258 | Cumulated Import, Export | kWh |
-| 0x25A | Total Active Power, Total Reactive Power | W |
+| 0x25A | Total Active Power, Total Reactive Power | W, VA |
 | 0x25C | Cumulated Import | kWh |
 
 # Hints and limitations
@@ -102,6 +102,13 @@ Yes, that is possible under certain conditions:
     Placeholder for the next version (at the beginning of the line):
     ### **WORK IN PROGRESS**
 -->
+### 0.6.16 (2024-01-27)
+* (MyHomeMyData) Improvements based on findings in review as of 2024-01-25
+* (MyHomeMyData) Checkbox for data collectiton on internal bus is now checked per default
+
+### 0.6.15 (2024-01-23)
+* (MyHomeMyData) Fix for Utf8 codec for handling of special characters, e.g. umlauts
+
 ### 0.6.14 (2024-01-22)
 * (MyHomeMyData) Replace '.' by '_' in datapoint ids to avoid unwanted sub structure in data states
 * (MyHomeMyData) Added more informations about white list for writables in Readme.

package/admin/jsonConfig.json

@@ -560,7 +560,7 @@
                             "tooltip": "Activate communication",
                             "filter": false,
                             "sort": false,
-                            "default": false
+                            "default": true
                         },
                         {   "type": "selectSendTo",
                             "title": "Select device",

package/io-package.json

@@ -1,8 +1,34 @@
 {
   "common": {
     "name": "e3oncan",
-    "version": "0.6.14",
+    "version": "0.6.16",
     "news": {
+      "0.6.16": {
+        "en": "Improvements based on findings in review as of 2024-01-25\nCheckbox for data collectiton on internal bus is now checked per default",
+        "de": "Verbesserungen auf der Grundlage der Ergebnisse in der Überprüfung ab 2024-01-25\nCheckbox für Datensammler im internen Bus wird nun standardmäßig überprüft",
+        "ru": "Совершенствование на основе результатов, рассмотренных на 2024-01-25 годы\nCheckbox для сбора данных на внутреннем автобусе теперь проверяется по умолчанию",
+        "pt": "Aperfeiçoamentos baseados em achados em revisão a partir de 2024-01-25\nCaixa de seleção para coleta de dados no ônibus interno é agora verificada por padrão",
+        "nl": "Verbeteringen op basis van de resultaten van het onderzoek per 2024-01-25\nCheckbox voor gegevensverzameling op interne bus is nu standaard aangevinkt",
+        "fr": "Améliorations fondées sur les conclusions de l'examen en 2024-01-25\nLa case à cocher pour les données collectiton sur le bus interne est maintenant cochée par défaut",
+        "it": "Miglioramenti basati sui risultati in esame a partire dal 2024-01-25\nLa casella di controllo per i dati collettivi sul bus interno è ora controllata per impostazione predefinita",
+        "es": "Mejoras basadas en los resultados examinados al 2024-01-25\nCheckbox for data collectiton on internal bus is now check per default",
+        "pl": "Poprawki oparte na ustaleniach w przeglądzie z 2024- 01- 25\nSkrzynka kontrolna dla kolekcji danych w autobusie wewnętrznym jest teraz sprawdzana na domyślnym",
+        "uk": "Удосконалення на основі пошуку в рецензії на 2024-01-25\nCheckbox для збору даних у внутрішньому автобусі тепер перевіряється за замовчуванням",
+        "zh-cn": "根据截至2024-01-25年审查结果作出的改进\n内部总线上数据集合的复选框现在按默认检查"
+      },
+      "0.6.15": {
+        "en": "Fix for Utf8 codec for handling of special characters, e.g. umlauts",
+        "de": "Fix für Utf8-Codec zum Umgang mit Sonderzeichen, z.B. umlauts",
+        "ru": "Fix for Utf8 codec для обработки специальных символов, например, umlauts",
+        "pt": "Fix para Codec Utf8 para manipulação de caracteres especiais, por exemplo, umlauts",
+        "nl": "Fix voor Utf8 codec voor het hanteren van speciale tekens, bijvoorbeeld umlauts",
+        "fr": "Correction pour Codec Utf8 pour la manipulation de caractères spéciaux, p.ex. umlauts",
+        "it": "Fissaggio per Codice Utf8 per la gestione di caratteri speciali, ad esempio umlauts",
+        "es": "Corrección Utf8 codec para el manejo de caracteres especiales, por ejemplo umlauts",
+        "pl": "Napraw dla Kod Utf8 do obsługi znaków specjalnych, np. umlautów",
+        "uk": "Фіксація Utf8 кодека для обробки спеціальних символів, наприклад, umlauts",
+        "zh-cn": "修复 Utf8 处理特殊字符的编码器, 例如 umlauts"
+      },
       "0.6.14": {
         "en": "Replace '.' by '_' in datapoint ids to avoid unwanted sub structure in data states\nAdded more informations about white list for writables in Readme.\nRecognize loss of CAN connection.\nImproved handling of info.connection.",
         "de": "Ersetzen Sie '.' durch '_' in Datapoint ids, um unerwünschte Unterstruktur in Datenzuständen zu vermeiden\nWeitere Informationen zur Weißen Liste für schreibbare in Readme.\nErkennen Verlust der CAN-Verbindung.\nVerbesserte Handhabung von info.connection.",
@@ -67,32 +93,6 @@
         "pl": "Usunięto kod dla Rawmode ponieważ nigdy nie jest aktywowany",
         "uk": "Видалити код для Rawmode, тому що він ніколи не активований",
         "zh-cn": "删除了Rawmode的代码,因为它从未被激活"
-      },
-      "0.6.9": {
-        "en": "Bugfix: Only Linux is supported",
-        "de": "Bugfix: Nur Linux wird unterstützt",
-        "ru": "Исправление: Только Linux поддерживается",
-        "pt": "Bugfix: Apenas o Linux é suportado",
-        "nl": "Bugfix: Alleen Linux wordt ondersteund",
-        "fr": "Correction : Seul Linux est pris en charge",
-        "it": "Bugfix: Solo Linux è supportato",
-        "es": "Bugfix: Sólo Linux es compatible",
-        "pl": "Bugfix: Tylko Linux jest obsługiwany",
-        "uk": "Помилки: Тільки Linux підтримується",
-        "zh-cn": "错误修正 : 仅支持 Linux"
-      },
-      "0.6.8": {
-        "en": "Initial npm version",
-        "de": "Ursprüngliche npm-Version",
-        "ru": "Первоначальная версия npm",
-        "pt": "Versão inicial npm",
-        "nl": "Eerste npm-versie",
-        "fr": "Version initiale npm",
-        "it": "Versione npm iniziale",
-        "es": "Versión inicial npm",
-        "pl": "Początkowa wersja npm",
-        "uk": "Початкова версія npm",
-        "zh-cn": "初始 npm 版本"
       }
     },
     "title": "Viessmann E3 CAN do",

package/lib/canCollect.js

@@ -57,7 +57,7 @@ class collect {
             await this.storage.setOpMode('standby');
 
             // Stop Timeout:
-            if (this.timeoutHandle) await clearTimeout(this.timeoutHandle);
+            if (this.timeoutHandle) await ctx.clearTimeout(this.timeoutHandle);
             this.timeoutHandle = null;
 
             this.stat.state = 'stopped';
@@ -71,10 +71,6 @@ class collect {
         }
     }
 
-    sleep(milliseconds) {
-        return new Promise(resolve => setTimeout(resolve, milliseconds));
-    }
-
     async msgCollect(ctx, msg) {
 
         if (await this.storage.getOpMode() == 'standby') return;    // No communication in mode 'standby'
@@ -109,7 +105,7 @@ class collect {
                     this.data.databytes = this.data.databytes.concat(candata.slice(1));
                     if (this.data.databytes.length >= this.data.len) {
                         // All data received
-                        if (this.timeoutHandle) await clearTimeout(this.timeoutHandle);
+                        if (this.timeoutHandle) await ctx.clearTimeout(this.timeoutHandle);
                         this.stat.cntCommOk += 1;
                         if (!(this.data.did in this.ts)) { this.ts[this.data.did] = tsNow; }
                         if ( (this.config.delay == 0) || ((tsNow >= this.ts[this.data.did])) ) {
@@ -162,7 +158,7 @@ class collect {
                                 this.data.databytes = candata.slice(5);
                                 this.data.len = candata[4];
                             }
-                            this.timeoutHandle = setTimeout(this.onTimeout, this.config.timeout, ctx, this);
+                            this.timeoutHandle = ctx.setTimeout(this.onTimeout, this.config.timeout, ctx, this);
                             this.data.collecting = true;
                             break;
                         case 0xb5:
@@ -181,7 +177,7 @@ class collect {
                             this.data.D0expected = candata[0]+1;
                             this.data.databytes = candata.slice(4);
                             this.data.len = D3-0xb0;
-                            this.timeoutHandle = setTimeout(this.onTimeout, this.config.timeout, ctx, this);
+                            this.timeoutHandle = ctx.setTimeout(this.onTimeout, this.config.timeout, ctx, this);
                             this.data.collecting = true;
                             break;
                         default:

package/lib/canUds.js

@@ -9,21 +9,21 @@ class scheduleLoop {
         this.schedHandle = null;
     }
 
-    async startSchedule() {
+    async startSchedule(ctx) {
         if (this.schedule == 0) {
             await this.ctxGlobal.log.silly('UDS schedule one time: '+this.ctxLocal.canIDhex+'.'+JSON.stringify(this.dids));
             await this.ctxLocal.pushCmnd(this.ctxGlobal, 'read', this.dids);
             this.schedHandle = null;
         } else {
-            this.schedHandle = setInterval(async () => {
+            this.schedHandle = ctx.setInterval(async () => {
                 await this.loop();
             }, this.schedule*1000);
         }
     }
 
-    async stopSchedule() {
+    async stopSchedule(ctx) {
         try {
-            if (this.schedHandle) await clearInterval(this.schedHandle);
+            if (this.schedHandle) await ctx.clearInterval(this.schedHandle);
             await this.ctxGlobal.log.silly('UDS schedule stopped: '+String(this.schedule)+' '+this.ctxLocal.canIDhex+'.'+JSON.stringify(this.dids));
         } catch (e) {
             // Dod nothing
@@ -110,7 +110,6 @@ class uds {
                 type: 'channel',
                 common: {
                     name: this.config.stateBase+' commands',
-                    role: 'device'
                 },
                 native: {},
             });
@@ -139,7 +138,7 @@ class uds {
         if (opMode == 'normal') {
             for (const sched of Object.values(this.schedules)) {
                 // Start schedules on startup and do one-time schedules
-                await sched.startSchedule();
+                await sched.startSchedule(ctx);
             }
         }
         if (opMode == 'normal') {
@@ -147,7 +146,7 @@ class uds {
         } else {
             await ctx.log.silly('UDS worker started in mode '+opMode+' on '+this.config.stateBase);
         }
-        this.cmndsHandle = setInterval(async () => {
+        this.cmndsHandle = ctx.setInterval(async () => {
             await this.cmndsLoop(ctx);
         }, this.cmndsUpdateTime);
     }
@@ -164,18 +163,18 @@ class uds {
 
             // Stop loops:
             for (const sched of Object.values(this.schedules)) {
-                await sched.stopSchedule();
+                await sched.stopSchedule(ctx);
             }
-            if (this.cmndsHandle) await clearInterval(this.cmndsHandle);
+            if (this.cmndsHandle) await ctx.clearInterval(this.cmndsHandle);
 
             // Stop Timeout:
-            if (this.timeoutHandle) await clearTimeout(this.timeoutHandle);
+            if (this.timeoutHandle) await ctx.clearTimeout(this.timeoutHandle);
             this.timeoutHandle = null;
 
             // Stop worker:
             this.callback = null;
             if (opMode == 'normal') {
-                await ctx.unsubscribeStates(ctx.namespace+'.'+this.config.stateBase+'.*');
+                ctx.unsubscribeStates(ctx.namespace+'.'+this.config.stateBase+'.*');
                 await ctx.log.info('UDS worker stopped on '+this.config.stateBase);
             } else {
                 await ctx.log.silly('UDS worker stopped in mode '+opMode+' on '+this.config.stateBase);
@@ -201,12 +200,12 @@ class uds {
         this.data.state = comState;
     }
 
-    async setDidDone(coolDownTime) {
+    async setDidDone(ctx, coolDownTime) {
         // Finalize communication for recent did
         this.coolDownTs = new Date().getTime()+coolDownTime;
         if (this.cmndsQueue.length == 0) this.busy = false;
         await this.setComState(0);
-        if (this.timeoutHandle) await clearTimeout(this.timeoutHandle);
+        if (this.timeoutHandle) await ctx.clearTimeout(this.timeoutHandle);
     }
 
     async setDidStart(ctx, did, mode, len) {
@@ -228,9 +227,9 @@ class uds {
         }
         const tsNow = new Date().getTime();
         const minWaiting = this.coolDownTs - tsNow;
-        if (minWaiting > 0) await this.sleep(minWaiting);
+        if (minWaiting > 0) await this.sleep(ctx, minWaiting);
         this.busy = true;
-        this.timeoutHandle = await setTimeout(this.onTimeout, this.config.timeout, ctx, this);
+        this.timeoutHandle = await ctx.setTimeout(this.onTimeout, this.config.timeout, ctx, this);
         this.data.did = did;
         this.data.tsRequest = tsNow;
     }
@@ -269,8 +268,8 @@ class uds {
         }
     }
 
-    sleep(milliseconds) {
-        return new Promise(resolve => setTimeout(resolve, milliseconds));
+    sleep(ctx, milliseconds) {
+        return new Promise(resolve => ctx.setTimeout(resolve, milliseconds));
     }
 
     async cmndsLoop(ctx) {
@@ -309,7 +308,7 @@ class uds {
             ctxLocal.stat.cntCommTimeoutPerDid[did]  = 1;
         }
         if (ctxLocal.callback) await ctxLocal.callback(ctxGlobal, ctxLocal, ['timeout', {'did':ctxLocal.data.did,'didInfo':{'id':'','len':0},'val':''}]);
-        await ctxLocal.setDidDone(0);
+        await ctxLocal.setDidDone(ctxGlobal, 0);
     }
 
     async onUdsStateChange(ctx, ctxWorker, id, state) {
@@ -365,20 +364,24 @@ class uds {
         switch (dcs.channel) {
             case 'json':
                 // Change in json data
-                byteArr = await this.storage.encodeDataCAN(ctx, this, did, JSON.parse(state.val));
-                if (byteArr) {
-                    await this.pushCmnd(ctx, 'write', [[did,byteArr]]);
-                    setTimeout(function(ctxWorker,did){ctxWorker.cmndsQueue.push({'mode':'read', 'did': did});},2500,this,did);    // Read value after 2500 ms
-                } else {
-                    ctx.log.error('User command UDS WriteByDid on '+this.config.stateBase+': Encoding of data failed.');
+                try {
+                    byteArr = await this.storage.encodeDataCAN(ctx, this, did, await JSON.parse(state.val));
+                    if (byteArr) {
+                        await this.pushCmnd(ctx, 'write', [[did,byteArr]]);
+                        ctx.setTimeout(function(ctxWorker,did){ctxWorker.cmndsQueue.push({'mode':'read', 'did': did});},2500,this,did);    // Read value after 2500 ms
+                    } else {
+                        ctx.log.error('User command UDS WriteByDid on '+this.config.stateBase+': Encoding of data failed.');
+                    }
+                } catch(e) {
+                    ctx.log.error('WriteByDid(): Encoding of data failed on '+this.config.stateBase+'.'+String(did)+'; err='+JSON.stringify(e));
                 }
                 break;
             case 'raw':
                 // Change in raw data
-                byteArr = this.storage.toByteArray(JSON.parse(state.val));
+                byteArr = this.storage.toByteArray(await JSON.parse(state.val));
                 if (byteArr) {
                     await this.pushCmnd(ctx, 'write', [[did,byteArr]]);
-                    setTimeout(function(ctxWorker,did){ctxWorker.cmndsQueue.push({'mode':'read', 'did': did});},2500,this,did);    // Read value after 2500 ms
+                    ctx.setTimeout(function(ctxWorker,did){ctxWorker.cmndsQueue.push({'mode':'read', 'did': did});},2500,this,did);    // Read value after 2500 ms
                 } else {
                     ctx.log.error('User command UDS WriteByDid on '+this.config.stateBase+': Encoding of data failed.');
                 }
@@ -389,12 +392,16 @@ class uds {
                 lenBaseId = ctx.namespace.length+dcs.device.length+dcs.channel.length+dcs.state.length+3;
                 if (id.length == lenBaseId) {
                     // Scalar value w/o sub structure
-                    byteArr = await this.storage.encodeDataCAN(ctx, this, did, JSON.parse(state.val));
-                    if (byteArr) {
-                        await this.pushCmnd(ctx, 'write', [[did,byteArr]]);
-                        setTimeout(function(ctxWorker,did){ctxWorker.cmndsQueue.push({'mode':'read', 'did': did});},2500,this,did);    // Read value after 2500 ms
-                    } else {
-                        ctx.log.error('User command UDS WriteByDid on '+this.config.stateBase+': Encoding of data failed.');
+                    try {
+                        byteArr = await this.storage.encodeDataCAN(ctx, this, did, await JSON.parse(state.val));
+                        if (byteArr) {
+                            await this.pushCmnd(ctx, 'write', [[did,byteArr]]);
+                            ctx.setTimeout(function(ctxWorker,did){ctxWorker.cmndsQueue.push({'mode':'read', 'did': did});},2500,this,did);    // Read value after 2500 ms
+                        } else {
+                            ctx.log.error('User command UDS WriteByDid on '+this.config.stateBase+': Encoding of data failed.');
+                        }
+                    } catch(e) {
+                        ctx.log.error('WriteByDid(): Encoding of data failed on '+this.config.stateBase+'.'+String(did)+'; err='+JSON.stringify(e));
                     }
                     break;
                 }
@@ -402,21 +409,6 @@ class uds {
                 // Build json object for complete object tree of changed did:
                 await ctx.getStatesOf(dcs.device,dcs.device+'.'+dcs.channel,async function(err,obj) {
                     // Get all states for changed device.channel
-                    /*
-                    // Probalby better solution based on numbers as marker for arrays. But not working yet.
-                    function isNumber(value) { return /^\d+$/.test(value); }
-                    function insertDictSubVal(dict, keyArr, isArray, val) {
-                        if (keyArr.length == 1) {
-                            const key = keyArr[0];
-                            if (isArray) dict[key].push(val); else dict[key] = val;
-                        } else {
-                            const key = keyArr.shift();
-                            const nextIsArray = (((keyArr.length) && (isNumber(keyArr[0]))) ? true : false);
-                            if (!(key in dict)) if (nextIsArray) dict[key] = []; else dict[key] = {};
-                            insertDictSubVal(dict[key],keyArr, nextIsArray, val);
-                        }
-                    }
-                    */
                     function insertDictSubVal(dict, keyArr, val) {
                         const listLabels = ['ListEntries','Schedules','TopologyElement'];
                         if (keyArr.length == 1) {
@@ -437,12 +429,16 @@ class uds {
                             insertDictSubVal(treeDict, label.split('.'), val);
                         }
                     }
-                    byteArr = await ctxWorker.storage.encodeDataCAN(ctx, ctxWorker, did, treeDict);
-                    if (byteArr) {
-                        await ctxWorker.pushCmnd(ctx, 'write', [[did,byteArr]]);
-                        setTimeout(function(ctxWorker,did){ctxWorker.cmndsQueue.push({'mode':'read', 'did': did});},2500,ctxWorker,did);    // Read value after 2500 ms
-                    } else {
-                        ctx.log.error('User command UDS WriteByDid on '+ctxWorker.config.stateBase+': Encoding of data failed.');
+                    try {
+                        byteArr = await ctxWorker.storage.encodeDataCAN(ctx, ctxWorker, did, treeDict);
+                        if (byteArr) {
+                            await ctxWorker.pushCmnd(ctx, 'write', [[did,byteArr]]);
+                            ctx.setTimeout(function(ctxWorker,did){ctxWorker.cmndsQueue.push({'mode':'read', 'did': did});},2500,ctxWorker,did);    // Read value after 2500 ms
+                        } else {
+                            ctx.log.error('User command UDS WriteByDid on '+ctxWorker.config.stateBase+': Encoding of data failed.');
+                        }
+                    } catch(e) {
+                        ctx.log.error('WriteByDid(): Encoding of data failed on '+ctxWorker.config.stateBase+'.'+String(did)+'; err='+JSON.stringify(e));
                     }
                 });
                 break;
@@ -543,7 +539,7 @@ class uds {
                     } else {
                         ctx.log.error('UDS worker error on '+this.config.stateBase+': Negative response reading did '+String(this.data.did)+'. Code=0x'+Number(candata[3]).toString(16));
                     }
-                    await this.setDidDone(0);
+                    await this.setDidDone(ctx, 0);
                     break;
                 }
                 if ( (candata.length == 8) && ((candata[0] >> 4) == 0) && (candata[1] == this.readByDidProt.SIDrx) ) {
@@ -557,7 +553,7 @@ class uds {
                         this.data.len = candata[0]-3;
                         this.data.databytes = candata.slice(4,4+this.data.len);
                         this.storage.decodeDataCAN(ctx, this, this.data.did, this.data.databytes.slice(0,this.data.len));
-                        await this.setDidDone(0);
+                        await this.setDidDone(ctx, 0);
                         break;
                     } else {
                         // Did does not match
@@ -567,7 +563,7 @@ class uds {
                         } else {
                             ctx.log.error('UDS worker on '+this.config.stateBase+': Did mismatch MF. Expected='+String(this.data.did)+'; Received='+String(didRx));
                         }
-                        await this.setDidDone(1000);
+                        await this.setDidDone(ctx, 1000);
                         break;
                     }
                 }
@@ -592,7 +588,7 @@ class uds {
                         } else {
                             ctx.log.error('UDS worker on '+this.config.stateBase+': Did mismatch MF. Expected='+String(this.data.did)+'; Received='+String(didRx));
                         }
-                        await this.setDidDone(1000);
+                        await this.setDidDone(ctx, 1000);
                         break;
                     }
                 }
@@ -603,7 +599,7 @@ class uds {
                 }
                 await this.calcStat();
                 this.stat.cntCommBadProtocol += 1;
-                await this.setDidDone(2500);
+                await this.setDidDone(ctx, 2500);
                 break;
 
             case 2: // waitForCFrbd
@@ -617,7 +613,7 @@ class uds {
                         await this.calcStat();
                         ctx.log.silly('UDS worker on '+this.config.stateBase+': MF completed. candata: '+this.storage.arr2Hex(candata));
                         this.storage.decodeDataCAN(ctx, this, this.data.did, this.data.databytes.slice(0,this.data.len));
-                        await this.setDidDone(0);
+                        await this.setDidDone(ctx, 0);
                     } else {
                         // More data to come
                         this.data.D0 += 1;
@@ -631,7 +627,7 @@ class uds {
                         ctx.log.error('UDS worker on '+this.config.stateBase+': Bad frame. candata: '+this.storage.arr2Hex(candata));
                     }
                     this.stat.cntCommBadProtocol += 1;
-                    await this.setDidDone(2500);
+                    await this.setDidDone(ctx, 2500);
                 }
                 break;
 
@@ -640,7 +636,7 @@ class uds {
                     // Negative response
                     this.stat.cntCommNR += 1;
                     ctx.log.error('UDS worker error on '+this.config.stateBase+': Negative response writing did '+String(this.data.did)+'. Code=0x'+Number(candata[3]).toString(16));
-                    await this.setDidDone(0);
+                    await this.setDidDone(ctx, 0);
                     break;
                 }
                 if ( (candata.length == 8) && (candata[0] == 0x03) && (candata[1] == this.writeByDidProt.SIDrx) ) {
@@ -652,7 +648,7 @@ class uds {
                         ctx.log.silly('UDS worker on '+this.config.stateBase+': writeByDid SF confirmation received.');
                         await this.calcStat();
                         this.storage.storeStatistics(ctx, this, false);
-                        await this.setDidDone(0);
+                        await this.setDidDone(ctx, 0);
                         break;
                     } else {
                         // Did does not match
@@ -660,14 +656,14 @@ class uds {
                         ctx.log.error('UDS worker on '+this.config.stateBase+': Did mismatch writeByDid SF. Expected='+String(this.data.did)+'; Received='+String(didRx));
                         await this.calcStat();
                         this.storage.storeStatistics(ctx, this, true);
-                        await this.setDidDone(1000);
+                        await this.setDidDone(ctx, 1000);
                         break;
                     }
                 }
                 ctx.log.error('UDS worker on '+this.config.stateBase+': Bad frame for writeByDid SF. candata: '+this.storage.arr2Hex(candata));
                 this.stat.cntCommBadProtocol += 1;
                 await this.calcStat();
-                await this.setDidDone(2500);
+                await this.setDidDone(ctx, 2500);
                 break;
 
             case 4: // waitForFFFwbd
@@ -675,7 +671,7 @@ class uds {
                     // Negative response
                     this.stat.cntCommNR += 1;
                     ctx.log.error('UDS worker error on '+this.config.stateBase+': Negative response writing did '+String(this.data.did)+'. Code=0x'+Number(candata[3]).toString(16));
-                    await this.setDidDone(0);
+                    await this.setDidDone(ctx, 0);
                     break;
                 }
                 if ( (candata.length == 8) && (candata[0] == 0x30) && (candata[1] == 0x00) ) {
@@ -685,7 +681,7 @@ class uds {
                     if ((ST<20) || (ST>127)) ST=50; // Accept ST 20 .. 127 ms. Default to 50 ms.
                     while (this.data.txPos < this.data.len) {
                         // More data to send
-                        await this.sleep(ST);
+                        await this.sleep(ctx, ST);
                         const frame = [this.data.D0].concat(this.data.databytes.slice(this.data.txPos,this.data.txPos+7));
                         await this.sendFrame(ctx, frame);
                         this.data.txPos += 7;
@@ -698,7 +694,7 @@ class uds {
                 ctx.log.error('UDS worker on '+this.config.stateBase+': Bad frame for writeByDid MF. candata: '+this.storage.arr2Hex(candata));
                 this.stat.cntCommBadProtocol += 1;
                 await this.calcStat();
-                await this.setDidDone(2500);
+                await this.setDidDone(ctx, 2500);
                 break;
 
             default:
@@ -708,7 +704,7 @@ class uds {
                 } else {
                     ctx.log.error('UDS worker on '+this.config.stateBase+': Bad state value: '+String(await this.getComState()));
                 }
-                await this.setDidDone(2500);
+                await this.setDidDone(ctx, 2500);
         }
         this.commBusy = false;
     }

package/lib/codecs.js

@@ -205,18 +205,28 @@ class O3EUtf8 {
         this.id = idStr;
         this.offset = _args.offset;
     }
+
     encode(data) {
-        const encoder = new TextEncoder();
-        const result = Object.values(encoder.encode(data));
-        if (result.length > this.string_len) throw new Error('O3EUtf8.encode() result too long: '+this.id+' - '+String(result.length)+' > '+String(this.string_len));
+        let result;
+        try {
+            result = Object.values(new TextEncoder().encode(data));
+        } catch(e) {
+            throw new Error('O3EUtf8.encode(): Conversion from Utf8 failed '+this.id+'; err='+JSON.stringify(e));
+        }
+        if (result.length > this.string_len) throw new Error('O3EUtf8.encode(): Result too long: '+this.id+' - '+String(result.length)+' > '+String(this.string_len));
         return result.concat(Array.from(Array(this.string_len-result.length), () => 0));
 
     }
     decode(string_bin) {
-        let mystr = '';
-        for (let i=this.offset; i<this.offset+this.string_len;i++) { mystr += String.fromCharCode(string_bin[i]); }
-        // eslint-disable-next-line no-control-regex
-        return mystr.replace(/[\u0000-\u0008,\u000A-\u001F,\u007F-\u00A0]+/g, '');
+        let i = string_bin.slice(this.offset).indexOf(0);
+        if (i == -1) { i = string_bin.length-this.offset; }
+        let result;
+        try {
+            result = new TextDecoder().decode(new Uint8Array(string_bin.slice(this.offset,i)));
+        } catch(e) {
+            throw new Error('O3EUtf8.decode(): Conversion to Utf8 failed '+this.id+'; err='+JSON.stringify(e));
+        }
+        return result;
     }
 
     __len__() {

package/lib/codecs.test.js

@@ -38,6 +38,62 @@ function codecEncode(descr, expected, codec, len, id, args, val) {
     });
 }
 
+// Utf8:
+describe('codecs.js => O3EUtf8()', () => {
+    const raw_hex1 = '4865697a6bc3b6727065720000000000000000000000000000000000000000000000000000000000';
+    const raw1 = E3.toByteArray(raw_hex1);
+    const txt1 = 'Heizkörper';
+    it(`Decode ${JSON.stringify(txt1)}`, () => {
+        const f = new E3.O3Ecodecs.O3EUtf8(raw1.length,'test1Utf08', {offset:0});
+        const result = f.decode(raw1);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(txt1));
+    });
+    it(`Encode ${JSON.stringify(raw1)}`, () => {
+        const f = new E3.O3Ecodecs.O3EUtf8(raw1.length,'test2Utf08', {offset:0});
+        const result = f.encode(txt1);
+        expect(JSON.stringify(raw1)).to.equal(JSON.stringify(result));
+    });
+    const raw_hex2 = '4675c39f626f64656e6865697a756e67000000000000000000000000000000000000000000000000';
+    const raw2 = E3.toByteArray(raw_hex2);
+    const txt2 = 'Fußbodenheizung';
+    it(`Decode ${JSON.stringify(txt2)}`, () => {
+        const f = new E3.O3Ecodecs.O3EUtf8(raw2.length,'test3Utf08', {offset:0});
+        const result = f.decode(raw2);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(txt2));
+    });
+    it(`Encode ${JSON.stringify(raw2)}`, () => {
+        const f = new E3.O3Ecodecs.O3EUtf8(raw2.length,'test4Utf08', {offset:0});
+        const result = f.encode(txt2);
+        expect(JSON.stringify(raw2)).to.equal(JSON.stringify(result));
+    });
+    const raw_hex3 = '00000000000000000000000000000000000000000000000000000000000000000000000000000000';
+    const raw3 = E3.toByteArray(raw_hex3);
+    const txt3 = '';
+    it(`Decode ${JSON.stringify(txt3)}`, () => {
+        const f = new E3.O3Ecodecs.O3EUtf8(raw3.length,'test5Utf08', {offset:0});
+        const result = f.decode(raw3);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(txt3));
+    });
+    it(`Encode ${JSON.stringify(raw3)}`, () => {
+        const f = new E3.O3Ecodecs.O3EUtf8(raw3.length,'test5Utf08', {offset:0});
+        const result = f.encode(txt3);
+        expect(JSON.stringify(raw3)).to.equal(JSON.stringify(result));
+    });
+    const raw_hex4 = '4675c39f';
+    const raw4 = E3.toByteArray(raw_hex4);
+    const txt4 = 'Fuß';
+    it(`Decode ${JSON.stringify(txt4)}`, () => {
+        const f = new E3.O3Ecodecs.O3EUtf8(raw4.length,'test6Utf08', {offset:0});
+        const result = f.decode(raw4);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(txt4));
+    });
+    it(`Encode ${JSON.stringify(raw4)}`, () => {
+        const f = new E3.O3Ecodecs.O3EUtf8(raw4.length,'test6Utf08', {offset:0});
+        const result = f.encode(txt4);
+        expect(JSON.stringify(raw4)).to.equal(JSON.stringify(result));
+    });
+});
+
 // val2byteArray:
 describe('codecs.js => val2byteArr()', () => {
     let val = -1;
@@ -152,7 +208,7 @@ describe('codecs.js => O3EInt8().encode()', () => {
     codecEncode('Positive Number, scale=10, signed=false', [0xfb], E3.O3Ecodecs.O3EInt8, 1, 'test5', {scale:10.0,signed:false,offset: 0}, 25.1);
 });
 
-describe('codecs.js => O3EInt16().decode()', () => {
+describe('codecs.js => O3EInt16().encode()', () => {
     codecEncode('Positive Number, scale=10, signed=true ', [0x32,0x00], E3.O3Ecodecs.O3EInt16, 2, 'test1', {scale:10.0,signed:true, offset: 0}, 5);
     codecEncode('Positive Number, scale=10, signed=true ', [0xff,0x7f], E3.O3Ecodecs.O3EInt16, 2, 'test2', {scale:10.0,signed:true, offset: 0}, (2**15-1)/10);
     codecEncode('Negative Number, scale=10, signed=true ', [0x00,0x80], E3.O3Ecodecs.O3EInt16, 2, 'test3', {scale:10.0,signed:true, offset: 0}, -(2**15)/10);

package/lib/storage.js

@@ -136,7 +136,6 @@ class storage {
                 type: 'device',
                 common: {
                     name: this.config.stateBase,
-                    role: 'device'
                 },
                 native: {},
             });
@@ -145,7 +144,6 @@ class storage {
                 type: 'channel',
                 common: {
                     name: this.config.stateBase+' informations',
-                    role: 'channel'
                 },
                 native: {},
             });
@@ -154,7 +152,7 @@ class storage {
                 type: 'state',
                 common: {
                     name: this.config.stateBase+' statistics about communication',
-                    role: 'state',
+                    role: 'info.status',
                     type: 'json',
                     read: true,
                     write: true,
@@ -169,7 +167,6 @@ class storage {
                 type: 'channel',
                 common: {
                     name: this.config.stateBase+' JSON',
-                    role: 'channel for json data'
                 },
                 native: {},
             });
@@ -178,7 +175,6 @@ class storage {
                 type: 'channel',
                 common: {
                     name: this.config.stateBase+' TREE',
-                    role: 'channel for tree data'
                 },
                 native: {},
             });
@@ -187,7 +183,6 @@ class storage {
                 type: 'channel',
                 common: {
                     name: this.config.stateBase+' RAW',
-                    role: 'channel for raw data'
                 },
                 native: {},
             });
@@ -230,7 +225,7 @@ class storage {
         if (['standby','normal','udsDidScan'].includes(await this.getOpMode())) {
             const ts = new Date().getTime();
             if ( (!forceStore) && (ts < ctxWorker.stat.nextTs) ) return;     // Min. time step not reached. Do not store.
-            if (ctxWorker.stat) await ctx.setStateAsync(ctxWorker.config.stateBase+'.info.'+this.config.statId, JSON.stringify(ctxWorker.stat), true);
+            if (ctxWorker.stat) ctx.setStateAsync(ctxWorker.config.stateBase+'.info.'+this.config.statId, JSON.stringify(ctxWorker.stat), true);
             ctxWorker.stat.nextTs = ts+ctxWorker.stat.tsMinStep;
         }
     }
@@ -262,7 +257,7 @@ class storage {
                     common: {
                         name: idStr,
                         type: 'string',
-                        role: 'state',
+                        role: 'json',
                         read: true,
                         write: true,
                     },
@@ -280,8 +275,8 @@ class storage {
                 if (typeof(obj) == 'object') {
                     if (Object.keys(obj).length <= 100) {
                         for (const [key, itm] of Object.entries(obj)) {
-                            await storeObjectTree(ctx, String(stateId)+'.'+String(key).replace('.','_'),itm);
-                            // No '.' in state id allowed to avoid sub structure
+                            await storeObjectTree(ctx, String(stateId)+'.'+String(key).replace(ctx.FORBIDDEN_CHARS,'_').replace('.','_'),itm);
+                            // No FORBIDDEN_CHARS and no '.' in state id allowed
                         }
                     } else {
                         ctx.log.error('Did valuation aborted. Too many members ('+String(Object.keys(obj).length)+') '+stateId+'.'+String(did));
@@ -307,7 +302,8 @@ class storage {
                     ctx.log.warn('Could not retreive codec for '+ctxWorker.config.stateBase+'.'+String(did)+'. err='+e.message);
                     codec = 'RawCodec';
                 }
-                idStr = cdi.id.replace('.','_');  // No '.' in state allowed to avoid sub structure
+                idStr = cdi.id.replace(ctx.FORBIDDEN_CHARS,'_').replace('.','_');
+                // No FORBIDDEN_CHARS and no '.' in state allowed
                 common = true;
                 try {
                     val = await codec.decode(data);

package/lib/udsScan.js

@@ -210,14 +210,14 @@ class udsScan {
         for (const baseAddr of Object(this.udsScanAddrRange).values()) {
             for (const addr of Object(range(Number(this.udsScanAddrSpan), Number(baseAddr))).values()) {
                 await this.startupScanUdsDevice(ctx, addr);
-                await this.sleep(50);
+                await this.sleep(ctx, 50);
             }
         }
         // eslint-disable-next-line no-case-declarations
         const tsAbort = new Date().getTime() + this.udsMaxTrialsDevScan*this.udsTimeoutDevScan+250;
         await ctx.log.info('UDS device scan: Waiting for scans to complete.');
         while ( (this.cntUdsScansActive > 0) && (new Date().getTime() < tsAbort) ) {
-            await this.sleep(100);
+            await this.sleep(ctx, 100);
         }
 
         // Stop all scan workers:
@@ -304,14 +304,14 @@ class udsScan {
         const dids = range(udsMaxCntDids, 256);
         for (const addr of Object(udsAddrs).values()) {
             await this.startupScanUdsDids(ctx, addr, dids);
-            await this.sleep(50);
+            await this.sleep(ctx, 50);
         }
         let cntDoneLast = -1;
         await logStatus(ctx, this);
         let ts = new Date().getTime();
         const tsAbort = ts + this.udsScanDidsCntTotal*500;
         while ( (this.cntUdsScansActive > 0) && (new Date().getTime() < tsAbort) ) {
-            await this.sleep(100);
+            await this.sleep(ctx, 100);
             if ((new Date().getTime() - ts) >= 10000) {
                 ts += 10000;
                 await logStatus(ctx, this);
@@ -342,8 +342,8 @@ class udsScan {
         }
     }
 
-    sleep(milliseconds) {
-        return new Promise(resolve => setTimeout(resolve, milliseconds));
+    sleep(ctx, milliseconds) {
+        return new Promise(resolve => ctx.setTimeout(resolve, milliseconds));
     }
 
 }

package/main.js

@@ -257,6 +257,7 @@ class E3oncan extends utils.Adapter {
      */
     async onUnload(callback) {
         try {
+            const tStart = new Date().getTime();
             this.stoppingInstance = true;
             // Stop UDS workers:
             for (const worker of Object.values(this.E3UdsWorkers)) await worker.stop(this);
@@ -273,6 +274,7 @@ class E3oncan extends utils.Adapter {
             // @ts-ignore
             await this.disconnectFromCan(this.channelInt,this.config.canIntName);
             this.setState('info.connection', false, true);
+            this.log.debug('onUnload() took '+String(new Date().getTime()-tStart)+' ms to complete.');
 
             callback();
         } catch (e) {
@@ -320,7 +322,7 @@ class E3oncan extends utils.Adapter {
     }
 
     sleep(milliseconds) {
-        return new Promise(resolve => setTimeout(resolve, milliseconds));
+        return new Promise(resolve => this.setTimeout(resolve, milliseconds));
     }
 
     // If you need to accept messages in your adapter, uncomment the following block and the corresponding line in the constructor.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.e3oncan",
-  "version": "0.6.14",
+  "version": "0.6.16",
   "description": "Collect data on CAN bus for Viessmann E3 devices, e.g. Vitocal, Vitocharge, Energy Meter E380",
   "author": {
     "name": "Juergen",