Added more detailed code comments for the defines

This commit is contained in:
jakeg00dwin 2024-10-18 22:58:49 -07:00
parent 4ba6863eae
commit 06b0686651
1 changed files with 8 additions and 0 deletions

View File

@ -31,6 +31,10 @@
/** /**
* @brief The upper Hystersis value. * @brief The upper Hystersis value.
* This is the upper bound of the digital/boolean hysteresis curve. * This is the upper bound of the digital/boolean hysteresis curve.
*
* 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.
*/ */
#ifndef HYSTERESIS_HI #ifndef HYSTERESIS_HI
#define HYSTERESIS_HI 900 #define HYSTERESIS_HI 900
@ -39,6 +43,10 @@
/** /**
* @brief The lower Hystersis value. * @brief The lower Hystersis value.
* This is the upper bound of the digital/boolean hysteresis curve. * This is the upper bound of the digital/boolean hysteresis curve.
*
* 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.
*/ */
#ifndef HYSTERESIS_LO #ifndef HYSTERESIS_LO
#define HYSTERESIS_LO 700 #define HYSTERESIS_LO 700