iobroker.e3oncan 0.6.13 → 0.6.14

package/README.md

@@ -15,18 +15,22 @@
 # Basic concept
 Viessmann E3 series devices (One Base) are doing a lot of data exchange on CAN bus.
 
-This adapter can listen to this communication and extract many useful information. The often used energy meter E380 CA is also supported.
+This adapter can listen to this communication and extract many useful information. The often used energy meter E380 CA also is supported.
 
-In parallel UDSonCAN service ReadByDid is supported. Informations not available via listening can be actively requested. This protocol is also used by other equipment, e.g. by well known WAGO gateway.
+In parallel **reading of datapoints** (ReadByDid) is supported. Informations not available via listening can be actively requested. The UDSonCAN protocol is also used by other equipment, e.g. by well known WAGO gateway.
 
-Important parts are based on the project [open3e](https://github.com/open3e).
+**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.
 
-A python based implementation of a pure listening approach using MQTT messaging is also availabe, see [E3onCAN](https://github.com/MyHomeMyData/E3onCAN).
+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.
 
-**Present implementation supports reading and writing of datapoints via UDSonCAN (ReadByDid and WriteByDid).** 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 is restricted to a set of datapoints using a white list.
+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.
 
 During first start of adapter instance a device scan will be done providing a list of all available devices for configuration dialog.
-A scan for datapoints of each device is also available and should be done during first setup.
+A scan for datapoints of each device should be done during first setup.
+
+Important parts of this adpater are based on the project [open3e](https://github.com/open3e).
+
+A python based implementation of a pure listening approach using MQTT messaging is also availabe, see [E3onCAN](https://github.com/MyHomeMyData/E3onCAN).
 
 # Getting started
 
@@ -85,8 +89,8 @@ You may use datapoints informations on tab "LIST OF DATAPOINTS" for reference (o
 
 ## 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.
-* **WriteByDid is supported for all data types** but restricted to datapoints on device specific white list, see info section of devices. You need to do a datapoint scan to enable writing. Writing of data is triggered by storing the datapoint with ack=false - yes, it's that simple! The datapoint will be read again from device two seconds after writing. If datapoint not get's acknowledged, please take a look to the logs.
 * In addition to open3e real time collecting of data via listening is supported.
+* Writing of data is much simpler. Just change the data in corresponding state and press Save button. 
 
 ## May open3e be used in parallel?
 Yes, that is possible under certain conditions:
@@ -98,6 +102,12 @@ Yes, that is possible under certain conditions:
     Placeholder for the next version (at the beginning of the line):
     ### **WORK IN PROGRESS**
 -->
+### 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.
+* (MyHomeMyData) Recognize loss of CAN connection.
+* (MyHomeMyData) Improved handling of info.connection.
+
 ### 0.6.13 (2024-01-20)
 * (MyHomeMyData) Now supports multiple definitions of same schedule on a device 
 * (MyHomeMyData) Added unit test cases for codecs

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "e3oncan",
-    "version": "0.6.13",
+    "version": "0.6.14",
     "news": {
+      "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.",
+        "ru": "Заменить '.' на '_' в идентификаторах точки данных, чтобы избежать нежелательной субструктуры в состояниях данных\nДобавлено больше информации о белом списке для редакций в Readme.\nУзнать потерю соединения CAN.\nУлучшена обработка info.connection.",
+        "pt": "Substituir '.' por '_' em datapoint ids para evitar subestrutura indesejada em estados de dados\nAdicionado mais informações sobre lista branca para writables em Readme.\nReconhecer a perda de conexão CAN.\nMelhor manuseio de info.connection.",
+        "nl": "Vervang '.' door '_' in datapoint ids om ongewenste substructuur in data states te voorkomen\nToegevoegd meer informatie over witte lijst voor schrijfsels in Readme.\nHerkennen verlies van KAN verbinding.\nVerbeterde behandeling van info.connectie.",
+        "fr": "Remplacer '.' par '_' dans les identifiants de points de données pour éviter une sous-structure indésirable dans les états de données\nAjout de plus d'informations sur la liste blanche pour les écritures dans Readme.\nReconnaître la perte de connexion CAN.\nAmélioration de la gestion d'info.connection.",
+        "it": "Sostituire '.' da '_' in datapoint ids per evitare la struttura sub indesiderata in stati di dati\nAggiunto più informazioni su white list per writables in Readme.\nRiconoscere la perdita di connessione CAN.\nGestione migliorata di info.connection.",
+        "es": "Reemplazar '.' por '_' en datospoint ids para evitar la subestructura no deseada en los estados de datos\nAgregó más información sobre la lista blanca para writables en Readme.\nReconocer la pérdida de conexión CAN.\nMejor manejo de info.conexión.",
+        "pl": "Zastąp '.' przez' _ 'w idach punktów danych, aby uniknąć niepożądanej podstruktury w stanach danych\nDodano więcej informacji na temat białej listy pism w Readme.\nRozpoznaj utratę połączenia CAN.\nUlepszone obchodzenie się z info.connection.",
+        "uk": "Замініть \".\" по \"_\" у полицях даних, щоб уникнути небажаної структури під даних\nДодайте більше інформації про білий список для життєздатних в Readme.\nВизначте втрату з'єднання CAN.\nПокращення обробки інформації.",
+        "zh-cn": "在数据点编号中将“.”改为“_”,以避免数据状态中不必要的子结构\n在Readme中添加了更多关于白名单的可写信息.\n识别失去的CAN连接.\n完善信息联通处理."
+      },
       "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",
@@ -80,19 +93,6 @@
         "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",

package/lib/didsE3Writables.json

@@ -13,6 +13,7 @@
   "434": "MixerSixCircuitRoomTemperatureSetpoint",
   "435": "VentilationStageTargetVolumeFlow",
   "436": "MixerSevenCircuitRoomTemperatureSetpoint",
+  "437": "BypassOperationState",
   "438": "MixerEightCircuitRoomTemperatureSetpoint",
   "451": "ExternalAlternatingCurrentPowerSetpoint",
   "491": "DomesticHotWaterCirculationPump",
@@ -23,6 +24,7 @@
   "525": "ExternalModulationSetpoint",
   "527": "FlowTemperatureTargetSetpoint",
   "528": "ExternalTargetFlowTemperatureSetpoint",
+  "531": "DomesticHotWaterOperationState",
   "533": "VentilationTargetOperationLevel",
   "537": "ExternalMixerOneCircuitTargetOperationMode",
   "538": "ExternalDomesticHotWaterTargetOperationMode",
@@ -101,6 +103,14 @@
   "1265": "FanTargetSpeedMeta",
   "1363": "FuelCellTargetOperationMode",
   "1394": "SolarChargingDomesticHotWaterSetpoint",
+  "1415": "MixerOneCircuitOperationState",
+  "1416": "MixerTwoCircuitOperationState",
+  "1417": "MixerThreeCircuitOperationState",
+  "1418": "MixerFourCircuitOperationState",
+  "1419": "MixerFiveCircuitOperationState",
+  "1420": "MixerSixCircuitOperationState",
+  "1421": "MixerSevenCircuitOperationState",
+  "1422": "MixerEightCircuitOperationState",
   "1439": "NoiseReductionTimeScheduleMonday",
   "1440": "NoiseReductionTimeScheduleTuesday",
   "1441": "NoiseReductionTimeScheduleWednesday",
@@ -109,6 +119,7 @@
   "1444": "NoiseReductionTimeScheduleSaturday",
   "1445": "NoiseReductionTimeScheduleSunday",
   "1505": "SolarStagnationTemperatureOffset",
+  "1552": "ElectricalEnergyStorageOperationState",
   "1555": "MixerOneCircuitFixedValueFlowTemperatureSetpoint",
   "1556": "MixerTwoCircuitFixedValueFlowTemperatureSetpoint",
   "1557": "MixerThreeCircuitFixedValueFlowTemperatureSetpoint",
@@ -121,6 +132,8 @@
   "1587": "ExternalAlternatingCurrentPowerSetpointMetaData",
   "1588": "AlternatingCurrentPowerSetpoint",
   "1589": "AlternatingCurrentPowerSetpointMetaData",
+  "1590": "ElectricalEnergySystemOperationState",
+  "1591": "ElectricalEnergyInverterOperationState",
   "1604": "GatewayExternalTargetFlowTemperatureSetpoint",
   "1605": "GatewayExternalHeatEngineTargetOperationMode",
   "1612": "ExternalMixerTwoCircuitTargetOperationMode",
@@ -373,6 +386,7 @@
   "2327": "VentilationTargetVolumeFlow",
   "2345": "CompressorSetpointPercent",
   "2353": "TargetDemandHeatProducer",
+  "2372": "VentilationControllerOperationState",
   "2373": "VentilationAirVolumeFlowBalancingOffset",
   "2417": "MixerOneCircuitTargetValueRelativeHumidityCooling",
   "2418": "MixerTwoCircuitTargetValueRelativeHumidityCooling",
@@ -400,6 +414,7 @@
   "2878": "SubcoolingSetpoint",
   "2883": "ExpansionValveMaximumOperatingPressureTemperatureSetpoint",
   "2985": "ExternalHeaterTemperatureSetpoint",
+  "2986": "ExternalHeaterOperationState",
   "3037": "ElectricityPriceTimeScheduleMonday",
   "3038": "ElectricityPriceTimeScheduleTuesday",
   "3039": "ElectricityPriceTimeScheduleWednesday",

package/lib/storage.js

@@ -280,7 +280,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),itm);
+                            await storeObjectTree(ctx, String(stateId)+'.'+String(key).replace('.','_'),itm);
+                            // No '.' in state id allowed to avoid sub structure
                         }
                     } else {
                         ctx.log.error('Did valuation aborted. Too many members ('+String(Object.keys(obj).length)+') '+stateId+'.'+String(did));
@@ -306,7 +307,7 @@ class storage {
                     ctx.log.warn('Could not retreive codec for '+ctxWorker.config.stateBase+'.'+String(did)+'. err='+e.message);
                     codec = 'RawCodec';
                 }
-                idStr = cdi.id;
+                idStr = cdi.id.replace('.','_');  // No '.' in state allowed to avoid sub structure
                 common = true;
                 try {
                     val = await codec.decode(data);
@@ -316,6 +317,7 @@ class storage {
                     ctx.log.warn('Codec failed: '+ctxWorker.canIDhex+'.'+String(did)+'. err='+e.message);
                 }
             } else {
+                // did length is diffetent from common did length => device specific did
                 idStr = 'DeviceSpecific';
                 val = raw;
                 common = false;

package/main.js

@@ -33,6 +33,7 @@ class E3oncan extends utils.Adapter {
             name: 'e3oncan',
         });
 
+        this.stoppingInstance    = false; // true during unLoad()
         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
@@ -43,6 +44,8 @@ class E3oncan extends utils.Adapter {
         this.channelExtName      = '';
         this.channelInt          = null;
         this.channelIntName      = '';
+        this.cntCanConnDesired   = 0;     // Number of activated CAN connections in config
+        this.cntCanConnActual    = 0;     // Number if actualy connected CAN buses
 
         this.udsWorkers          = {};
         this.udsTimeout          = 7500;   // Timeout (ms) for normal UDS communication
@@ -89,8 +92,9 @@ class E3oncan extends utils.Adapter {
 
         // @ts-ignore
         if (this.config.canExtActivated) {
+            this.cntCanConnDesired++;
             // @ts-ignore
-            [this.channelExt, this.channelExtName] = await this.connectToCan(this.channelExt, this.config.canExtName, this.onCanMsgExt);
+            [this.channelExt, this.channelExtName] = await this.connectToCan(this.channelExt, this.config.canExtName, this.onCanMsgExt, this.onCanExtStopped);
         }
 
         // Setup internal CAN bus if required
@@ -98,8 +102,14 @@ class E3oncan extends utils.Adapter {
 
         // @ts-ignore
         if (this.config.canIntActivated) {
+            this.cntCanConnDesired++;
             // @ts-ignore
-            [this.channelInt, this.channelIntName] = await this.connectToCan(this.channelInt, this.config.canIntName, this.onCanMsgInt);
+            [this.channelInt, this.channelIntName] = await this.connectToCan(this.channelInt, this.config.canIntName, this.onCanMsgInt, this.onCanIntStopped);
+        }
+
+        if (this.cntCanConnActual == this.cntCanConnDesired) {
+            // All configured CAN connections are established
+            await this.setState('info.connection', true, true);
         }
 
         // Setup E380 collect worker:
@@ -119,14 +129,15 @@ class E3oncan extends utils.Adapter {
 
     // Setup CAN busses
 
-    async connectToCan(channel, name, onMsg) {
+    async connectToCan(channel, name, onMsg, onStop) {
         let chName = name;
         if (!channel) {
             try {
                 channel = can.createRawChannel(name, true);
                 await channel.addListener('onMessage', onMsg, this);
+                await channel.addListener('onStopped', onStop, this);
                 await channel.start();
-                await this.setState('info.connection', true, true);
+                this.cntCanConnActual++;
                 await this.log.info('CAN-Adapter connected: '+name);
             } catch (e) {
                 await this.log.error(`Could not connect to CAN-Adapter "${name}" - err=${e.message}`);
@@ -148,7 +159,6 @@ class E3oncan extends utils.Adapter {
                 channel = null;
             }
         }
-        return([channel,'']);
     }
 
     // Setup E380 collect worker:
@@ -247,6 +257,7 @@ class E3oncan extends utils.Adapter {
      */
     async onUnload(callback) {
         try {
+            this.stoppingInstance = true;
             // Stop UDS workers:
             for (const worker of Object.values(this.E3UdsWorkers)) await worker.stop(this);
             for (const worker of Object.values(this.udsScanWorker.workers)) await worker.stop(this);
@@ -261,6 +272,7 @@ class E3oncan extends utils.Adapter {
             await this.disconnectFromCan(this.channelExt,this.config.canExtName);
             // @ts-ignore
             await this.disconnectFromCan(this.channelInt,this.config.canIntName);
+            this.setState('info.connection', false, true);
 
             callback();
         } catch (e) {
@@ -455,6 +467,24 @@ class E3oncan extends utils.Adapter {
         }
     }
 
+    onCanExtStopped() {
+        if (!this.stoppingInstance) {
+            // External CAN connection was terminated unexpectedly
+            this.log.error('External CAN bus was stopped.');
+        }
+        this.cntCanConnActual--;
+        this.setState('info.connection', false, true);
+    }
+
+    onCanIntStopped() {
+        if (!this.stoppingInstance) {
+            // External CAN connection was terminated unexpectedly
+            this.log.error('Internal CAN bus was stopped.');
+        }
+        this.cntCanConnActual--;
+        this.setState('info.connection', false, true);
+    }
+
     onCanMsgExt(msg) {
         if ( (this.e380Collect) && (this.e380Collect.config.canID.includes(msg.id)) ) { this.e380Collect.msgCollect(this, msg); }
         if (this.E3CollectExt[msg.id]) this.E3CollectExt[msg.id].msgCollect(this, msg);

package/package.json

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