iobroker.e3oncan 0.6.10 → 0.6.11

package/README.md

@@ -40,14 +40,14 @@ A scan for datapoints of each device is also available and should be done during
 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 od adapter has finished a confuration dialog will show up to configure up to two CAN bus adapters (tab "CAN ADAPTER")
+* 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
-* When you're done, press "SAVE" button to apply the changes. This step is **mandatory**. The instance will restart, connect to the CAN adapter and do a scan for devices available on bus. **Please be patient** - this may take up to 20 seconds. You may watch the activities in a 2nd browser tab by looking on the logging info of the adapter.
-* When scan was successful new tabs will get visible in adapter confuration: "LIST OF UDS DEVICES", "LIST OF DATAPOINTS" and "ASSIGNMENTS TO EXTERNAL CAN ADAPTER".
-* Go to the "LIST OF UDS DEVICES" and check the list of devices. You may change the naming on 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. Again this step is **mandatory**.
-* Instance will restart again and after a few seconds you are ready to a scan for available datapoints. Go to tab "LIST OF DATAPOINTS", press button "Start scan ..." and confirm with "OK" to start the scan. Again, **please be patient** - this may take **up to 5 minutes**. You may watch the progress in a 2nd browser tab by looking on the logging info of the 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.
+* Instance will restart again and after a few seconds you are ready to do a scan for available datapoints. Go to tab "LIST OF DATAPOINTS", press button "Start scan ..." and confirm with "OK". **Please be patient** - this may take **up to 5 minutes**. You may watch the progress in a 2nd browser tab by looking on the logging info of the adapter.
 This step is not mandatory but strongly recomended. If you would like to write to datapoints you need to do a datapoint scan first.
-* When datapoint scan was completed successfully, the datapoints are available in object tree for each device. You may view the datapoints in configuration by selecting a device and pressing button "Update list of datapoints". Press filter symbol and type search pattern to filter for name and/or codec. This is for your information only. Please deactivate filtering before selecting another device to avoid error messages.
+* When datapoint scan was completed successfully, the datapoints are available in the object tree for each device. You may view the datapoints in configuration by selecting a device and pressing button "Update list of datapoints". Press filter symbol and type search pattern to filter for name and/or codec. This is for your information only. Please deactivate filtering before selecting another device to avoid error messages.
 * 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.
@@ -84,12 +84,11 @@ You may use datapoints informations on tab "LIST OF DATAPOINTS" for reference (o
 * At present, the communication protocol is known only for Vitocal (listener on CAN id 0x693) and Vitocharge VX3 (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 tree.
-* **WriteByDid is supported for all data types** but restricted to datapoints on device specific white list, see info section of device. 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.
-* A scan for datapoints per device (as depict tool of open3e is doing) is available now. After a successful scan, device specific datapoints are listed in object tree.
-* In addation to open3e real time collecting of data via listening is supported.
+* 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.
 
-## May open3 be used in parallel?
+## May open3e be used in parallel?
 Yes, that is possible under certain conditions:
 * If you only use data collecting here, you can use open3e with no limitiations.
 * If you use UDSonCAN here, it's important not to do this for the same devices as open3e does. If you would do so, you will have sporadic communications errors.
@@ -99,6 +98,9 @@ Yes, that is possible under certain conditions:
     Placeholder for the next version (at the beginning of the line):
     ### **WORK IN PROGRESS**
 -->
+### 0.6.11 (2024-01-17)
+* (MyHomeMyData) Improved layout of configuration dialog for device scan
+
 ### 0.6.10 (2024-01-15)
 * (MyHomeMyData) Removed code for Rawmode because it's never activated
 

package/admin/i18n/de/translations.json

@@ -56,5 +56,6 @@
     "Separate by comma! All given datapoints will be requested with specified schedule and ECU address.": "Durch Komma trennen! Alle angegebenen Datenpunkte werden mit der angegebenen Wiederholungszeit von der ECU-Adresse angefordert.",
     "Assignments to Internal CAN Adapter": "Zuordnungen zum internen CAN-Adapter",
     "Collecting Data on Internal CAN Adapter": "Sammeln von Daten auf dem internen CAN-Adapter",
-    "Update list of datapoints": "Liste der Datenpunkte aktualisieren"
+    "Update list of datapoints": "Liste der Datenpunkte aktualisieren",
+    "Start scan to update list of devices": "Scan starten, um die Liste der UDS-Geräte zu aktualisieren"
 }

package/admin/i18n/en/translations.json

@@ -56,5 +56,6 @@
     "Separate by comma! All given datapoints will be requested with specified schedule and ECU address.":"Separate by comma! All given datapoints will be requested with specified schedule and ECU address.",
     "Assignments to Internal CAN Adapter":"Assignments to Internal CAN Adapter",
     "Collecting Data on Internal CAN Adapter":"Collecting Data on Internal CAN Adapter",
-    "Update list of datapoints":"Update list of datapoints"
+    "Update list of datapoints":"Update list of datapoints",
+    "Start scan to update list of devices":"Start scan to update list of devices"
 }

package/admin/i18n/es/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "Recopilación de datos en el adaptador CAN interno",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "Escuche los datos sobre las direcciones que figuran en esta tabla. No se puede escribir en el bus CAN.",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "Dispositivos para la recogida de datos. No se puede escribir en el bus CAN. Presione '+' para agregar el dispositivo.",
-    "Update list of datapoints": "Actualizar lista de puntos de datos"
+    "Update list of datapoints": "Actualizar lista de puntos de datos",
+    "Start scan to update list of devices": "Iniciar escaneo para actualizar la lista de dispositivos"
 }

package/admin/i18n/fr/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "Collecte de données sur l'adaptateur CAN interne",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "Écoutez les données sur les adresses indiquées dans ce tableau. Pas d'écriture sur le bus CAN.",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "Appareils de collecte de données. Pas d'écriture sur le bus CAN. Appuyez sur « + » pour ajouter un appareil.",
-    "Update list of datapoints": "Mettre à jour la liste des points de données"
+    "Update list of datapoints": "Mettre à jour la liste des points de données",
+    "Start scan to update list of devices": "Démarrer l'analyse pour mettre à jour la liste des appareils"
 }

package/admin/i18n/it/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "Raccolta dati sull'adattatore CAN interno",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "Ascoltare i dati sugli indirizzi forniti in questa tabella. Nessuna scrittura sul bus CAN.",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "Dispositivi per la raccolta dei dati. Nessuna scrittura sul bus CAN. Premi \"+\" per aggiungere il dispositivo.",
-    "Update list of datapoints": "Aggiorna l'elenco dei punti dati"
+    "Update list of datapoints": "Aggiorna l'elenco dei punti dati",
+    "Start scan to update list of devices": "Avvia la scansione per aggiornare l'elenco dei dispositivi"
 }

package/admin/i18n/nl/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "Gegevens verzamelen over de interne CAN-adapter",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "Luister naar gegevens over adressen in deze tabel. Geen schrijven naar CAN-bus.",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "Apparaten voor het verzamelen van gegevens. Geen schrijven naar CAN-bus. Druk op '+' om apparaat toe te voegen.",
-    "Update list of datapoints": "Lijst met datapunten bijwerken"
+    "Update list of datapoints": "Lijst met datapunten bijwerken",
+    "Start scan to update list of devices": "Start de scan om de lijst met apparaten bij te werken"
 }

package/admin/i18n/pl/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "Zbieranie danych na wewnętrznym adapterze CAN",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "Posłuchaj danych o adresach podanych w tej tabeli. Brak zapisu do magistrali CAN.",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "Urządzenia do gromadzenia danych. Brak zapisu do magistrali CAN. Naciśnij „+”, aby dodać urządzenie.",
-    "Update list of datapoints": "Zaktualizuj listę punktów danych"
+    "Update list of datapoints": "Zaktualizuj listę punktów danych",
+    "Start scan to update list of devices": "Rozpocznij skanowanie, aby zaktualizować listę urządzeń"
 }

package/admin/i18n/pt/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "Coletando dados no adaptador CAN interno",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "Ouça os dados sobre os endereços fornecidos nesta tabela. Não há gravação no barramento CAN.",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "Dispositivos para coleta de dados. Não há gravação no barramento CAN. Pressione '+' para adicionar dispositivo.",
-    "Update list of datapoints": "Atualizar lista de pontos de dados"
+    "Update list of datapoints": "Atualizar lista de pontos de dados",
+    "Start scan to update list of devices": "Inicie a verificação para atualizar a lista de dispositivos"
 }

package/admin/i18n/ru/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "Сбор данных о внутреннем CAN-адаптере",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "Прослушайте данные по адресам, указанным в этой таблице. Нет записи в CAN-шину.",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "Устройства для сбора данных. Нет записи в CAN-шину. Нажмите «+», чтобы добавить устройство.",
-    "Update list of datapoints": "Обновить список точек данных"
+    "Update list of datapoints": "Обновить список точек данных",
+    "Start scan to update list of devices": "Запустите сканирование, чтобы обновить список устройств."
 }

package/admin/i18n/uk/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "Збір даних про внутрішній адаптер CAN",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "Прослухайте дані за адресами, наведені в цій таблиці. Немає запису на шину CAN.",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "Пристрої для збору даних. Немає запису на шину CAN. Натисніть «+», щоб додати пристрій.",
-    "Update list of datapoints": "Оновити список точок даних"
+    "Update list of datapoints": "Оновити список точок даних",
+    "Start scan to update list of devices": "Почніть сканування, щоб оновити список пристроїв"
 }

package/admin/i18n/zh-cn/translations.json

@@ -58,5 +58,6 @@
     "Collecting Data on Internal CAN Adapter": "收集内部 CAN 适配器的数据",
     "Listen for data on addresses given in this table. No writing to CAN bus.": "侦听此表中给出的地址上的数据。不写入 CAN 总线。",
     "Devices for collecting data. No writing to CAN bus. Press '+' to add device.": "用于收集数据的设备。不写入 CAN 总线。按“+”添加设备。",
-    "Update list of datapoints": "更新数据点列表"
+    "Update list of datapoints": "更新数据点列表",
+    "Start scan to update list of devices": "开始扫描以更新设备列表"
 }

package/admin/jsonConfig.json

@@ -99,15 +99,6 @@
                     "hidden": "if ((data.tableUdsDevices) && (data.tableUdsDevices.length > 0)) { return true; } else {return false; }",
                     "newLine": true
                 },
-                "introTableScanIsActiveTxt": {
-                    "type": "staticText",
-                    "text": "UDS device scan is ongoing. This may take up to 20 seconds.",
-                    "newLine": true,
-                    "hidden": "if ((data.tableUdsDevices) && (data.tableUdsDevices.length > 0)) { return true; } else {return false; }",
-                    "style": {
-                        "color": "red"
-                    }
-                },
                 "introTableNoEmptyDevNameTxt": {
                     "type": "staticText",
                     "text": "'Device state name' must not be blank!",
@@ -126,11 +117,23 @@
                         "color": "red"
                     }
                 },
+                "tableUdsDevicesButton": {
+                    "type": "sendTo",
+                    "label": "Start scan to update list of devices",
+                    "variant": "outlined",
+                    "showProcess": true,
+                    "command": "getUdsDevices",
+                    "jsonData": "{}",
+                    "useNative": true,
+                    "hidden": "!_alive",
+                    "newLine": true,
+                    "sm": 12,
+                    "md": 12,
+                    "lg": 12
+                },
 
                 "tableUdsDevices": {
                     "type": "table",
-                    "defaultSendTo": "getUdsDevices",
-                    "jsonData": "${JSON.stringify(data.tableUdsDevices)}",
                     "uniqueColumns": ["devStateName"],
                     "newLine": true,
                     "sm": 12,
@@ -206,9 +209,6 @@
                     "label": "Start scan for datapoints of all devices",
                     "variant": "outlined",
                     "showProcess": true,
-                    "style": {
-                        "align": "right"
-                    },
                     "jsonData": "{}",
                     "command": "startDidScan",
                     "confirm": {

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "e3oncan",
-    "version": "0.6.10",
+    "version": "0.6.11",
     "news": {
+      "0.6.11": {
+        "en": "Improved layout of configuration dialog for device scan",
+        "de": "Verbessertes Layout des Konfigurationsdialogs für den Gerätescan",
+        "ru": "Улучшен диалог настройки для сканирования устройства",
+        "pt": "Melhor layout da caixa de diálogo de configuração para verificação do dispositivo",
+        "nl": "Verbeterde lay-out van configuratiedialoog voor apparaatscans",
+        "fr": "Mise en page améliorée de la boîte de dialogue de configuration pour l'analyse des périphériques",
+        "it": "Miglioramento del layout della finestra di dialogo di configurazione per la scansione del dispositivo",
+        "es": "Diseño mejorado del diálogo de configuración para el análisis del dispositivo",
+        "pl": "Ulepszony układ okna konfiguracji skanowania urządzenia",
+        "uk": "Покращений макет діалогу конфігурації для сканування пристроїв",
+        "zh-cn": "设备扫描配置对话框的改进版式"
+      },
       "0.6.10": {
         "en": "Removed code for Rawmode because it's never activated",
         "de": "Entfernter Code für Rawmode, weil es nie aktiviert ist",

package/main.js

@@ -46,7 +46,6 @@ class E3oncan extends utils.Adapter {
         this.udsDidForScan       = 256;    // Busidentification is in this id
         this.udsScanWorker       = new udsScan.udsScan();
         this.udsScanDevices      = [];     // UDS devices found during scan
-        this.doUdsDevScan        = false;
         this.udsDevAddrs         = [];
         this.udsDevStateNames    = [];
         this.udsDidsMaxNmbr      = 3000;    // Max. number of dids per device for scan
@@ -80,10 +79,6 @@ class E3oncan extends utils.Adapter {
             this.udsDevStateNames.push(dev.devStateName);
         }
 
-        // Check for required scan for UDS devices
-        this.doUdsDevScan = (this.config.tableUdsDevices.length == 0);
-        if (this.doUdsDevScan) await this.log.info('UDS device scan is required.');
-
         // Setup external CAN bus if required
         // ==================================
 
@@ -326,25 +321,18 @@ class E3oncan extends utils.Adapter {
             if (obj.command === 'getUdsDevices') {
                 if (obj.callback) {
                     if (!this.udsDevScanIsRunning) {
-                        if (this.doUdsDevScan) {
-                            let success = false;
-                            this.udsDevScanIsRunning = true;
-                            await this.log.silly(`Received data - ${JSON.stringify(obj)}`);
-                            //this.udsScanDevices = obj.message.udsDevices;
-                            success = await this.udsScanWorker.scanUdsDevices(this);
-                            await this.sendTo(obj.from, obj.command, this.udsDevices, obj.callback);
-                            if (success) this.doUdsDevScan = false;
-                            this.udsDevScanIsRunning = false;
-                        } else {
-                            // Scan not required. Do nothing
-                            this.sendTo(obj.from, obj.command, obj.message, obj.callback);
-                        }
+                        this.udsDevScanIsRunning = true;
+                        await this.log.silly(`Received data - ${JSON.stringify(obj)}`);
+                        await this.udsScanWorker.scanUdsDevices(this);
+                        await this.log.silly(`Data to send - ${JSON.stringify({native: {tableUdsDevices: this.udsDevices}})}`);
+                        await this.sendTo(obj.from, obj.command, {native: {tableUdsDevices: this.udsDevices}}, obj.callback);
+                        this.udsDevScanIsRunning = false;
                     } else {
                         await this.log.debug('Request "getUdsDevice" during running UDS scan!');
-                        this.sendTo(obj.from, obj.command, obj.message, obj.callback);
+                        this.sendTo(obj.from, obj.command, {native: {tableUdsDevices: this.udsDevices}}, obj.callback);
                     }
                 } else {
-                    this.sendTo(obj.from, obj.command, [], obj.callback);
+                    this.sendTo(obj.from, obj.command, {native: {tableUdsDevices: []}}, obj.callback);
                 }
             }
 

package/package.json

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