iobroker.e3oncan 0.6.11 → 0.6.13

package/README.md

@@ -51,7 +51,7 @@ This step is not mandatory but strongly recomended. If you would like to write t
 * Last step is to configure schedules for collecting data on tab "ASSIGNMENTS TO EXTERNAL CAN ADAPTER".
 * For **energy meter E380** (if available in your setup) you just can activate or not. Please notice the value "Min. update time (s)". Updates to single datapoints are done no faster than the given value (default is 5 seconds). By choosing zero every received data will be stored. Since E380 is sending data very fast (more than 20 values per second), it's recommended not to use zero here. This would put a high load on the ioBroker system.
 * If you have connected E3 devices via CAN bus, e.g. Vitocal and VX3, you can collect data exchanged between those devices in realtime by listening. Press "+" to add a line, check "active" chackbox, select a device and edit "Min. update time (s)". It's feasable to use 0s here, however, I recommend to keep to the 5s.
-* Finally, you may add schedules for requesting data via UDSonCAN protocol. Again press "+" button and edit the setting. You may have several schedules with different (!) timings. By this you can request some datapoints more often than others. Default value of 0 for "Schedule (s)" means, those datapoints will be requested just once during startup of the instance.
+* Finally, you may add schedules for requesting data via UDSonCAN protocol. Again press "+" button and edit the settings. You may have several schedules on each device. By this you can request some datapoints more often than others. Default value of 0 for "Schedule (s)" means, those datapoints will be requested just once during startup of the instance.
 You may use datapoints informations on tab "LIST OF DATAPOINTS" for reference (opening on 2nd tab could help).
 * If you have configured a CAN adapter connected to the **internal CAN bus**, a tab "ASSIGNMENTS TO INTERNAL CAN ADAPTER" is visible. Please configure the devices for colletion there. UDSonCAN is not supported on internal CAN bus by E3 devices.
 * That's it. Press "SAVE & CLOSE" button and check the data collected in object tree.
@@ -81,7 +81,7 @@ You may use datapoints informations on tab "LIST OF DATAPOINTS" for reference (o
 * Therfore from my point of view, combination of both methods is best approach.
 
 ## Limitation of collecting data
-* At present, the communication protocol is known only for Vitocal (listener on CAN id 0x693) and Vitocharge VX3 (listener on CAN id 0x451).
+* At present, the communication protocol is known only for Vitocal (listener on CAN id 0x693), Vitocharge VX3 and Vitoair (both listener on CAN id 0x451).
 
 ## What is different to open3e project?
 * Obviously, the main differece is the direct integration to ioBroker. Configuration can be done via dialogs, data get's directly listed in object trees.
@@ -98,6 +98,16 @@ Yes, that is possible under certain conditions:
     Placeholder for the next version (at the beginning of the line):
     ### **WORK IN PROGRESS**
 -->
+### 0.6.13 (2024-01-20)
+* (MyHomeMyData) Now supports multiple definitions of same schedule on a device 
+* (MyHomeMyData) Added unit test cases for codecs
+
+### 0.6.12 (2024-01-19)
+* (MyHomeMyData) Added datapoints to list writable dids
+* (MyHomeMyData) Added unit test cases for codecs
+* (MyHomeMyData) Improved speed of codes for numerical values
+* (MyHomeMyData) Improved error messages on UDS negative response
+
 ### 0.6.11 (2024-01-17)
 * (MyHomeMyData) Improved layout of configuration dialog for device scan
 

package/io-package.json

@@ -1,8 +1,34 @@
 {
   "common": {
     "name": "e3oncan",
-    "version": "0.6.11",
+    "version": "0.6.13",
     "news": {
+      "0.6.13": {
+        "en": "Now supports multiple definitions of same schedule on a device \nAdded unit test cases for codecs",
+        "de": "Jetzt unterstützt mehrere Definitionen desselben Zeitplans auf einem Gerät\nHinzugefügte Einheit Testfälle für Codecs",
+        "ru": "Теперь поддерживает несколько определений одного и того же расписания на устройстве\n4.1.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.1.2.1.2.1.1.2.1.1.2.1.1.1.1.1.2.1.1.1.1.1.1.1.1.2.2.1.1.1.1.1.2.1.1.1.1.1.1.1.2.2.2.1.1.1.1.1.1.1.1.1.1.1.1.2.1.1.1.2.1.1.2.1.1.1.1.1.1.1.1.1.1.1.1.1",
+        "pt": "Agora suporta várias definições da mesma programação em um dispositivo\nAdicionados casos de teste de unidade para codecs",
+        "nl": "Nu ondersteunt meerdere definities van hetzelfde schema op een apparaat\nToegevoegde testcases per eenheid voor codecs",
+        "fr": "Maintenant prend en charge plusieurs définitions de même horaire sur un appareil\nAjout de cas de test unitaire pour codecs",
+        "it": "Ora supporta più definizioni dello stesso programma su un dispositivo\nAggiunti casi di prova unità per codecs",
+        "es": "Ahora soporta múltiples definiciones del mismo horario en un dispositivo\nCasos de prueba de unidad adicionales para codecs",
+        "pl": "Teraz obsługuje wiele definicji tego samego harmonogramu na urządzeniu\nDodano jednostkowe przypadki badań kodeków",
+        "uk": "Тепер підтримує декілька визначень одного графіка на пристрої\nДодані випадки тестування блоку для кодеків",
+        "zh-cn": "现在支持设备上同一时刻表的多个定义\n为解码器添加单位测试例"
+      },
+      "0.6.12": {
+        "en": "Added datapoints to list writable dids\nAdded unit test cases for codecs\nImproved speed of codes for numerical values\nImproved error messages on UDS negative response",
+        "de": "Datenpunkte zur Liste der schreibbaren Dossiers hinzugefügt\nHinzugefügte Einheit Testfälle für Codecs\nVerbesserte Geschwindigkeit von Codes für Zahlenwerte\nVerbesserte Fehlermeldungen auf UDS negative Antwort",
+        "ru": "Добавлены точки данных в список значимых дел\n4.1.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.2.1.1.2.1.2.1.1.2.1.1.2.1.1.1.1.1.2.1.1.1.1.1.1.1.1.2.2.1.1.1.1.1.2.1.1.1.1.1.1.1.2.2.2.1.1.1.1.1.1.1.1.1.1.1.1.2.1.1.1.2.1.1.2.1.1.1.1.1.1.1.1.1.1.1.1.1\nПовышение скорости кодов для численных значений\nУлучшенные сообщения об ошибках в негативном ответе на СОД",
+        "pt": "Adicionado datapoints para lista writable dids\nAdicionados casos de teste de unidade para codecs\nVelocidade melhorada de códigos para valores numéricos\nMensagens de erro melhoradas na resposta negativa do UDS",
+        "nl": "Toegevoegd datapunten aan lijst schrijfbare does\nToegevoegde testcases per eenheid voor codecs\nVerbeterde snelheid van codes voor numerieke waarden\nVerbeterde foutmeldingen op UDS-negatieve reactie",
+        "fr": "Ajout de points de données pour lister les dids en écriture\nAjout de cas de test unitaire pour codecs\nAmélioration de la vitesse des codes pour les valeurs numériques\nMessages d'erreur améliorés sur la réponse négative UDS",
+        "it": "Aggiunti i datapoints per elencare i fatti scrivibili\nAggiunti casi di prova unità per codecs\nVelocità migliorata dei codici per i valori numerici\nMessaggi di errore migliorati sulla risposta negativa UDS",
+        "es": "Puntos de datos añadidos a la lista de hechos\nCasos de prueba de unidad adicionales para codecs\nMejora de la velocidad de los códigos para los valores numéricos\nMensajes de error mejorados en respuesta negativa UDS",
+        "pl": "Dodano punkty danych do listy zapisanych didów\nDodano jednostkowe przypadki badań kodeków\nZwiększona prędkość kodów dla wartości numerycznych\nUlepszone komunikaty błędów w odpowiedzi negatywnej UDS",
+        "uk": "Додано точки даних для списання збитих даних\nДодані випадки тестування блоку для кодеків\nПокращена швидкість кодів для чисельних значень\nПокращуйте повідомлення про помилки у UDS",
+        "zh-cn": "添加数据点到列表可写作的\n为解码器添加单位测试例\n数字值代码速度提高\nUDS 负面响应上改进错误信息"
+      },
       "0.6.11": {
         "en": "Improved layout of configuration dialog for device scan",
         "de": "Verbessertes Layout des Konfigurationsdialogs für den Gerätescan",

package/lib/canUds.js

@@ -1,11 +1,11 @@
 const storage = require('./storage');
 
 class scheduleLoop {
-    constructor(ctxGlobal, ctxLocal, schedule, dids) {
+    constructor(ctxGlobal, ctxLocal, schedule) {
         this.ctxGlobal   = ctxGlobal;
         this.ctxLocal    = ctxLocal;
         this.schedule    = schedule;
-        this.dids        = dids;
+        this.dids        = [];
         this.schedHandle = null;
     }
 
@@ -30,6 +30,11 @@ class scheduleLoop {
         }
     }
 
+    async addDids(dids) {
+        const didsArr = dids.replace(' ','').split(',');
+        this.dids = this.dids.concat(didsArr.map(function(str) { return parseInt(str); }));
+    }
+
     async loop() {
         await this.ctxGlobal.log.silly('UDS schedule: '+String(this.schedule)+' '+this.ctxLocal.canIDhex+'.'+JSON.stringify(this.dids));
         await this.ctxLocal.pushCmnd(this.ctxGlobal, 'read', this.dids);
@@ -244,13 +249,13 @@ class uds {
     }
 
     async addSchedule(ctx, schedule, dids) {
-        if (!Object.keys(this.schedules).includes(schedule)) {
-            const didsArr = dids.replace(' ','').split(',');
-            this.schedules[schedule] = new scheduleLoop(ctx, this, schedule, didsArr.map(function(str) { return parseInt(str); }));
-            ctx.log.silly('UDS worker on '+this.config.stateBase+': Added schedule '+String(schedule)+'s '+JSON.stringify(didsArr));
-        } else {
-            ctx.log.warn('UDS worker warning on '+this.config.stateBase+': Multiple definiton of schedule:'+String(schedule)+'s');
+        if (!Object.keys(this.schedules).includes(String(schedule))) {
+            // New schedule
+            this.schedules[schedule] = new scheduleLoop(ctx, this, schedule);
+            await ctx.log.silly('UDS worker on '+this.config.stateBase+': Added schedule '+String(schedule)+'s.');
         }
+        await this.schedules[schedule].addDids(dids);
+        await ctx.log.silly('UDS worker on '+this.config.stateBase+': Added dids to schedule '+String(schedule)+'s '+JSON.stringify(this.schedules[schedule].dids));
     }
 
     async pushCmnd(ctx, mode, dids) {
@@ -536,7 +541,7 @@ class uds {
                     if (this.callback) {
                         this.callback(ctx, this, ['negative response', {'did':this.data.did,'didInfo':{'id':'','len':0},'val':''}]);
                     } else {
-                        ctx.log.error('UDS worker error on '+this.config.stateBase+': Negative response on device '+this.canIDhex+'. Code=0x'+Number(candata[3]).toString(16));
+                        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);
                     break;
@@ -634,7 +639,7 @@ class uds {
                 if ( (candata[0] == 0x03) && (candata[1] == 0x7F) && (candata[2] == this.writeByDidProt.SIDtx) ) {
                     // Negative response
                     this.stat.cntCommNR += 1;
-                    ctx.log.error('UDS worker error on '+this.config.stateBase+': Negative response on device '+this.canIDhex+'. Code=0x'+Number(candata[3]).toString(16));
+                    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);
                     break;
                 }
@@ -669,7 +674,7 @@ class uds {
                 if ( (candata[0] == 0x03) && (candata[1] == 0x7F) && (candata[2] == this.writeByDidProt.SIDtx) ) {
                     // Negative response
                     this.stat.cntCommNR += 1;
-                    ctx.log.error('UDS worker error on '+this.config.stateBase+': Negative response on device '+this.canIDhex+'. Code=0x'+Number(candata[3]).toString(16));
+                    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);
                     break;
                 }

package/lib/codecs.js

@@ -1,6 +1,13 @@
 
 const enums = require('./enums');
 
+const C2POW08 = 0x100;
+const C2POW15 = 0x08000;
+const C2POW16 = 0x10000;
+const C2POW24 = 0x1000000;
+const C2POW31 = 0x080000000;
+const C2POW32 = 0x100000000;
+
 function arr2Hex(arr) {
     // Convert byte array to hex string
     let hs = '';
@@ -31,22 +38,22 @@ function sint08toVal(j, ofs=0) {
 }
 
 function uint16toVal(j, ofs=0) {
-    return Math.pow(2,8)*j[ofs+1]+j[ofs];
+    return C2POW08*j[ofs+1]+j[ofs];
 }
 
 function sint16toVal(j, ofs=0) {
-    let v = Math.pow(2,8)*j[ofs+1]+j[ofs];
-    if (v >= Math.pow(2,15)) { v -= Math.pow(2,16); }
+    let v = C2POW08*j[ofs+1]+j[ofs];
+    if (v >= C2POW15) { v -= C2POW16; }
     return v;
 }
 
 function uint32toVal(j, ofs=0) {
-    return Math.pow(2,24)*j[ofs+3]+Math.pow(2,16)*j[ofs+2]+Math.pow(2,8)*j[ofs+1]+j[ofs];
+    return C2POW24*j[ofs+3]+C2POW16*j[ofs+2]+C2POW08*j[ofs+1]+j[ofs];
 }
 
 function sint32toVal(j, ofs=0) {
-    let v = Math.pow(2,24)*j[ofs+3]+Math.pow(2,16)*j[ofs+2]+Math.pow(2,8)*j[ofs+1]+j[ofs];
-    if (v >= Math.pow(2,31)) { v -= Math.pow(2,32); }
+    let v = C2POW24*j[ofs+3]+C2POW16*j[ofs+2]+C2POW08*j[ofs+1]+j[ofs];
+    if (v >= C2POW31) { v -= C2POW32; }
     return v;
 }
 
@@ -67,7 +74,7 @@ function int2val(j, ofs = 0, signed = false) {
 function val2byteArr(v, byte_width, scale = 1, signed = false) {
     // Convert int08, int16, int32 to byte array. Signed or unsigned.
     let val = Math.round(eval(v) * scale);
-    if ( (signed) && (val < 0) ) { val += Math.pow(2,8*byte_width); }
+    if ( (signed) && (val < 0) ) { val += (2**(8*byte_width)); }
     const string_bin = toByteArray(toHex(val, byte_width*2));
     return string_bin.reverse();
 }
@@ -586,5 +593,6 @@ const O3Ecodecs = {
 module.exports = {
     O3Ecodecs,
     arr2Hex,
-    toByteArray
+    toByteArray,
+    val2byteArr
 };

package/lib/codecs.test.js

@@ -0,0 +1,222 @@
+'use strict';
+
+/**
+ * Tests for codecs
+ *
+ * It's automatically excluded from npm and its build output is excluded from both git and npm.
+ * It is advised to test all your modules with accompanying *.test.js-files
+ */
+
+// tslint:disable:no-unused-expression
+
+const { expect } = require('chai');
+const E3 = require('./codecs');
+const E3DidsDict = require('./didsE3.json');
+
+function toByteArray(hs) {
+    // Convert hex string, e.g. '21A8' to byte array: [33,168]
+    const ba = [];
+    for (let i=0; i<hs.length/2; i++) {
+        ba.push(parseInt(hs.slice(2*i,2*i+2), 16));
+    }
+    return ba;
+}
+
+function codecDecode(descr, expected, codec, len, id, args, val) {
+    it(`${descr} ${JSON.stringify(expected)}`, () => {
+        const f = new codec(len,id,args);
+        const result = f.decode(val);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+}
+
+function codecEncode(descr, expected, codec, len, id, args, val) {
+    it(`${descr} ${JSON.stringify(expected)}`, () => {
+        const f = new codec(len,id,args);
+        const result = f.encode(val);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+}
+
+// val2byteArray:
+describe('codecs.js => val2byteArr()', () => {
+    let val = -1;
+    let expected = [0xff];
+    it(`sint08 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = 2**7-1;
+    expected = [0x7f];
+    it(`sint08 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = -(2**7);
+    expected = [0x80];
+    it(`sint08 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = 2**8-1;
+    expected = [0xff];
+    it(`uint08 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, false);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+
+    val = -1;
+    expected = [0xff,0xff];
+    it(`sint16 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = 2**15-1;
+    expected = [0xff,0x7f];
+    it(`sint16 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = -(2**15);
+    expected = [0x00,0x80];
+    it(`sint16 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = 2**16-1;
+    expected = [0xff,0xff];
+    it(`uint16 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, false);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+
+    val = -1;
+    expected = [0xff,0xff,0xff,0xff];
+    it(`sint32 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = 2**31-1;
+    expected = [0xff,0xff,0xff,0x7f];
+    it(`sint32 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = -(2**31);
+    expected = [0x00,0x00,0x00,0x80];
+    it(`sint32 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, true);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+    val = 2**32-1;
+    expected = [0xff,0xff,0xff,0xff];
+    it(`uint32 ${JSON.stringify(expected)}`, () => {
+        const result = E3.val2byteArr(val, 4, 1, false);
+        expect(JSON.stringify(result)).to.equal(JSON.stringify(expected));
+    });
+});
+
+// Integer DECODER:
+describe('codecs.js => O3EInt8().decode()', () => {
+    codecDecode('Positive Number, scale=10, signed=true ', 5,           E3.O3Ecodecs.O3EInt8, 1, 'test1', {scale:10.0,signed:true, offset: 0}, [0x32]);
+    codecDecode('Positive Number, scale=10, signed=true ', (2**7-1)/10, E3.O3Ecodecs.O3EInt8, 1, 'test2', {scale:10.0,signed:true, offset: 0}, [0x7f]);
+    codecDecode('Negative Number, scale=10, signed=true ', -(2**7)/10,  E3.O3Ecodecs.O3EInt8, 1, 'test3', {scale:10.0,signed:true, offset: 0}, [0x80]);
+    codecDecode('Negative Number, scale= 1, signed=true ', -5,          E3.O3Ecodecs.O3EInt8, 1, 'test4', {scale:1.0, signed:true, offset: 0}, [0xfb]);
+    codecDecode('Positive Number, scale=10, signed=false', 25.1,        E3.O3Ecodecs.O3EInt8, 1, 'test5', {scale:10.0,signed:false,offset: 0}, [0xfb]);
+});
+
+describe('codecs.js => O3EInt16().decode()', () => {
+    codecDecode('Positive Number, scale=10, signed=true ', 5,            E3.O3Ecodecs.O3EInt16, 2, 'test1', {scale:10.0,signed:true, offset: 0}, [0x32,0x00]);
+    codecDecode('Positive Number, scale=10, signed=true ', (2**15-1)/10, E3.O3Ecodecs.O3EInt16, 2, 'test2', {scale:10.0,signed:true, offset: 0}, [0xff,0x7f]);
+    codecDecode('Negative Number, scale=10, signed=true ', -(2**15)/10,  E3.O3Ecodecs.O3EInt16, 2, 'test3', {scale:10.0,signed:true, offset: 0}, [0x00,0x80]);
+    codecDecode('Negative Number, scale= 1, signed=true ', -5,           E3.O3Ecodecs.O3EInt16, 2, 'test4', {scale:1.0, signed:true, offset: 0}, [0xfb,0xff]);
+    codecDecode('Positive Number, scale=10, signed=false', (2**16-1)/10, E3.O3Ecodecs.O3EInt16, 2, 'test5', {scale:10.0,signed:false,offset: 0}, [0xff,0xff]);
+    codecDecode('Positive Number, scale=10, signed=false', 25.1,         E3.O3Ecodecs.O3EInt16, 2, 'test6', {scale:10.0,signed:false,offset: 0}, [0xfb,0x00]);
+});
+
+describe('codecs.js => O3EInt32().decode()', () => {
+    codecDecode('Positive Number, scale=10, signed=true ', 5,            E3.O3Ecodecs.O3EInt32, 4, 'test1', {scale:10.0,signed:true, offset: 0}, [0x32,0x00,0x00,0x00]);
+    codecDecode('Positive Number, scale=10, signed=true ', (2**31-1)/10, E3.O3Ecodecs.O3EInt32, 4, 'test2', {scale:10.0,signed:true, offset: 0}, [0xff,0xff,0xff,0x7f]);
+    codecDecode('Negative Number, scale=10, signed=true ', -(2**31)/10,  E3.O3Ecodecs.O3EInt32, 4, 'test3', {scale:10.0,signed:true, offset: 0}, [0x00,0x00,0x00,0x80]);
+    codecDecode('Negative Number, scale= 1, signed=true ', -5,           E3.O3Ecodecs.O3EInt32, 4, 'test4', {scale:1.0, signed:true, offset: 0}, [0xfb,0xff,0xff,0xff]);
+    codecDecode('Positive Number, scale=10, signed=false', (2**32-1)/10, E3.O3Ecodecs.O3EInt32, 4, 'test5', {scale:10.0,signed:false,offset: 0}, [0xff,0xff,0xff,0xff]);
+    codecDecode('Positive Number, scale=10, signed=false', 25.1,         E3.O3Ecodecs.O3EInt32, 4, 'test6', {scale:10.0,signed:false,offset: 0}, [0xfb,0x00,0x00,0x00]);
+});
+
+// Integer ENCODER:
+describe('codecs.js => O3EInt8().encode()', () => {
+    codecEncode('Positive Number, scale=10, signed=true ', [0x32], E3.O3Ecodecs.O3EInt8, 1, 'test1', {scale:10.0,signed:true, offset: 0}, 5);
+    codecEncode('Positive Number, scale=10, signed=true ', [0x7f], E3.O3Ecodecs.O3EInt8, 1, 'test2', {scale:10.0,signed:true, offset: 0}, (2**7-1)/10);
+    codecEncode('Negative Number, scale=10, signed=true ', [0x80], E3.O3Ecodecs.O3EInt8, 1, 'test3', {scale:10.0,signed:true, offset: 0}, -(2**7)/10);
+    codecEncode('Negative Number, scale= 1, signed=true ', [0xfb], E3.O3Ecodecs.O3EInt8, 1, 'test4', {scale:1.0, signed:true, offset: 0}, -5);
+    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()', () => {
+    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);
+    codecEncode('Negative Number, scale= 1, signed=true ', [0xfb,0xff], E3.O3Ecodecs.O3EInt16, 2, 'test4', {scale:1.0, signed:true, offset: 0}, -5);
+    codecEncode('Positive Number, scale=10, signed=false', [0xff,0xff], E3.O3Ecodecs.O3EInt16, 2, 'test5', {scale:10.0,signed:false,offset: 0}, (2**16-1)/10);
+    codecEncode('Positive Number, scale=10, signed=false', [0xfb,0x00], E3.O3Ecodecs.O3EInt16, 2, 'test6', {scale:10.0,signed:false,offset: 0}, 25.1);
+});
+
+describe('codecs.js => O3EInt32().encode()', () => {
+    codecEncode('Positive Number, scale=10, signed=true ', [0x32,0x00,0x00,0x00], E3.O3Ecodecs.O3EInt32, 4, 'test1', {scale:10.0,signed:true, offset: 0}, 5);
+    codecEncode('Positive Number, scale=10, signed=true ', [0xff,0xff,0xff,0x7f], E3.O3Ecodecs.O3EInt32, 4, 'test2', {scale:10.0,signed:true, offset: 0}, (2**31-1)/10);
+    codecEncode('Negative Number, scale=10, signed=true ', [0x00,0x00,0x00,0x80], E3.O3Ecodecs.O3EInt32, 4, 'test3', {scale:10.0,signed:true, offset: 0}, -(2**31)/10);
+    codecEncode('Negative Number, scale= 1, signed=true ', [0xfb,0xff,0xff,0xff], E3.O3Ecodecs.O3EInt32, 4, 'test4', {scale:1.0, signed:true, offset: 0}, -5);
+    codecEncode('Positive Number, scale=10, signed=false', [0xff,0xff,0xff,0xff], E3.O3Ecodecs.O3EInt32, 4, 'test5', {scale:10.0,signed:false,offset: 0}, (2**32-1)/10);
+    codecEncode('Positive Number, scale=10, signed=false', [0xfb,0x00,0x00,0x00], E3.O3Ecodecs.O3EInt32, 4, 'test6', {scale:10.0,signed:false,offset: 0}, 25.1);
+});
+
+// Complex data structures
+// Do testing for specific dids to cover all available codecs
+describe('codecs.js => O3EComplexType()', () => {
+    const raw_hex = '3b0206004700fd01c30801000300f9013001020030303030303030303030303030383135';
+    const raw_arr = toByteArray(raw_hex);
+    const js = {'BusAddress':59,'BusType':{'ID':2,'Text':'CanInternal'},'DeviceProperty':{'ID':6,'Text':'HMI'},'DeviceFunction':{'ID':0,'Text':'NOTHING'},'SW-Version':'71.509.2243.1','HW-Version':'3.505.304.2','VIN':'0000000000000815'};
+    const cdi = E3DidsDict[256];
+    codecDecode('Decoding did 256 ', js,      E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, raw_arr);
+    // Encoding makes no sense for this did in real life, but testing helps to improve codec robustness
+    codecEncode('Encoding did 256 ', raw_arr, E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, js);
+});
+
+describe('codecs.js => O3EList()', () => {
+    const raw_hex = '0a00b001f30314170b12050e3a313602f30314170b12050e390c3602f30314170b12050e2f273602f30314170b12050d2b063602f30314170b12050d2a233602f30314170b12050d27383602f30314170b12050d26033602f30314170b12050d242d3602f30314170b12050d1f043602f30314170b12050d1e133602';
+    const raw_arr = toByteArray(raw_hex);
+    const js = {'Count':10,'GrandTotal':432,'ListEntries':[{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 14:58:49','Timestamp':1700315929000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 14:57:12','Timestamp':1700315832000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 14:47:39','Timestamp':1700315259000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 13:43:06','Timestamp':1700311386000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 13:42:35','Timestamp':1700311355000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 13:39:56','Timestamp':1700311196000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 13:38:03','Timestamp':1700311083000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 13:36:45','Timestamp':1700311005000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 13:31:04','Timestamp':1700310664000},'Unknown':566},{'Error':{'ID':1011,'Text':'FailureCompressorOutletPressureSensor'},'DateTime':{'DateTime':'18/11/2023, 13:30:19','Timestamp':1700310619000},'Unknown':566}]};
+    const cdi = E3DidsDict[266];
+    codecDecode('Decoding did 266 ', js,      E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, raw_arr);
+    // Encoding makes no sense for this did in real life, but testing helps to improve codec robustness
+    codecEncode('Encoding did 266 ', raw_arr, E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, js);
+});
+
+describe('codecs.js => O3EComplexType()', () => {
+    const raw_hex = '8c01c1007a027e0100';
+    const raw_arr = toByteArray(raw_hex);
+    const js = {'Actual':39.6,'Minimum':19.3,'Maximum':63.4,'Average':38.2,'Unknown':0};
+    const cdi = E3DidsDict[268];
+    codecDecode('Decoding did 268 ', js,      E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, raw_arr);
+    // Encoding makes no sense for this did in real life, but testing helps to improve codec robustness
+    codecEncode('Encoding did 268 ', raw_arr, E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, js);
+});
+
+describe('codecs.js => O3EList()', () => {
+    const raw_hex = '020800091e0000030f001100000003000000000000000000000000000000000000000000000000000000000000000000000000000000000000';
+    const raw_arr = toByteArray(raw_hex);
+    const js = {'Count':2,'Schedules':[{'Start':'08:00:00','Stop':'09:30:00','Unknown':'0000','Mode':3},{'Start':'15:00:00','Stop':'17:00:00','Unknown':'0000','Mode':3}]};
+    const cdi = E3DidsDict[726];
+    codecDecode('Decoding did 726 ', js,      E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, raw_arr);
+    codecEncode('Encoding did 726 ', raw_arr, E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, js);
+});
+
+describe('codecs.js => O3EComplexType()', () => {
+    const raw_hex = '38004f0068005c004b0045005400650059000602780090003c004c004b007400840058000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000028002f004200';
+    const raw_arr = toByteArray(raw_hex);
+    const js = {'CurrentMonth':{'10':51.8,'11':12,'12':14.4,'13':6,'14':7.6,'15':7.5,'16':11.6,'17':13.2,'18':8.8,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'01':5.6,'02':7.9,'03':10.4,'04':9.2,'05':7.5,'06':6.9,'07':8.4,'08':10.1,'09':8.9},'LastMonth':{'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0.4,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':4,'30':4.7,'31':6.6,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0}};
+    const cdi = E3DidsDict[1294];
+    codecDecode('Decoding did 1294 ', js,      E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, raw_arr);
+    // Encoding makes no sense for this did in real life, but testing helps to improve codec robustness
+    codecEncode('Encoding did 1294 ', raw_arr, E3.O3Ecodecs[cdi.codec], cdi.len, cdi.id, cdi.args, js);
+});

package/lib/didsE3Writables.json

@@ -15,6 +15,8 @@
   "436": "MixerSevenCircuitRoomTemperatureSetpoint",
   "438": "MixerEightCircuitRoomTemperatureSetpoint",
   "451": "ExternalAlternatingCurrentPowerSetpoint",
+  "491": "DomesticHotWaterCirculationPump",
+  "497": "DomesticHotWaterCirculationPumpMode",
   "504": "DomesticHotWaterSetpointMetaData",
   "508": "UniversalTimeCoordinatedOffset",
   "524": "ModulationTargetSetpoint",
@@ -79,7 +81,23 @@
   "1009": "MixerTwoCircuitTargetQuickMode",
   "1010": "MixerThreeCircuitTargetQuickMode",
   "1011": "MixerFourCircuitTargetQuickMode",
+  "1084": "FlowTemperatureMinimumMaximumLimit",
+  "1100": "CentralHeatingPumpMinimumMaximumLimit",
+  "1101": "DomesticHotWaterPumpMinimumMaximumLimit",
+  "1102": "MixerOneCircuitPumpMinimumMaximumLimit",
+  "1103": "MixerTwoCircuitPumpMinimumMaximumLimit",
+  "1104": "MixerThreeCircuitPumpMinimumMaximumLimit",
+  "1105": "MixerFourCircuitPumpMinimumMaximumLimit",
+  "1118": "SolarCircuitPumpMinimumMaximumLimit",
   "1167": "ExternalDomesticHotWaterTemperatureSetpoint",
+  "1192": "MixerOneCircuitFlowTemperatureMinimumMaximumLimit",
+  "1193": "MixerTwoCircuitFlowTemperatureMinimumMaximumLimit",
+  "1194": "MixerThreeCircuitFlowTemperatureMinimumMaximumLimit",
+  "1195": "MixerFourCircuitFlowTemperatureMinimumMaximumLimit",
+  "1196": "MixerFiveCircuitFlowTemperatureMinimumMaximumLimit",
+  "1197": "MixerSixCircuitFlowTemperatureMinimumMaximumLimit",
+  "1198": "MixerSevenCircuitFlowTemperatureMinimumMaximumLimit",
+  "1199": "MixerEightCircuitFlowTemperatureMinimumMaximumLimit",
   "1265": "FanTargetSpeedMeta",
   "1363": "FuelCellTargetOperationMode",
   "1394": "SolarChargingDomesticHotWaterSetpoint",

package/main.js

@@ -1,5 +1,12 @@
 'use strict';
 
+/*
+* Unveil life data of Viessmann E3 series devices via CAN bus
+*
+* Based on project open3e: https://github.com/open3e/open3e
+*
+*/
+
 /*
  * Created with @iobroker/create-adapter v2.5.0
  */
@@ -8,9 +15,7 @@
 // you need to create an adapter
 const utils = require('@iobroker/adapter-core');
 
-// Load your modules here, e.g.:
-// const fs = require("fs");
-
+// Loading modules:
 const can = require('socketcan');
 const storage = require('./lib/storage');
 const collect = require('./lib/canCollect');
@@ -28,7 +33,7 @@ class E3oncan extends utils.Adapter {
             name: 'e3oncan',
         });
 
-        this.e380Collect         = null;    // E380 alway is assigned to external bus
+        this.e380Collect         = null;  // E380 always is assigned to external bus
         this.E3CollectInt        = {};    // Dict of collect devices on internal bus
         this.E3CollectExt        = {};    // Dict of collect devices on external bus
         this.collectTimeout      = 1500;  // Timeout (ms) for collecting data

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.e3oncan",
-  "version": "0.6.11",
+  "version": "0.6.13",
   "description": "Collect data on CAN bus for Viessmann E3 devices, e.g. Vitocal, Vitocharge, Energy Meter E380",
   "author": {
     "name": "Juergen",
@@ -18,7 +18,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git@github.com:MyHomeMyData/ioBroker.e3oncan.git"
+    "url": "https://github.com/MyHomeMyData/ioBroker.e3oncan.git"
   },
   "engines": {
     "node": ">= 16"