Updated the config.h with more code comments.

This commit is contained in:
jakeg00dwin 2024-10-19 00:31:54 -07:00
parent 7484b88d55
commit cd7a1529e7
1 changed files with 21 additions and 4 deletions

View File

@ -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