refactor: added ID validation for opentherm response

lib/CustomOpenTherm/CustomOpenTherm.h

@@ -105,7 +105,7 @@ public:
       temperatureToData(temperature)
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::TSet);
   }
 
   bool setHeatingCh2Temp(float temperature) {
@@ -115,7 +115,7 @@ public:
       temperatureToData(temperature)
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::TsetCH2);
   }
 
   bool setDhwTemp(float temperature) {
@@ -125,7 +125,7 @@ public:
       temperatureToData(temperature)
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::TdhwSet);
   }
 
   bool setRoomSetpoint(float temperature) {
@@ -135,7 +135,7 @@ public:
       temperatureToData(temperature)
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::TrSet);
   }
 
   bool setRoomSetpointCh2(float temperature) {
@@ -145,7 +145,7 @@ public:
       temperatureToData(temperature)
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::TrSetCH2);
   }
 
   bool setRoomTemp(float temperature) {
@@ -155,7 +155,7 @@ public:
       temperatureToData(temperature)
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::Tr);
   }
 
   bool sendBoilerReset() {
@@ -167,7 +167,7 @@ public:
       data
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::RemoteRequest);
   }
 
   bool sendServiceReset() {
@@ -179,7 +179,7 @@ public:
       data
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::RemoteRequest);
   }
 
   bool sendWaterFilling() {
@@ -191,7 +191,13 @@ public:
       data
     ));
 
-    return isValidResponse(response);
+    return isValidResponse(response) && isValidResponseId(response, OpenThermMessageID::RemoteRequest);
+  }
+
+  static bool isValidResponseId(unsigned long response, OpenThermMessageID id) {
+    byte responseId = (response >> 16) & 0xFF;
+    
+    return (byte)id == responseId;
   }
 
   // converters

platformio.ini

@@ -11,6 +11,7 @@
 [platformio]
 ;extra_configs = secrets.ini
 extra_configs = secrets.default.ini
+core_dir = .pio
 
 [env]
 version = 1.4.5

src/OpenThermTask.h

@@ -59,7 +59,12 @@ protected:
     }
 
     if (!GPIO_IS_VALID(settings.opentherm.inGpio) || !GPIO_IS_VALID(settings.opentherm.outGpio)) {
-      Log.swarningln(FPSTR(L_OT), F("Not started. GPIO IN: %hhu or GPIO OUT: %hhu is not valid"), settings.opentherm.inGpio, settings.opentherm.outGpio);
+      Log.swarningln(
+        FPSTR(L_OT),
+        F("Not started. GPIO IN: %hhu or GPIO OUT: %hhu is not valid"),
+        settings.opentherm.inGpio,
+        settings.opentherm.outGpio
+      );
       return;
     }
 
@@ -161,7 +166,7 @@ protected:
       statusLb
     );
 
-    if (!CustomOpenTherm::isValidResponse(response)) {
+    if (!CustomOpenTherm::isValidResponse(response) || !CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::Status)) {
       Log.swarningln(
         FPSTR(L_OT),
         F("Failed receive boiler status: %s"),
@@ -340,7 +345,7 @@ protected:
         if (this->updateFaultCode()) {
           Log.snoticeln(
             FPSTR(L_OT),
-            F("Received fault code: %hhu%% (0x%02X)"),
+            F("Received fault code: %hhu (0x%02X)"),
             vars.sensors.faultCode,
             vars.sensors.faultCode
           );
@@ -360,7 +365,7 @@ protected:
         if (this->updateDiagCode()) {
           Log.snoticeln(
             FPSTR(L_OT),
-            F("Received diag code: %hhu%% (0x%02X)"),
+            F("Received diag code: %hu (0x%02X)"),
             vars.sensors.diagnosticCode,
             vars.sensors.diagnosticCode
           );
@@ -712,6 +717,9 @@ protected:
     
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::SConfigSMemberIDcode)) {
+      return false;
     }
 
     vars.parameters.slaveMemberId = response & 0xFF;
@@ -771,7 +779,7 @@ protected:
       request
     ));
 
-    return CustomOpenTherm::isValidResponse(response);
+    return CustomOpenTherm::isValidResponse(response) && CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::MConfigMMemberIDcode);
   }
 
   bool setMaxModulationLevel(byte value) {
@@ -783,6 +791,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::MaxRelModLevelSetting)) {
+      return false;
     }
 
     vars.parameters.maxModulation = CustomOpenTherm::getFloat(response);
@@ -798,6 +809,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::OpenThermVersionSlave)) {
+      return false;
     }
 
     vars.parameters.slaveOtVersion = CustomOpenTherm::getFloat(response);
@@ -813,6 +827,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::OpenThermVersionMaster)) {
+      return false;
     }
 
     vars.parameters.masterOtVersion = CustomOpenTherm::getFloat(response);
@@ -829,6 +846,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::SlaveVersion)) {
+      return false;
     }
 
     vars.parameters.slaveVersion = response & 0xFF;
@@ -846,6 +866,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::MasterVersion)) {
+      return false;
     }
 
     vars.parameters.masterVersion = response & 0xFF;
@@ -863,6 +886,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::TdhwSetUBTdhwSetLB)) {
+      return false;
     }
 
     byte minTemp = response & 0xFF;
@@ -887,6 +913,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::MaxTSetUBMaxTSetLB)) {
+      return false;
     }
 
     byte minTemp = response & 0xFF;
@@ -908,7 +937,7 @@ protected:
       CustomOpenTherm::temperatureToData(value)
     ));
 
-    return CustomOpenTherm::isValidResponse(response);
+    return CustomOpenTherm::isValidResponse(response) && CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::MaxTSet);
   }
 
   bool updateOutdoorTemp() {
@@ -920,6 +949,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::Toutside)) {
+      return false;
     }
     
     float value = settings.sensors.outdoor.offset + convertTemp(
@@ -947,6 +979,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::Texhaust)) {
+      return false;
     }
 
     float value = (float) CustomOpenTherm::getInt(response);
@@ -979,6 +1014,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::Tboiler)) {
+      return false;
     }
 
     float value = CustomOpenTherm::getFloat(response);
@@ -1011,6 +1049,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::Tret)) {
+      return false;
     }
 
     float value = convertTemp(
@@ -1040,6 +1081,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::Tdhw)) {
+      return false;
     }
 
     float value = CustomOpenTherm::getFloat(response);
@@ -1072,20 +1116,35 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
-    }
 
-    float value = CustomOpenTherm::getFloat(response);
-    if (value < 0 || value > convertVolume(16, UnitSystem::METRIC, settings.opentherm.unitSystem)) {
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::DHWFlowRate)) {
       return false;
     }
 
-    value = convertVolume(
-      value * settings.opentherm.dhwFlowRateFactor,
+    float value = CustomOpenTherm::getFloat(response);
+    if (value < 0) {
+      return false;
+    }
+
+    // correction
+    value = value * settings.opentherm.dhwFlowRateFactor;
+
+    // no minuscule values
+    // some boilers send a response of 0.06 when there is no flow
+    if (value < 0.1f) {
+      value = 0.0f;
+    }
+
+    // protocol declares a maximum of 16 l/m
+    //if (value > convertVolume(16.0f, UnitSystem::METRIC, settings.opentherm.unitSystem)) {
+    //  value = 0.0f;
+    //}
+
+    vars.sensors.dhwFlowRate = convertVolume(
+      value,
       settings.opentherm.unitSystem,
       settings.system.unitSystem
     );
-
-    vars.sensors.dhwFlowRate = value > 0.09f ? value : 0.0f;
     
     return true;
   }
@@ -1099,6 +1158,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::ASFflags)) {
+      return false;
     }
 
     vars.sensors.faultCode = response & 0xFF;
@@ -1114,6 +1176,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::OEMDiagnosticCode)) {
+      return false;
     }
 
     vars.sensors.diagnosticCode = CustomOpenTherm::getUInt(response);
@@ -1129,6 +1194,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::RelModLevel)) {
+      return false;
     }
 
     float value = CustomOpenTherm::getFloat(response);
@@ -1155,6 +1223,9 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
+
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::MaxCapacityMinModLevel)) {
+      return false;
     }
 
     vars.parameters.minModulation = response & 0xFF;
@@ -1172,15 +1243,26 @@ protected:
 
     if (!CustomOpenTherm::isValidResponse(response)) {
       return false;
-    }
 
-    float value = CustomOpenTherm::getFloat(response);
-    if (value < 0 || value > convertPressure(5, UnitSystem::METRIC, settings.opentherm.unitSystem)) {
+    } else if (!CustomOpenTherm::isValidResponseId(response, OpenThermMessageID::CHPressure)) {
       return false;
     }
 
+    float value = CustomOpenTherm::getFloat(response);
+    if (value < 0) {
+      return false;
+    }
+
+    // correction
+    value = value * settings.opentherm.pressureFactor;
+
+    // protocol declares a maximum of 5 bar
+    //if (value > convertPressure(5.0f, UnitSystem::METRIC, settings.opentherm.unitSystem)) {
+    //  value = 0.0f;
+    //}
+
     value = convertPressure(
-      value * settings.opentherm.pressureFactor,
+      value,
       settings.opentherm.unitSystem,
       settings.system.unitSystem
     );