iobroker.idm-multitalent_002 1.2.2 → 1.2.4

package/README.md

@@ -48,6 +48,12 @@ Settings of the serial adapter:
 ```
 
 ## Changelog
+### 1.2.4 (2024-01-21)
+* (zloe) further improve logging and handling of transmission errors
+
+### 1.2.3 (2024-01-21)
+* (zloe) improve handling of data transmission problems
+
 ### 1.2.2 (2024-01-21)
 * (zloe) fix handling of data transmission problems which lead to stopping requesting data
 

package/io-package.json

@@ -1,8 +1,14 @@
 {
     "common": {
         "name": "idm-multitalent_002",
-        "version": "1.2.2",
+        "version": "1.2.4",
         "news": {
+            "1.2.4": {
+                "en": "* improve logging and handling of data transmission problems\n\n## License\nMIT License\n\nCopyright (c) 2024 zloe <klaus@zloebl.net>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE."
+            },
+            "1.2.3": {
+                "en": "* improve handling of data transmission problems\n\n## License\nMIT License\n\nCopyright (c) 2024 zloe <klaus@zloebl.net>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE."
+            },
             "1.2.2": {
                 "en": "* fix handling of data transmission problems which lead to stopping requesting data\n\n## License\nMIT License\n\nCopyright (c) 2024 zloe <klaus@zloebl.net>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE."
             },

package/lib/idm-protocol.js

@@ -7,6 +7,7 @@ const idm_protocol = {
     dataDefinitions: new Map(),
     sensorDataBlocks: new Map(),
     settingsDataBlocks: new Map(),
+    speed: new Map(),
 
 
     initialize: function () {
@@ -14,31 +15,37 @@ const idm_protocol = {
         idm_protocol.dataBlocks.set('idm701100', idm_datablocks.idm701100);
         idm_protocol.sensorDataBlocks.set('idm701100', idm_datablocks.idm701100_sensors);
         idm_protocol.settingsDataBlocks.set('idm701100', idm_datablocks.idm701100_settings);
+        idm_protocol.speed.set('idm701100', idm_datablocks.idm701100_speed);
 
         idm_protocol.dataDefinitions.set('idm712100', idm_datablocks.idm712100_data);
         idm_protocol.dataBlocks.set('idm712100', idm_datablocks.idm712100);
         idm_protocol.sensorDataBlocks.set('idm712100', idm_datablocks.idm712100_sensors);
         idm_protocol.settingsDataBlocks.set('idm712100', idm_datablocks.idm712100_settings);
+        idm_protocol.speed.set('idm712100', idm_datablocks.idm712100_speed);
 
         idm_protocol.dataDefinitions.set('idm722100', idm_datablocks.idm722100_data);
         idm_protocol.dataBlocks.set('idm722100', idm_datablocks.idm722100);
         idm_protocol.sensorDataBlocks.set('idm722100', idm_datablocks.idm722100_sensors);
         idm_protocol.settingsDataBlocks.set('idm722100', idm_datablocks.idm722100_settings);
+        idm_protocol.speed.set('idm722100', idm_datablocks.idm722100_speed);
 
         idm_protocol.dataDefinitions.set('S_H726100', idm_datablocks.S_H726100_data);
         idm_protocol.dataBlocks.set('S_H726100', idm_datablocks.S_H726100);
         idm_protocol.sensorDataBlocks.set('S_H726100', idm_datablocks.S_H726100_sensors);
         idm_protocol.settingsDataBlocks.set('S_H726100', idm_datablocks.S_H726100_settings);
+        idm_protocol.speed.set('S_H726100', idm_datablocks.S_H726100_speed);
 
         idm_protocol.dataDefinitions.set('idm750100', idm_datablocks.idm750100_data);
         idm_protocol.dataBlocks.set('idm750100', idm_datablocks.idm750100);
         idm_protocol.sensorDataBlocks.set('idm750100', idm_datablocks.idm750100_sensors);
         idm_protocol.settingsDataBlocks.set('idm750100', idm_datablocks.idm750100_settings);
+        idm_protocol.speed.set('idm750100', idm_datablocks.idm750100_speed);
 
         idm_protocol.dataDefinitions.set('EVR752101', idm_datablocks.evr752101_data);
         idm_protocol.dataBlocks.set('EVR752101', idm_datablocks.evr752101);
         idm_protocol.sensorDataBlocks.set('EVR752101', idm_datablocks.evr752101_sensors);
         idm_protocol.settingsDataBlocks.set('EVR752101', idm_datablocks.evr752101_settings);
+        idm_protocol.speed.set('EVR752101', idm_datablocks.EVR752101_speed);
 
     },
 
@@ -148,32 +155,33 @@ const idm_protocol = {
 
             if (idm_utils.ord(ch) === 1) {
                 if (idm_protocol.receive_state !== 0) {
-                    return 11;
+                    return 11 + idm_protocol.receive_state * 100;
                 }
 
                 idm_protocol.receive_state = 1;
             } else {
                 if (idm_utils.ord(ch) === 3) {
                     if (idm_protocol.receive_state !== 1) {
-                        return 13;
+                        return 13 + idm_protocol.receive_state * 100;
                     }
 
                     idm_protocol.receive_state = 2;
                 } else {
                     if (idm_utils.ord(ch) === 4) {
+                        if (idm_protocol.receive_state == 0) { continue; } // ignore end end of text at the start
                         if (idm_protocol.receive_state !== 2) {
-                            return 14;
+                            return 14 + idm_protocol.receive_state * 100;
                         }
 
                         if (idm_protocol.receive_chksum.length !== 3) {
-                            return 15;
+                            return 15 + idm_protocol.receive_state * 100;
                         }
 
                         chksum_c = idm_utils.calc_checksum(idm_protocol.received_data_packet);
                         chksum_r = idm_utils.read_val(3, idm_protocol.receive_chksum);
 
                         if (chksum_c !== chksum_r) {
-                            return 16;
+                            return 16 + idm_protocol.receive_state * 100;
                         }
 
                         idm_protocol.receive_state = 3;
@@ -189,7 +197,7 @@ const idm_protocol = {
                         }
 
                         if (idm_protocol.receive_state === 3) {
-                            return 20;
+                            return 20 + idm_protocol.receive_state * 100;
                         }
                     }
                 }

package/lib/idm_datablocks.js

@@ -9,6 +9,7 @@ const idm_datablocks = {
     idm701100: ['03', '04', '05', '06', '07', '08', '09', '0A', '0B'],
     idm701100_sensors: ['07', '09', '0A', '0B'],
     idm701100_settings: [ '03', '04', '05', '06', '08' ],
+    idm701100_speed: 100,
     idm701100_data: {
         version: 'idm701100',
         data_blocks: [
@@ -191,6 +192,7 @@ const idm_datablocks = {
     idm712100: ['03', '04', '05', '06', '07', '08', '09', '0A', '0B', '0C'],
     idm712100_sensors: ['07', '09', '0B', '0C'],
     idm712100_settings: [ '03', '04', '05', '06', '08', '0A' ],
+    idm712100_speed: 100,
     idm712100_data: {
         version: 'idm712100',
         data_blocks: [
@@ -383,6 +385,7 @@ const idm_datablocks = {
     idm722100: ['03', '04', '05', '06', '07', '08', '09', '0A', '0B', '0C', '0D'],
     idm722100_sensors: ['07', '0B', '0C', '0D'],
     idm722100_settings: [ '03', '04', '05', '06', '08', '09', '0A' ],
+    idm722100_speed: 75,
     idm722100_data: {
         version: 'idm722100',
         data_blocks: [
@@ -585,6 +588,7 @@ const idm_datablocks = {
     S_H726100: ['03', '04', '05', '06', '07', '08', '09', '0A', '0B', '0C', '0D'],
     S_H726100_sensors: ['07', '0B', '0C', '0D'],
     S_H726100_settings: [ '03', '04', '05', '06', '08', '09', '0A' ],
+    S_H726100_speed: 100,
     S_H726100_data: {
         version: 'S_H726100',
         data_blocks: [
@@ -832,6 +836,7 @@ const idm_datablocks = {
     idm750100: ['03', '04', '05', '06', '07', '09', '0B', '0C', '0D', '0E'],
     idm750100_sensors: ['07', '0B', '0C', '0D', '0E'],
     idm750100_settings: [ '03', '04', '05', '06', '09' ],
+    idm750100_speed: 100,
     idm750100_data: {
         version: 'idm750100',
         data_blocks: [
@@ -1044,6 +1049,7 @@ const idm_datablocks = {
     evr752101: ['03', '04', '05', '06', '07', '09', '0B', '0C', '0D', '0E'],
     evr752101_sensors: ['07', '0B', '0C', '0D', '0E'],
     evr752101_settings: [ '03', '04', '05', '06', '09' ],
+    evr752101_speed: 100,
     evr752101_data: {
         version: 'EVR752101',
         data_blocks: [

package/main.js

@@ -50,7 +50,7 @@ class IdmMultitalent002 extends utils.Adapter {
     sendQueue = new Queue();
     maxWrites = 5;  // max values to be set in one "loop"
     requestInitDelay = 600;
-    requestDataBlockDelay = 600;
+    requestDataBlockDelay = 1000;
     normalDataContentDelay = 850; // for all datablocks
     retryDataContentDelay = 250; // for all datablocks
     currentRequests = 0;
@@ -83,6 +83,22 @@ class IdmMultitalent002 extends utils.Adapter {
         }
     }
 
+    speedAdjusted = false;
+    AdjustSpeed() {
+        if (this.speedAdjusted) return;
+        var factor = idm.speed[this.version];
+        if (factor != null) {
+            if (factor != 100 && factor > 0) {
+                this.log.info('adjusting speed to ' + factor + '%');
+                factor = 100 / factor;
+                this.requestInitDelay =         Math.round(this.requestInitDelay * factor);
+                this.requestDataBlockDelay =    Math.round(this.requestDataBlockDelay * factor);
+                this.normalDataContentDelay =   Math.round(this.normalDataContentDelay * factor);
+                this.retryDataContentDelay =    Math.round(this.retryDataContentDelay * factor);
+                this.speedAdjusted = true;
+            }
+        }
+    }
     setIDMState(stateName, value) {
         this.setStateAsync(stateName, value, true);
     }
@@ -159,6 +175,11 @@ class IdmMultitalent002 extends utils.Adapter {
     }
 
     sendSetValueMessage(item) {
+        if (this.sendSetValueMessageTimeout1 == null) {
+            this.sendSetValueMessageTimeout2 = null;
+        } else {
+            this.sendSetValueMessageTimeout1 = null;
+        }
         if (this.idmProtocolState !== 2 && this.idmProtocolState !== 0) {
             this.log.warn('wrong state, should be in 2 but we are in ' + this.idmProtocolState + ' resetting connection');
             this.setConnected(false, true);
@@ -196,13 +217,13 @@ class IdmMultitalent002 extends utils.Adapter {
             if (this.send_state === 0) {
                 this.itemToBeSent = this.sendQueue.dequeue();
                 this.log.info('setting values: ' + idm.get_protocol_string(this.itemToBeSent));
-                if (this.client) setTimeout(this.send_init.bind(this), this.setValueDelay);
+                if (this.client) this.sendInitTimer = setTimeout(this.send_init.bind(this), this.setValueDelay);
                 this.send_state++;
             } else if (this.send_state === 1) {
-                if (this.client) setTimeout(this.sendSetValueMessage.bind(this, this.itemToBeSent), this.setValueDelay);
+                if (this.client) this.sendSetValueMessageTimeout1 = setTimeout(this.sendSetValueMessage.bind(this, this.itemToBeSent), this.setValueDelay);
                 this.send_state++;
             } else if (this.send_state === 2) {
-                if (this.client) setTimeout(this.sendSetValueMessage.bind(this, this.itemToBeSent), this.secondSetValueOffset);
+                if (this.client) this.sendSetValueMessageTimeout2 = setTimeout(this.sendSetValueMessage.bind(this, this.itemToBeSent), this.secondSetValueOffset);
                 this.send_state=0;
                 this.send_count++;
             }
@@ -218,8 +239,15 @@ class IdmMultitalent002 extends utils.Adapter {
         this.send_init();
     }
 
+    sendInitTimer;
+    sendDataBlockRequestTimer;
+    sendDataContentTimer;
+    sendSetValueMessageTimeout1;
+    sendSetValueMessageTimeout2;
+
     // send the init message to the control
     send_init() {
+        this.sendInitTimer = null;
         if (this.connectedToIDM === false) {
             this.log.info('sending initial init message to heatpump');
         }
@@ -244,6 +272,7 @@ class IdmMultitalent002 extends utils.Adapter {
      * @param {string} dataBlock
      */
     send_data_block_request(dataBlock) {
+        this.sendDataBlockRequestTimer = null;
         if (this.idmProtocolState !== 2) {
             if (this.idmProtocolState == -1) { this.log.info('send_data_block_request: not connected, ignore'); return;}
             this.log.warn('send_data_block_request: wrong state, should be in 2 but we are in ' + this.idmProtocolState + ' resetting connection');
@@ -273,7 +302,7 @@ class IdmMultitalent002 extends utils.Adapter {
         } else {
             this.log.debug('requesting data block ' + dataBlock);
         }
-        setTimeout(this.send_data_block_request.bind(this, dataBlock), this.requestDataBlockDelay);
+        this.sendDataBlockRequestTimer = setTimeout(this.send_data_block_request.bind(this, dataBlock), this.requestDataBlockDelay);
     }
 
     lastSettingsIndex = 0; // used to iterate settings data blocks
@@ -316,12 +345,13 @@ class IdmMultitalent002 extends utils.Adapter {
             this.requestingSensorData = true;
         }
 
-        setTimeout(this.request_data_block.bind(this, datablockToRequest), this.requestDataBlockDelay);
+        this.request_data_block(datablockToRequest);
 
     }
 
     // send a data content request to the control
     request_data_content() {
+        this.sendDataContentTimer = null;
         if (this.idmProtocolState !== 4) {
             if (this.idmProtocolState == -1) { this.log.info('request_data_content: not connected, ignore'); return;}
             this.log.warn('request_data_content: wrong state, should be in 4 but we are in ' + this.idmProtocolState + ' resetting connection');
@@ -341,7 +371,7 @@ class IdmMultitalent002 extends utils.Adapter {
     // callback for data received from control
     // this will be the main method for handling the state machine and communication with the heatpump
     // we have the "internal" receiving state ( 1.. receiving data, 2.. receiving checksum, 3.. finished, all above 3 are error states)
-    // then the protocolState ( 
+    // then the protocolState  (derived from received data) ( 
     //      NR.. data request not ready, retry!
     //      E0.. too short packet, 
     //      E1.. request data error, 
@@ -350,7 +380,7 @@ class IdmMultitalent002 extends utils.Adapter {
     //      R1.. request data ok, 
     //      S1.. set value ok, 
     //      U1.. unknown response)
-    // and the idmProtocolState 
+    // and the idmProtocolState (derived from what "we" requested)
     //      -1.. not connected
     //       0.. idle or data received --> 1 or 6
     //       1.. init sent, waiting for answer --> 2
@@ -361,8 +391,8 @@ class IdmMultitalent002 extends utils.Adapter {
     //       6.. data set value sent, waiting for ack  --> 0
     receive_data(data) {
       var state = idm.add_to_packet(data);
-      this.log.silly('************* receiving **************** state ' + state + ' data=' + idm.get_protocol_string(data));
       if (state == 3) { // data packed received completely, let's check what we've got
+        this.log.silly('************* receiving **************** state ' + state + ' data=' + idm.get_protocol_string(data));
         var received_data = idm.get_data_packet();
         idm.reset();   // reset the packet reader to be ready for the next packet
         var protocolState = idm.protocol_state(received_data);
@@ -377,7 +407,7 @@ class IdmMultitalent002 extends utils.Adapter {
             this.retry_count = 0;
             this.totalRequests ++;
             this.currentRequests ++;
-            setTimeout(this.request_data_content.bind(this), this.normalDataContentDelay); // request the data content
+            this.sendDataContentTimer = setTimeout(this.request_data_content.bind(this), this.normalDataContentDelay); // request the data content
             return;
         }
         if (protocolState === 'NR') {
@@ -389,7 +419,7 @@ class IdmMultitalent002 extends utils.Adapter {
             if (this.retry_count > this.maxRetries) {
                 this.log.warn('too many data content request retries (' + this.retry_count + '), retry whole request.');
                 this.idmProtocolState = 0;
-                this.setTimeout(this.send_init.bind(this), this.requestInitDelay);
+                this.sendInitTimer = this.setTimeout(this.send_init.bind(this), this.requestInitDelay);
                 return;
             }
             this.retry_count++;
@@ -397,7 +427,7 @@ class IdmMultitalent002 extends utils.Adapter {
             this.currentRetries++;
             this.log.debug('retry data request ' + this.retry_count);
             this.idmProtocolState = 4;
-            setTimeout(this.request_data_content.bind(this), this.retryDataContentDelay); // request the data content again
+            this.sendDataContentTimer = setTimeout(this.request_data_content.bind(this), this.retryDataContentDelay); // request the data content again
             return;
         }
         if (protocolState === 'S1') { // have to be in idmProtocolState 6
@@ -409,8 +439,8 @@ class IdmMultitalent002 extends utils.Adapter {
             this.idmProtocolState = 0;
             this.need_to_send_data = this.write_data_to_heatpump(!this.need_to_send_data);
             if (!this.need_to_send_data) {
-                this.setTimeout(this.send_init.bind(this), this.requestInitDelay);
-                this.log.debug('set time to send init in order to request next data block');
+                this.sendInitTimer = this.setTimeout(this.send_init.bind(this), this.requestInitDelay);
+                this.log.debug('set timer to send init in order to request next data block');
             }
             return;
         }
@@ -427,7 +457,7 @@ class IdmMultitalent002 extends utils.Adapter {
             this.idmProtocolState = 0;
             this.need_to_send_data= this.write_data_to_heatpump(!this.need_to_send_data);
             if (!this.need_to_send_data) {
-                this.setTimeout(this.send_init.bind(this), this.requestInitDelay);
+                this.sendInitTimer = this.setTimeout(this.send_init.bind(this), this.requestInitDelay);
                 this.log.debug('set time to send init in order to request next data block');
             }
             return;
@@ -444,6 +474,7 @@ class IdmMultitalent002 extends utils.Adapter {
                 this.setStateAsync('idm_control_version', this.version, true);
                 this.setConnected(true);
                 this.CreateStates();
+                this.AdjustSpeed();
             }
             if (this.need_to_send_data) {
                 this.need_to_send_data = this.write_data_to_heatpump(false);
@@ -456,20 +487,27 @@ class IdmMultitalent002 extends utils.Adapter {
             if (protocolState ==='E1' || protocolState === 'E2') {
                 this.log.warn('data content request error, retry whole request.');
                 this.idmProtocolState = 0;
-                this.setTimeout(this.send_init.bind(this), this.requestInitDelay);
+                this.sendInitTimer = this.setTimeout(this.send_init.bind(this), this.requestInitDelay);
                 return;
             }
             this.log.warn('not sure what to do, idm-protocol-state ' + this.idmProtocolStateToText());
             this.log.warn('unknown protocol state ' + protocolState + ' data=' + text);
             this.log.warn('trying to send init message to restart communication');
             this.idmProtocolState = 0;
-            this.setTimeout(this.send_init.bind(this), this.requestInitDelay * 2);
+            this.sendInitTimer = this.setTimeout(this.send_init.bind(this), this.requestInitDelay * 2);
         }
       } else if (state > 3) {
+        this.log.debug('************* receiving **************** state ' + state + ' data=' + idm.get_protocol_string(data));
         this.log.warn('wrong state in receiving data, state is ' + state + ' resetting the transmission and retrying to continue communication');
         idm.reset();
-        this.setTimeout(this.send_init.bind(this), this.requestInitDelay * 2);
-    }
+        // clear all timers to avoid confusion
+        if (this.sendInitTimer) {this.clearTimeout(this.sendInitTimer);this.sendInitTimer = null;}
+        if (this.sendDataBlockRequestTimer) {this.clearTimeout(this.sendDataBlockRequestTimer);this.sendDataBlockRequestTimer = null;}
+        if (this.sendDataContentTimer) {this.clearTimeout(this.sendDataContentTimer);this.sendDataContentTimer = null;}
+        if (this.sendSetValueMessageTimeout1) {this.clearTimeout(this.sendSetValueMessageTimeout1);this.sendSetValueMessageTimeout1 = null;}
+        if (this.sendSetValueMessageTimeout2) {this.clearTimeout(this.sendSetValueMessageTimeout2);this.sendSetValueMessageTimeout2 = null;}
+        this.sendInitTimer = this.setTimeout(this.send_init.bind(this), this.requestInitDelay * 2);        
+      }
 
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.idm-multitalent_002",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Read and write values of a iDM heatpump with multitalent.002 control.",
   "author": {
     "name": "zloe",