iobroker.e3oncan 0.6.9

package/io-package.json

@@ -0,0 +1,164 @@
+{
+  "common": {
+    "name": "e3oncan",
+    "version": "0.6.9",
+    "news": {
+      "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 版本"
+      },
+      "0.6.6": {
+        "en": "initial npm release",
+        "de": "Erstveröffentlichung auf npm",
+        "ru": "Начальная версия",
+        "pt": "lançamento inicial",
+        "nl": "Eerste uitgave",
+        "fr": "Première version",
+        "it": "Versione iniziale",
+        "es": "Versión inicial",
+        "pl": "Pierwsze wydanie",
+        "uk": "Початкова версія",
+        "zh-cn": "首次出版"
+      }
+    },
+    "title": "Viessmann E3 CAN do",
+    "titleLang": {
+      "en": "Viessmann E3 CAN do",
+      "de": "Viessmann E3 CAN do",
+      "ru": "CAN-прослушиватель серии Viessmann E3",
+      "pt": "Ouvinte CAN da série Viessmann E3",
+      "nl": "Viessmann E3-serie CAN-luisteraar",
+      "fr": "Écouteur CAN Viessmann série E3",
+      "it": "Ascoltatore CAN Viessmann serie E3",
+      "es": "Oyente CAN serie Viessmann E3",
+      "pl": "Odbiornik CAN firmy Viessmann serii E3",
+      "uk": "CAN-слухач серії Viessmann E3",
+      "zh-cn": "菲斯曼E3系列CAN监听器"
+    },
+    "desc": {
+      "en": "Collect data on CAN bus for Viessmann E3 devices, e.g. Vitocal, Vitocharge, Energy Meter E380",
+      "de": "Greifen Sie auf Daten per CAN-Bus zu, für Viessmann E3-Geräte, z.B. Vitocal, Vitocharge, Energiezähler E380",
+      "ru": "Сбор данных по шине CAN для устройств Viessmann E3, например. Vitocal, Vitocharge, Счетчик энергии E380",
+      "pt": "Colete dados no barramento CAN para dispositivos Viessmann E3, por ex. Vitocal, Vitocharge, medidor de energia E380",
+      "nl": "Verzamel gegevens op de CAN-bus voor Viessmann E3-apparaten, b.v. Vitocal, Vitocharge, Energiemeter E380",
+      "fr": "Collectez des données sur le bus CAN pour les appareils Viessmann E3, par ex. Vitocal, Vitocharge, Compteur d'énergie E380",
+      "it": "Raccogliere dati sul bus CAN per dispositivi Viessmann E3, ad es. Vitocal, Vitocharge, Contatore di energia E380",
+      "es": "Recopilar datos en el bus CAN para dispositivos Viessmann E3, p. Vitocal, Vitocharge, Contador de energía E380",
+      "pl": "Zbieraj dane na magistrali CAN dla urządzeń Viessmann E3, np.: Vitocal, Vitocharge, licznik energii E380",
+      "uk": "Збір даних на шині CAN для пристроїв Viessmann E3, напр. Vitocal, Vitocharge, Енерголічильник E380",
+      "zh-cn": "收集 Viessmann E3 设备 CAN 总线上的数据，例如Vitocal、Vitocharge、能量计 E380"
+    },
+    "authors": [
+      "MyHomeMyData <juergen.bonfert@gmail.com>"
+    ],
+    "keywords": [
+      "Viessmann",
+      "E3",
+      "CAN",
+      "Heating",
+      "PV",
+      "Energy Meter"
+    ],
+    "license": "MIT",
+    "platform": "Javascript/Node.js",
+    "main": "main.js",
+    "icon": "e3oncan.png",
+    "enabled": true,
+    "messagebox": true,
+    "extIcon": "https://raw.githubusercontent.com/MyHomeMyData/ioBroker.e3oncan/main/admin/e3oncan.png",
+    "readme": "https://github.com/MyHomeMyData/ioBroker.e3oncan/blob/main/README.md",
+    "loglevel": "debug",
+    "mode": "daemon",
+    "type": "iot-systems",
+    "compact": true,
+    "connectionType": "local",
+    "dataSource": "push",
+    "adminUI": {
+      "config": "json"
+    },
+    "dependencies": [
+      {
+        "js-controller": ">=3.3.22"
+      }
+    ],
+    "globalDependencies": [
+      {
+        "admin": ">=5.1.13"
+      }
+    ]
+  },
+  "native": {
+    "tableUdsDevices": [],
+    "tableUdsDids": []
+  },
+  "objects": [],
+  "instanceObjects": [
+    {
+      "_id": "info",
+      "type": "channel",
+      "common": {
+        "name": {
+          "en": "Information",
+          "de": "Informationen",
+          "ru": "Информация",
+          "pt": "Informação",
+          "nl": "Informatie",
+          "fr": "Informations",
+          "it": "Informazioni",
+          "es": "Información",
+          "pl": "Informacje",
+          "uk": "Інформація",
+          "zh-cn": "资料"
+        }
+      },
+      "native": {}
+    },
+    {
+      "_id": "info.connection",
+      "type": "state",
+      "common": {
+        "role": "indicator.connected",
+        "name": {
+          "en": "Device or service connected",
+          "de": "Geräte oder Service vrbunden",
+          "ru": "Устройство или служба подключены",
+          "pt": "Dispositivo ou serviço conectado",
+          "nl": "Apparaat of dienst verbonden",
+          "fr": "Appareil ou service connecté",
+          "it": "Dispositivo o servizio collegato",
+          "es": "Dispositivo o servicio conectado",
+          "pl": "Przyłączone urządzenie lub usługa",
+          "uk": "Пристрої або послуги підключені",
+          "zh-cn": "设备或服务已连接"
+        },
+        "type": "boolean",
+        "read": true,
+        "write": false,
+        "def": false
+      },
+      "native": {}
+    }
+  ]
+}

package/lib/adapter-config.d.ts

@@ -0,0 +1,19 @@
+// This file extends the AdapterConfig type from "@types/iobroker"
+// using the actual properties present in io-package.json
+// in order to provide typings for adapter.config properties
+
+import { native } from '../io-package.json';
+
+type _AdapterConfig = typeof native;
+
+// Augment the globally declared type ioBroker.AdapterConfig
+declare global {
+    namespace ioBroker {
+        interface AdapterConfig extends _AdapterConfig {
+            // Do not enter anything here!
+        }
+    }
+}
+
+// this is required so the above AdapterConfig is found by TypeScript / type checking
+export {};

package/lib/canCollect.js

@@ -0,0 +1,199 @@
+const storage = require('./storage');
+
+class collect {
+    constructor(config) {
+        this.config = config;
+        this.config.statId = 'statCollect';
+        this.config.worker = 'collect';
+        this.storage = new storage.storage(this.config);
+        this.ts = {};
+        this.msDelay = config.delay*1000;
+        this.timeoutHandle = null;
+        this.maxDid  = 3500;
+        this.commBusy = false;         // Communication routine running
+        this.data = {
+            'len'       : 0,
+            'timestamp' : 0,
+            'databytes' : [],
+            'did'       : 0,
+            'collecting': false,
+            'D0expected': 0x21
+        };
+        this.stat = {
+            state               : 'standby',
+            cntCommTotal        : 0,    // Number collected dids
+            cntCommOk           : 0,    // Number of ok
+            cntCommStored       : 0,    // Number of dids stored
+            cntCommTimeout      : 0,    // Number of timeouts
+            cntCommBadProt      : 0,    // Number of bad communications
+            cntTooBusy          : 0,    // Number of conflicting calls of msgCollect()
+            nextTs              : 0,    // Timestamp for next storage (earliest)
+            tsMinStep           : 5000  // Minimum time step between storages
+        };
+    }
+
+    async initStates(ctx, opMode) {
+        await this.storage.initStates(ctx, opMode);
+        this.stat.state = 'standby';
+        await this.storage.storeStatistics(ctx, this, true);
+    }
+
+    async onTimeout(ctxGlobal, ctxLocal) {
+        ctxGlobal.log.error('Collect timeout on 0x'+Number(ctxLocal.config.canID[0]).toString(16)+'.'+String(ctxLocal.data.did));
+        ctxLocal.stat.cntCommTimeout += 1;
+        ctxLocal.data.collecting = false;
+    }
+
+    async startup(ctx) {
+        this.stat.state = 'active';
+        await this.storage.storeStatistics(ctx, this, true);
+        this.data.collecting = false;
+        await this.storage.setOpMode('normal');
+        await ctx.log.info('Collect worker started on '+this.config.stateBase);
+    }
+
+    async stop(ctx) {
+        try {
+            await this.storage.setOpMode('standby');
+
+            // Stop Timeout:
+            if (this.timeoutHandle) await clearTimeout(this.timeoutHandle);
+            this.timeoutHandle = null;
+
+            this.stat.state = 'stopped';
+            await this.storage.storeStatistics(ctx, this, true);
+
+            // Stop worker:
+            this.data.collecting = false;
+            await ctx.log.info('Collect worker stopped on '+this.config.stateBase);
+        } catch (e) {
+            await ctx.log.error('Collect worker on '+this.config.stateBase+' could not be stopped. err='+e.message);
+        }
+    }
+
+    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'
+
+        if (this.commBusy) {
+            this.stat.cntTooBusy += 1;
+            if (this.stat.cntTooBusy == 1) ctx.log.warn('Collect worker error on '+this.config.stateBase+': Evaluation of messages overloaded.');
+            return;
+        }
+
+        this.commBusy = true;
+        const candata = msg.data.toJSON().data;
+
+        const canid = msg.id;
+        const msgDlc = candata.length;
+        const tsNow = new Date().getTime();
+        if (this.config.device == 'e380') {
+            // Energy meter
+            this.stat.cntCommTotal += 1;
+            this.stat.cntCommOk += 1;
+            if (!(canid in this.ts)) { this.ts[canid] = tsNow; }
+            if ( (this.config.delay == 0) || ((tsNow >= this.ts[canid])) ) {
+                this.stat.cntCommStored += 1;
+                this.storage.decodeDataCAN(ctx,this,msg.id,candata);
+                this.ts[canid] = tsNow+this.msDelay;
+            }
+        } else {
+            // E3 device
+            if (this.data.collecting) {
+                if (candata[0] == this.data.D0expected) {
+                    // append next part of data
+                    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);
+                        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])) ) {
+                            this.stat.cntCommStored += 1;
+                            this.storage.decodeDataCAN(ctx, this, this.data.did, this.data.databytes.slice(0,this.data.len));
+                            this.ts[this.data.did] = tsNow+this.msDelay;
+                        }
+                        this.data.collecting = false;
+                    } else {
+                        // More data to come
+                        this.data.D0expected += 1;
+                        if (this.data.D0expected > 0x2f) {
+                            this.data.D0expected = 0x20;
+                        }
+                    }
+                }
+            }
+
+            const D3 = candata[3];
+            if ( (!this.data.collecting) && (msgDlc > 4) && (candata[0] == 0x21) && (D3 >= 0xb0) && (D3 < 0xc0)) {
+                this.data.D0expected = candata[0];
+                this.data.did = candata[1]+256*candata[2];
+                this.data.timestamp = msg.ts_sec*1000+Math.round(msg.ts_usec/1000);
+                if ( (this.data.did > 0) && (this.data.did < this.maxDid) ) {
+                    switch (D3) {
+                        case 0xb1:
+                        case 0xb2:
+                        case 0xb3:
+                        case 0xb4:
+                            // Single Frame B1,B2,B3,B4
+                            this.data.len = D3-0xb0;
+                            this.data.databytes = candata.slice(4);
+                            this.stat.cntCommTotal += 1;
+                            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])) ) {
+                                this.stat.cntCommStored += 1;
+                                this.storage.decodeDataCAN(ctx, this, this.data.did, this.data.databytes.slice(0,this.data.len));
+                                this.ts[this.data.did] = tsNow+this.msDelay;
+                            }
+                            break;
+                        case 0xb0:
+                            // Multi Frame B0
+                            this.data.D0expected = candata[0]+1;
+                            this.stat.cntCommTotal += 1;
+                            if (candata[4]==0xc1) {
+                                this.data.databytes = candata.slice(6);
+                                this.data.len = candata[5];
+                            } else {
+                                this.data.databytes = candata.slice(5);
+                                this.data.len = candata[4];
+                            }
+                            this.timeoutHandle = setTimeout(this.onTimeout, this.config.timeout, ctx, this);
+                            this.data.collecting = true;
+                            break;
+                        case 0xb5:
+                        case 0xb6:
+                        case 0xb7:
+                        case 0xb8:
+                        case 0xb9:
+                        case 0xba:
+                        case 0xbb:
+                        case 0xbc:
+                        case 0xbd:
+                        case 0xbe:
+                        case 0xbf:
+                            // Multi Frame B6 .. BF
+                            this.stat.cntCommTotal += 1;
+                            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.data.collecting = true;
+                            break;
+                        default:
+                            ctx.log.debug('Collect worker error on '+this.config.stateBase+': Unplausible byte D3: Did='+String(this.data.did)+' D3=0x'+Number(D3).toString(16)+' candata='+this.storage.arr2Hex(candata));
+                    }
+                }
+            }
+        }
+        this.commBusy = false;
+    }
+}
+
+module.exports = {
+    collect
+};