Add missing params in Docs.

Rem0o · Nov 9, 2023 · 7d5f1ee · 7d5f1ee
1 parent 2fb7b21
commit 7d5f1ee
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/reactComponents/docs/docSection.tsx b/src/reactComponents/docs/docSection.tsx
@@ -9,6 +9,10 @@ export type DocSection = {
 export const parameters = {
   hysteresis: "Minimum temperature difference for a change to occur.",
   responseTime: "Minimum time for a change to occur.",
+  onThewayDown:
+    "Hysteresis and response time parameters will only apply if the temperature is dropping, not increasing.",
+  ignoreHysteresis:
+    "Hysteresis and response time parameters will be ignored as soon at the minimum or maximum temperature point set by the fan curve is hit. Hysteresis will apply when re-entering the set temperature range.",
   tempSource: "Source to use as input.",
   functions: "Choose between Max, Min, Average, Sum, Subtract."
 };

diff --git a/src/reactComponents/docs/fanCurves.tsx b/src/reactComponents/docs/fanCurves.tsx
@@ -77,6 +77,8 @@ const linear: DocSection = {
             <li>Temperature source: {parameters.tempSource}</li>
             <li>Hysteresis: {parameters.hysteresis}</li>
             <li>Response time: {parameters.responseTime}</li>
+            <li>Hysteresis only applies on the way down: {parameters.onThewayDown}</li>
+            <li>Ignore hysteresis at minimum and maximum temps: {parameters.ignoreHysteresis}</li>
           </ul>
         </ParametersCard>
       </>
@@ -111,6 +113,8 @@ const graph: DocSection = {
             <li>Temperature source: {parameters.tempSource}</li>
             <li>Hysteresis: {parameters.hysteresis}</li>
             <li>Response time: {parameters.responseTime}</li>
+            <li>Hysteresis only applies on the way down: {parameters.onThewayDown}</li>
+            <li>Ignore hysteresis at minimum and maximum temps: {parameters.ignoreHysteresis}</li>
           </ul>
         </ParametersCard>
       </>