Implementation of the new Equitherm algorithm (#146)

* feat: new equitherm algorithm and chart for it (#144)

* refactor: refactoring after #144

* refactor: cosmetic changes (equitherm chart)

* chore: fix typo

* refactor: cosmetic changes

* chore: remove unused files

* chore: resolve conflicts

* refactor: added notes for equitherm parameters

* fix: decimation for Equitherm chart fixed; chartjs updated

* style: HTML code formatting

* chore: added additional description of the ``T`` parameter for Equitherm

* flx: typo

* refactor: after merge

---------

Co-authored-by: P43YM <ip43ym@gmail.com>

src_data/pages/sensors.html

@@ -241,7 +241,9 @@
               setCheckboxValue("[name='filtering']", data.filtering, sensorForm);
               setInputValue("[name='filteringFactor']", data.filteringFactor, {}, sensorForm);
 
-              sensorForm.querySelector("[name='type']").dispatchEvent(new Event("change"));
+              setTimeout(() => {
+                sensorForm.querySelector("[name='type']").dispatchEvent(new Event("change"));
+              }, 10);
 
               setBusy(".form-busy", "form", false, sensorNode);
             };

src_data/pages/settings.html

@@ -106,7 +106,7 @@
                       <option disabled selected data-i18n>settings.system.ntp.timezonePresets</option>
                     </select>
                   </div>
-                  </label>
+                </label>
               </fieldset>
 
               <fieldset>
@@ -354,21 +354,44 @@
                 </label>
               </fieldset>
 
+              <div>
+                <div>
+                  <canvas id="etChart"></canvas>
+                </div>
+
+                <label>
+                  <div>
+                    <span data-i18n>settings.equitherm.chart.targetTemp</span>: <b class="etChartTargetTempValue"></b>°
+                  </div>
+                  <input class="etChartTargetTemp" type="range" value="0" min="0" max="0" step="0.5">
+                </label>
+              </div>
+
               <div class="grid">
                 <label>
-                  <span data-i18n>settings.equitherm.n</span>
-                  <input type="number" inputmode="decimal" name="equitherm[n_factor]" min="0.001" max="10" step="0.001" required>
+                  <span data-i18n>settings.equitherm.slope.title</span>
+                  <input type="number" inputmode="decimal" name="equitherm[slope]" min="0.001" max="10" step="0.001" required>
+                  <small data-i18n>settings.equitherm.slope.note</small>
                 </label>
 
                 <label>
-                  <span data-i18n>settings.equitherm.k</span>
-                  <input type="number" inputmode="decimal" name="equitherm[k_factor]" min="0" max="10" step="0.01" required>
+                  <span data-i18n>settings.equitherm.exponent.title</span>
+                  <input type="number" inputmode="decimal" name="equitherm[exponent]" min="0.1" max="2" step="0.001" required>
+                  <small data-i18n>settings.equitherm.exponent.note</small>
+                </label>
+              </div>
+
+              <div class="grid">
+                <label>
+                  <span data-i18n>settings.equitherm.shift.title</span>
+                  <input type="number" inputmode="decimal" name="equitherm[shift]" min="-15" max="15" step="0.01" required>
+                  <small data-i18n>settings.equitherm.shift.note</small>
                 </label>
 
                 <label>
-                  <span data-i18n>settings.equitherm.t.title</span>
-                  <input type="number" inputmode="decimal" name="equitherm[t_factor]" min="0" max="10" step="0.01" required>
-                  <small data-i18n>settings.equitherm.t.note</small>
+                  <span data-i18n>settings.equitherm.targetDiffFactor.title</span>
+                  <input type="number" inputmode="decimal" name="equitherm[targetDiffFactor]" min="0" max="10" step="0.01" required>
+                  <small data-i18n>settings.equitherm.targetDiffFactor.note</small>
                 </label>
               </div>
 
@@ -424,7 +447,7 @@
                       <span data-i18n>settings.temp.min</span>
                       <input type="number" inputmode="decimal" name="pid[minTemp]" min="0" max="0" step="1" required>
                     </label>
-    
+
                     <label>
                       <span data-i18n>settings.temp.max</span>
                       <input type="number" inputmode="numeric" name="pid[maxTemp]" min="0" max="0" step="1" required>
@@ -453,12 +476,12 @@
                       <span data-i18n>settings.pid.deadband.p_multiplier</span>
                       <input type="number" inputmode="decimal" name="pid[deadband][p_multiplier]" min="0" max="5" step="0.001" required>
                     </label>
-    
+
                     <label>
                       <span data-i18n>settings.pid.deadband.i_multiplier</span>
                       <input type="number" inputmode="decimal" name="pid[deadband][i_multiplier]" min="0" max="1" step="0.001" required>
                     </label>
-    
+
                     <label>
                       <span data-i18n>settings.pid.deadband.d_multiplier</span>
                       <input type="number" inputmode="decimal" name="pid[deadband][d_multiplier]" min="0" max="1" step="0.001" required>
@@ -470,7 +493,7 @@
                       <span data-i18n>settings.pid.deadband.thresholdHigh</span>
                       <input type="number" inputmode="decimal" name="pid[deadband][thresholdHigh]" min="0" max="5" step="0.01" required>
                     </label>
-    
+
                     <label>
                       <span data-i18n>settings.pid.deadband.thresholdLow</span>
                       <input type="number" inputmode="decimal" name="pid[deadband][thresholdLow]" min="0" max="5" step="0.01" required>
@@ -652,7 +675,7 @@
                   </fieldset>
                 </div>
               </details>
-              
+
               <br />
               <button type="submit" data-i18n>button.save</button>
             </form>
@@ -866,11 +889,163 @@
     </footer>
 
     <script src="/static/app.js?{BUILD_TIME}"></script>
+    <script src="/static/chart.js?{BUILD_TIME}"></script>
     <script>
       document.addEventListener('DOMContentLoaded', async () => {
         const lang = new Lang(document.getElementById('lang'));
         lang.build();
 
+        let etChart = null;
+        let etChartConfig = {
+          slope: null,
+          exponent: null,
+          shift: null,
+          unitSystem: null,
+          targetTemp: null,
+          minTemp: null,
+          maxTemp: null,
+          decimated: false
+        };
+
+        const hasNeedDecimationChart = () => {
+          return window.innerWidth <= 800;
+        }
+
+        const makeEquithermChart = () => {
+          if (etChart == null) {
+            const ctx = document.getElementById('etChart').getContext('2d');
+
+            try {
+              etChart = new Chart(ctx, {
+                type: 'line',
+                data: {
+                  datasets: [{
+                    borderColor: (context) => {
+                      const chart = context.chart;
+                      const { ctx, chartArea } = chart;
+
+                      if (!chartArea) {
+                        return;
+                      }
+
+                      const gradient = ctx.createLinearGradient(0, chartArea.bottom, 0, chartArea.top);
+                      gradient.addColorStop(0, 'rgba(1, 114, 173, 1)');
+                      gradient.addColorStop(0.5, 'rgba(255, 99, 132, 1)');
+
+                      return gradient;
+                    },
+                    borderWidth: 3,
+                    fill: false,
+                    tension: 0.1,
+                    pointRadius: 2,
+                    pointHoverRadius: 4,
+                    indexAxis: "x",
+                    data: []
+                  }]
+                },
+                options: {
+                  responsive: true,
+                  resizeDelay: 500,
+                  parsing: false,
+                  interaction: {
+                    mode: 'nearest',
+                    intersect: false
+                  },
+                  plugins: {
+                    tooltip: {
+                      enabled: true,
+                      position: 'nearest',
+                      displayColors: false,
+                      callbacks: {
+                        title: (items) => {
+                          return `${i18n("settings.equitherm.chart.outdoorTemp")}: ${items[0].label}`;
+                        }
+                      }
+                    },
+                    legend: {
+                      display: false
+                    }
+                  },
+                  scales: {
+                    x: {
+                      display: true,
+                      type: "linear",
+                      reverse: true,
+                      title: {
+                        display: true
+                      },
+                      ticks: {
+                        stepSize: 1,
+                        format: {
+                          style: "unit",
+                          unit: "degree",
+                          unitDisplay: "narrow"
+                        }
+                      }
+                    },
+                    y: {
+                      display: true,
+                      title: {
+                        display: true
+                      },
+                      ticks: {
+                        format: {
+                          style: "unit",
+                          unit: "degree",
+                          unitDisplay: "narrow"
+                        }
+                      }
+                    }
+                  }
+                }
+              });
+
+            } catch (error) {
+              console.log(error);
+            }
+          }
+
+          if (!etChart) {
+            return;
+          }
+
+          let data = [];
+          etChartConfig.decimated = hasNeedDecimationChart();
+          for (let value = 30; value >= -30; value -= etChartConfig.decimated ? 2 : 1) {
+            const outdoorTemp = etChartConfig.unitSystem == 0 ? value : c2f(value);
+
+            data.push({
+              x: parseFloat(outdoorTemp.toFixed(1)),
+              y: parseFloat(calculateEquithermTemp(outdoorTemp).toFixed(1))
+            });
+          }
+
+          etChart.data.datasets[0].data = data;
+          etChart.data.datasets[0].label = i18n("settings.equitherm.chart.setpointTemp");
+          etChart.options.scales.x.title.text = i18n("settings.equitherm.chart.outdoorTemp");
+          etChart.options.scales.y.title.text = i18n("settings.equitherm.chart.setpointTemp");
+          etChart.update();
+        }
+
+        const calculateEquithermTemp = (outdoorTemp) => {
+          const tempDelta = etChartConfig.targetTemp - outdoorTemp;
+          const maxPoint = etChartConfig.targetTemp - (
+            etChartConfig.maxTemp - etChartConfig.targetTemp
+          ) / etChartConfig.slope;
+
+          const sf = (etChartConfig.maxTemp - etChartConfig.targetTemp) / Math.pow(
+            etChartConfig.targetTemp - maxPoint,
+            1 / etChartConfig.exponent
+          );
+          const result = etChartConfig.targetTemp + etChartConfig.shift + sf * (
+            tempDelta >= 0
+              ? Math.pow(tempDelta, 1 / etChartConfig.exponent)
+              : -(Math.pow(-(tempDelta), 1 / etChartConfig.exponent))
+          );
+
+          return Math.max(Math.min(result, etChartConfig.maxTemp), etChartConfig.minTemp);
+        }
+
         const fillData = (data) => {
           // System
           setSelectValue("[name='system[logLevel]']", data.system.logLevel);
@@ -1019,9 +1194,10 @@
 
           // Equitherm
           setCheckboxValue("[name='equitherm[enabled]']", data.equitherm.enabled);
-          setInputValue("[name='equitherm[n_factor]']", data.equitherm.n_factor);
-          setInputValue("[name='equitherm[k_factor]']", data.equitherm.k_factor);
-          setInputValue("[name='equitherm[t_factor]']", data.equitherm.t_factor);
+          setInputValue("[name='equitherm[slope]']", data.equitherm.slope);
+          setInputValue("[name='equitherm[exponent]']", data.equitherm.exponent);
+          setInputValue("[name='equitherm[shift]']", data.equitherm.shift);
+          setInputValue("[name='equitherm[targetDiffFactor]']", data.equitherm.targetDiffFactor);
           setBusy('#equitherm-settings-busy', '#equitherm-settings', false);
 
           // PID
@@ -1045,6 +1221,24 @@
           setInputValue("[name='pid[deadband][thresholdHigh]']", data.pid.deadband.thresholdHigh);
           setInputValue("[name='pid[deadband][thresholdLow]']", data.pid.deadband.thresholdLow);
           setBusy('#pid-settings-busy', '#pid-settings', false);
+
+          const etMinTemp = parseInt(data.system.unitSystem == 0 ? 5 : 41);
+          const etMaxTemp = parseInt(data.system.unitSystem == 0 ? 30 : 86);
+          const etTargetTemp = constrain(parseFloat(data.heating.target), etMinTemp, etMaxTemp);
+
+          setInputValue(".etChartTargetTemp", etTargetTemp.toFixed(1), {
+            "min": etMinTemp,
+            "max": etMaxTemp
+          });
+
+          etChartConfig.slope = data.equitherm.slope;
+          etChartConfig.exponent = data.equitherm.exponent;
+          etChartConfig.shift = data.equitherm.shift;
+          etChartConfig.unitSystem = data.system.unitSystem;
+          etChartConfig.minTemp = data.heating.minTemp;
+          etChartConfig.maxTemp = data.heating.maxTemp;
+
+          makeEquithermChart();
         };
 
         try {
@@ -1074,7 +1268,7 @@
             cache: "no-cache",
             credentials: "include"
           });
-          
+
           if (!response.ok) {
             throw new Error('Response not valid');
           }
@@ -1097,6 +1291,57 @@
         } catch (error) {
           console.log(error);
         }
+
+        document.querySelector(".etChartTargetTemp").addEventListener("input", async (event) => {
+          setValue('.etChartTargetTempValue', parseFloat(event.target.value).toFixed(1));
+        });
+
+        document.querySelector(".etChartTargetTemp").addEventListener("change", async (event) => {
+          if (!event.target.checkValidity()) {
+            return;
+          }
+
+          etChartConfig.targetTemp = parseFloat(event.target.value);
+          setValue('.etChartTargetTempValue', etChartConfig.targetTemp.toFixed(1));
+          makeEquithermChart();
+        });
+
+        document.querySelector("[name='equitherm[slope]']").addEventListener("change", async (event) => {
+          if (!event.target.checkValidity()) {
+            return;
+          }
+
+          etChartConfig.slope = parseFloat(event.target.value);
+          makeEquithermChart();
+        });
+
+        document.querySelector("[name='equitherm[exponent]']").addEventListener("change", async (event) => {
+          if (!event.target.checkValidity()) {
+            return;
+          }
+
+          etChartConfig.exponent = parseFloat(event.target.value);
+          makeEquithermChart();
+        });
+
+        document.querySelector("[name='equitherm[shift]']").addEventListener("change", async (event) => {
+          if (!event.target.checkValidity()) {
+            return;
+          }
+
+          etChartConfig.shift = parseFloat(event.target.value);
+          makeEquithermChart();
+        });
+
+        window.addEventListener('resize', async (event) => {
+          if (etChart) {
+            etChart.resize();
+
+            if (etChartConfig.decimated != hasNeedDecimationChart()) {
+              makeEquithermChart();
+            }
+          }
+        });
       });
     </script>
   </body>