From cd7a1529e794b5099ad04757c32cac29277084b9 Mon Sep 17 00:00:00 2001 From: jakeg00dwin Date: Sat, 19 Oct 2024 00:31:54 -0700 Subject: [PATCH] Updated the config.h with more code comments. --- inc/config.h | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/inc/config.h b/inc/config.h index 533d593..421a96d 100644 --- a/inc/config.h +++ b/inc/config.h @@ -56,12 +56,29 @@ const uint16_t GatePulses[5] = {250, 500, 750, 1000, 1250}; const double Tau = 8250; + /** - * @brief Hysteresis value - * Anything below this value will keep or turn on the associated - * pin in thermostat mode. + * @brief The upper Hystersis value.(Override) + * This is the upper bound of the digital/boolean hysteresis curve. It + * takes presidence over the value in `/src/load.h` + * + * If the input is below low it always sets the output high. + * If the input is between high and low with the output high it stays high. + * If the input is above high and the ouput is high it's set low. */ -#define HYSTERESIS 900 +#define HYSTERESIS_HI 900 + + +/** + * @brief The lower Hystersis value.(Override) + * This is the upper bound of the digital/boolean hysteresis curve. It + * takes presidence over the value in `/src/load.h` + * + * If the input is below low it always sets the output high. + * If the input is between high and low with the output high it stays high. + * If the input is above high and the ouput is high it's set low. + */ +#define HYSTERESIS_LO 700 #endif //CONFIG_H