refactor: reworked freeze protection

package.json

@@ -9,7 +9,7 @@
     "gulp": "^5.0.0",
     "gulp-concat": "^2.6.1",
     "gulp-gzip": "^1.4.2",
-    "gulp-html-minifier-terser": "^8.0.0",
+    "gulp-html-minifier-terser": "^7.1.0",
     "gulp-jsonminify": "^1.1.0",
     "gulp-postcss": "^10.0.0",
     "gulp-terser": "^2.1.0",

platformio.ini

@@ -26,7 +26,8 @@ lib_deps =
 	gyverlibs/GyverPID@^3.3.2
 	gyverlibs/GyverBlinker@^1.1.1
 	pstolarz/OneWireNg@^0.14.1
-	milesburton/DallasTemperature@^4.0.6
+	;milesburton/DallasTemperature@^4.0.5
+	https://github.com/Laxilef/Arduino-Temperature-Control-Library#fix_85c
 	laxilef/TinyLogger@^1.1.1
 lib_ignore = OneWire
 build_type = ${secrets.build_type}

src/MainTask.h

@@ -43,8 +43,6 @@ protected:
   bool telnetStarted = false;
   bool emergencyDetected = false;
   unsigned long emergencyFlipTime = 0;
-  bool freezeDetected = false;
-  unsigned long freezeDetectedTime = 0;
 
   #if defined(ARDUINO_ARCH_ESP32)
   const char* getTaskName() override {
@@ -243,7 +241,7 @@ protected:
 
   void heating() {
     // freeze protection
-    if (!settings.heating.enabled) {
+    {
       float lowTemp = 255.0f;
       uint8_t availableSensors = 0;
 
@@ -274,29 +272,40 @@ protected:
         availableSensors++;
       }
 
-      if (availableSensors && lowTemp <= settings.heating.freezeProtection.lowTemp) {
-        if (!this->freezeDetected) {
-          this->freezeDetected = true;
-          this->freezeDetectedTime = millis();
+      if (availableSensors) {
+        if (vars.master.heating.freezing) {
+          if (lowTemp - (float) settings.heating.freezeProtection.highTemp + 0.0001f >= 0.0f) {
+            vars.master.heating.freezing = false;
 
-        } else if (millis() - this->freezeDetectedTime > (settings.heating.freezeProtection.thresholdTime * 1000)) {
-          this->freezeDetected = false;
-          settings.heating.enabled = true;
-          fsSettings.update();
+            Log.sinfoln(
+              FPSTR(L_MAIN),
+              F("No freezing detected. Current low temp: %.2f, threshold (high): %hhu"),
+              lowTemp, settings.heating.freezeProtection.highTemp
+            );
+          }
 
-          Log.sinfoln(
-            FPSTR(L_MAIN),
-            F("Heating turned on by freeze protection, current low temp: %.2f, threshold: %hhu"),
-            lowTemp, settings.heating.freezeProtection.lowTemp
-          );
+        } else {
+          if ((float) settings.heating.freezeProtection.lowTemp - lowTemp + 0.0001f >= 0.0f) {
+            vars.master.heating.freezing = true;
+
+            if (!settings.heating.enabled) {
+              settings.heating.enabled = true;
+              fsSettings.update();
+            }
+
+            Log.sinfoln(
+              FPSTR(L_MAIN),
+              F("Freezing detected! Current low temp: %.2f, threshold (low): %hhu"),
+              lowTemp, settings.heating.freezeProtection.lowTemp
+            );
+          }
         }
 
-      } else if (this->freezeDetected) {
-        this->freezeDetected = false;
-      }
+      } else if (vars.master.heating.freezing) {
+        vars.master.heating.freezing = false;
 
-    } else if (this->freezeDetected) {
-      this->freezeDetected = false;
+        Log.sinfoln(FPSTR(L_MAIN), F("No sensors available, freeze protection unavailable!"));
+      }
     }
   }
 

src/OpenThermTask.h

@@ -170,8 +170,7 @@ protected:
     // Heating settings
     vars.master.heating.enabled = this->isReady()
       && settings.heating.enabled
-      && vars.cascadeControl.input 
-      && !vars.master.heating.blocking
+      && (vars.master.heating.freezing || (vars.cascadeControl.input && !vars.master.heating.blocking))
       && !vars.master.heating.overheat;
 
     // DHW settings

src/RegulatorTask.h

@@ -240,6 +240,11 @@ protected:
       ) * settings.heating.turboFactor;
     }
 
+    // If freezing, set temperature to no lower than low temp provided by freeze protection
+    if (vars.master.heating.freezing && fabsf(settings.heating.freezeProtection.lowTemp - newTemp) < 0.0001f) {
+      newTemp = settings.heating.freezeProtection.lowTemp;
+    }
+
     return newTemp;
   }
 };

src/Settings.h

@@ -121,8 +121,8 @@ struct Settings {
     } overheatProtection;
 
     struct {
+      uint8_t highTemp = 15;
       uint8_t lowTemp = 10;
-      unsigned short thresholdTime = 600;
     } freezeProtection;
   } heating;
 
@@ -304,6 +304,7 @@ struct Variables {
       bool enabled = false;
       bool indoorTempControl = false;
       bool overheat = false;
+      bool freezing = false;
       float setpointTemp = 0.0f;
       float targetTemp = 0.0f;
       float currentTemp = 0.0f;

src/strings.h

@@ -87,6 +87,7 @@ const char S_EXTERNAL_PUMP[]                        PROGMEM = "externalPump";
 const char S_FACTOR[]                               PROGMEM = "factor";
 const char S_FAULT[]                                PROGMEM = "fault";
 const char S_FREEZE_PROTECTION[]                    PROGMEM = "freezeProtection";
+const char S_FREEZING[]                             PROGMEM = "freezing";
 const char S_FILTERING[]                            PROGMEM = "filtering";
 const char S_FILTERING_FACTOR[]                     PROGMEM = "filteringFactor";
 const char S_FLAGS[]                                PROGMEM = "flags";

src/utils.h

@@ -505,8 +505,8 @@ void settingsToJson(const Settings& src, JsonVariant dst, bool safe = false) {
   heatingOverheatProtection[FPSTR(S_LOW_TEMP)] = src.heating.overheatProtection.lowTemp;
 
   auto freezeProtection = heating[FPSTR(S_FREEZE_PROTECTION)].to<JsonObject>();
+  freezeProtection[FPSTR(S_HIGH_TEMP)] = src.heating.freezeProtection.highTemp;
   freezeProtection[FPSTR(S_LOW_TEMP)] = src.heating.freezeProtection.lowTemp;
-  freezeProtection[FPSTR(S_THRESHOLD_TIME)] = src.heating.freezeProtection.thresholdTime;
 
   auto dhw = dst[FPSTR(S_DHW)].to<JsonObject>();
   dhw[FPSTR(S_ENABLED)] = src.dhw.enabled;
@@ -1426,6 +1426,15 @@ bool jsonToSettings(const JsonVariantConst src, Settings& dst, bool safe = false
     changed = true;
   }
 
+  if (!src[FPSTR(S_HEATING)][FPSTR(S_FREEZE_PROTECTION)][FPSTR(S_HIGH_TEMP)].isNull()) {
+    unsigned short value = src[FPSTR(S_HEATING)][FPSTR(S_FREEZE_PROTECTION)][FPSTR(S_HIGH_TEMP)].as<uint8_t>();
+
+    if (isValidTemp(value, dst.system.unitSystem, 1, 50) && value != dst.heating.freezeProtection.highTemp) {
+      dst.heating.freezeProtection.highTemp = value;
+      changed = true;
+    }
+  }
+
   if (!src[FPSTR(S_HEATING)][FPSTR(S_FREEZE_PROTECTION)][FPSTR(S_LOW_TEMP)].isNull()) {
     unsigned short value = src[FPSTR(S_HEATING)][FPSTR(S_FREEZE_PROTECTION)][FPSTR(S_LOW_TEMP)].as<uint8_t>();
 
@@ -1435,15 +1444,9 @@ bool jsonToSettings(const JsonVariantConst src, Settings& dst, bool safe = false
     }
   }
 
-  if (!src[FPSTR(S_HEATING)][FPSTR(S_FREEZE_PROTECTION)][FPSTR(S_THRESHOLD_TIME)].isNull()) {
-    unsigned short value = src[FPSTR(S_HEATING)][FPSTR(S_FREEZE_PROTECTION)][FPSTR(S_THRESHOLD_TIME)].as<unsigned short>();
-
-    if (value >= 30 && value <= 1800) {
-      if (value != dst.heating.freezeProtection.thresholdTime) {
-        dst.heating.freezeProtection.thresholdTime = value;
-        changed = true;
-      }
-    }
+  if (dst.heating.freezeProtection.highTemp < dst.heating.freezeProtection.lowTemp) {
+    dst.heating.freezeProtection.highTemp = dst.heating.freezeProtection.lowTemp;
+    changed = true;
   }
 
 
@@ -2170,6 +2173,7 @@ void varsToJson(const Variables& src, JsonVariant dst) {
   mHeating[FPSTR(S_BLOCKING)] = src.master.heating.blocking;
   mHeating[FPSTR(S_INDOOR_TEMP_CONTROL)] = src.master.heating.indoorTempControl;
   mHeating[FPSTR(S_OVERHEAT)] = src.master.heating.overheat;
+  mHeating[FPSTR(S_FREEZING)] = src.master.heating.freezing;
   mHeating[FPSTR(S_SETPOINT_TEMP)] = roundf(src.master.heating.setpointTemp, 2);
   mHeating[FPSTR(S_TARGET_TEMP)] = roundf(src.master.heating.targetTemp, 2);
   mHeating[FPSTR(S_CURRENT_TEMP)] = roundf(src.master.heating.currentTemp, 2);

src_data/locales/cn.json

@@ -320,9 +320,15 @@
       },
       "freezeProtection": {
         "title": "防冻保护",
-        "desc": "当热媒或室内温度在<b>等待时间</b> 内降至<b>低温阈值</b>以下时，系统将强制启动加热功能。",
-        "lowTemp": "低温阈值",
-        "thresholdTime": "等待时间<small>(秒)</small>"
+        "desc": "如果热载体或室内温度低于 <b>低温</b>，加热将被强制开启。",
+        "highTemp": {
+          "title": "高温阈值",
+          "note": "防冻保护激活后系统恢复正常模式的阈值"
+        },
+        "lowTemp": {
+          "title": "低温阈值",
+          "note": "强制开启加热的阈值"
+        }
       },
 
       "portal": {

src_data/locales/en.json

@@ -119,6 +119,7 @@
         "mHeatEnabled": "Heating enabled",
         "mHeatBlocking": "Heating blocked",
         "mHeatOverheat": "Heating overheat",
+        "mHeatFreezing": "Heating freezing",
         "sHeatActive": "Heating active",
         "mHeatSetpointTemp": "Heating setpoint temp",
         "mHeatTargetTemp": "Heating target temp",
@@ -320,9 +321,15 @@
       },
       "freezeProtection": {
         "title": "Freeze protection",
-        "desc": "Heating will be forced to turn on if the heat carrier or indoor temperature drops below <b>Low temperature</b> during <b>Waiting time</b>.",
-        "lowTemp": "Low temperature threshold",
-        "thresholdTime": "Waiting time <small>(sec)</small>"
+        "desc": "Heating will be forced to turn on if the heat carrier or indoor temperature drops below <b>Low temperature</b>.",
+        "highTemp": {
+          "title": "High temperature threshold",
+          "note": "Threshold when the system returns to normal mode after freeze protection activation"
+        },
+        "lowTemp": {
+          "title": "Low temperature threshold",
+          "note": "Threshold when heating is forced to turn on"
+        }
       },
 
       "portal": {

src_data/locales/it.json

@@ -320,9 +320,15 @@
       },
       "freezeProtection": {
         "title": "Protezione antigelo",
-        "desc": "Il riscaldamento verrà attivato forzatamente se la temperatura del vettore di calore o interna scende al di sotto della <b>temperatura minima</b> durante il <b>tempo di attesa</b>.",
-        "lowTemp": "Soglia di temperatura minima",
-        "thresholdTime": "Tempo di attesa <small>(sec)</small>"
+        "desc": "Il riscaldamento verrà forzatamente attivato se la temperatura del vettore termico o la temperatura interna scende al di sotto della <b>Soglia di temperatura bassa</b>.",
+        "highTemp": {
+          "title": "Soglia di temperatura alta",
+          "note": "Soglia quando il sistema ritorna alla modalità normale dopo l'attivazione della protezione antigelo"
+        },
+        "lowTemp": {
+          "title": "Soglia di temperatura bassa",
+          "note": "Soglia quando il riscaldamento viene forzatamente attivato"
+        }
       },
 
       "portal": {

src_data/locales/nl.json

@@ -294,11 +294,18 @@
         }
       },
       "freezeProtection": {
-        "title": "Vorstbeveiliging",
-        "desc": "De verwarming wordt geforceerd ingeschakeld als de temperatuur van de warmtedrager of de binnentemperatuur onder de <b>Lage temperatuur</b> daalt gedurende de <b>Wachttijd</b>.",
-        "lowTemp": "Drempelwaarde lage temperatuur",
-        "thresholdTime": "Wachttijd <small>(sec)</small>"
+        "title": "Vorbeveiliging",
+        "desc": "Verwarming zal geforceerd worden ingeschakeld als de temperatuur van de warmtedrager of de binnentemperatuur daalt onder de <b>Lage temperatuurdrempel</b>.",
+        "highTemp": {
+          "title": "Hoge temperatuurdrempel",
+          "note": "Drempel waarna het systeem terugkeert naar de normale modus na activering van de vorbeveiliging"
+        },
+        "lowTemp": {
+          "title": "Lage temperatuurdrempel",
+          "note": "Drempel wanneer de verwarming geforceerd wordt ingeschakeld"
+        }
       },
+
       "portal": {
         "login": "Gebruikersnaam",
         "password": "Wachtwoord",

src_data/locales/ru.json

@@ -320,9 +320,15 @@
       },
       "freezeProtection": {
         "title": "Защита от замерзания",
-        "desc": "Отопление будет принудительно включено, если темп. теплоносителя или внутренняя темп. опустится ниже <b>нижнего порога</b> в течение <b>времени ожидания</b>.",
-        "lowTemp": "Нижний порог температуры",
-        "thresholdTime": "Время ожидания <small>(сек)</small>"
+        "desc": "Отопление будет принудительно включено, если темп. теплоносителя или внутренняя темп. опустится ниже <b>нижнего порога</b>.",
+        "highTemp": {
+          "title": "Верхний порог температуры",
+          "note": "Порог, при котором система вернется в нормальное состояние после активации защиты от замерзания"
+        },
+        "lowTemp": {
+          "title": "Нижний порог температуры",
+          "note": "Порог, при котором отопление будет принудительно включено"
+        }
       },
 
       "portal": {

src_data/pages/dashboard.html

@@ -195,6 +195,10 @@
                   <th scope="row" data-i18n>dashboard.states.mHeatOverheat</th>
                   <td><i class="mHeatOverheat"></i></td>
                 </tr>
+                <tr>
+                  <th scope="row" data-i18n>dashboard.states.mHeatFreezing</th>
+                  <td><i class="mHeatFreezing"></i></td>
+                </tr>
                 <tr>
                   <th scope="row" data-i18n>dashboard.states.sHeatActive</th>
                   <td><i class="sHeatActive"></i></td>
@@ -320,7 +324,7 @@
 
       document.addEventListener('DOMContentLoaded', async () => {
         const lang = new Lang(document.getElementById('lang'));
-        await lang.build();
+        lang.build();
 
         let actionTimer = null;
         let actionLongPress = false;
@@ -633,6 +637,11 @@
               result.master.heating.overheat ? "success" : "error",
               result.master.heating.overheat ? "red" : "green"
             );
+            setStatus(
+              '.mHeatFreezing',
+              result.master.heating.freezing ? "success" : "error",
+              result.master.heating.freezing ? "red" : "green"
+            );
             setValue('.mHeatSetpointTemp', result.master.heating.setpointTemp);
             setValue('.mHeatTargetTemp', result.master.heating.targetTemp);
             setValue('.mHeatCurrTemp', result.master.heating.currentTemp);

src_data/pages/index.html

@@ -169,7 +169,7 @@
     <script>
       document.addEventListener('DOMContentLoaded', async () => {
         const lang = new Lang(document.getElementById('lang'));
-        await lang.build();
+        lang.build();
 
         setTimeout(async function onLoadPage() {
           try {

src_data/pages/network.html

@@ -179,7 +179,7 @@
     <script>
       document.addEventListener('DOMContentLoaded', async () => {
         const lang = new Lang(document.getElementById('lang'));
-        await lang.build();
+        lang.build();
 
         const fillData = (data) => {
           setInputValue("[name='hostname']", data.hostname);

src_data/pages/sensors.html

@@ -201,7 +201,7 @@
     <script>
       document.addEventListener("DOMContentLoaded", async () => {
         const lang = new Lang(document.getElementById("lang"));
-        await lang.build();
+        lang.build();
 
         const container = document.querySelector("article");
         const templateNode = container.querySelector("#template");

src_data/pages/settings.html

@@ -265,13 +265,15 @@
 
                 <div class="grid">
                   <label>
-                    <span data-i18n>settings.freezeProtection.lowTemp</span>
-                    <input type="number" inputmode="numeric" name="heating[freezeProtection][lowTemp]" min="0" max="0" step="1" required>
+                    <span data-i18n>settings.freezeProtection.highTemp.title</span>
+                    <input type="number" inputmode="numeric" name="heating[freezeProtection][highTemp]" min="0" max="0" step="1" required>
+                    <small data-i18n>settings.freezeProtection.highTemp.note</small>
                   </label>
 
                   <label>
-                    <span data-i18n>settings.freezeProtection.thresholdTime</span>
-                    <input type="number" inputmode="numeric" name="heating[freezeProtection][thresholdTime]" min="30" max="1800" step="1" required>
+                    <span data-i18n>settings.freezeProtection.lowTemp.title</span>
+                    <input type="number" inputmode="numeric" name="heating[freezeProtection][lowTemp]" min="0" max="0" step="1" required>
+                    <small data-i18n>settings.freezeProtection.lowTemp.note</small>
                   </label>
                 </div>
 
@@ -925,7 +927,7 @@
     <script>
       document.addEventListener('DOMContentLoaded', async () => {
         const lang = new Lang(document.getElementById('lang'));
-        await lang.build();
+        lang.build();
 
         let etChart = null;
         let etChartConfig = {
@@ -1184,11 +1186,14 @@
             "min": 0,
             "max": data.system.unitSystem == 0 ? 99 : 211
           });
+          setInputValue("[name='heating[freezeProtection][highTemp]']", data.heating.freezeProtection.highTemp, {
+            "min": data.system.unitSystem == 0 ? 1 : 34,
+            "max": data.system.unitSystem == 0 ? 50 : 122
+          });
           setInputValue("[name='heating[freezeProtection][lowTemp]']", data.heating.freezeProtection.lowTemp, {
             "min": data.system.unitSystem == 0 ? 1 : 34,
             "max": data.system.unitSystem == 0 ? 30 : 86
           });
-          setInputValue("[name='heating[freezeProtection][thresholdTime]']", data.heating.freezeProtection.thresholdTime);
           setBusy('#heating-settings-busy', '#heating-settings', false);
 
           // DHW

src_data/pages/upgrade.html

@@ -105,7 +105,7 @@
     <script>
       document.addEventListener('DOMContentLoaded', async () => {
         const lang = new Lang(document.getElementById('lang'));
-        await lang.build();
+        lang.build();
 
         setupRestoreBackupForm('#restore');
         setupUpgradeForm('#upgrade');