From 06b0686651a261060f37ae9d26384cab397b401b Mon Sep 17 00:00:00 2001 From: jakeg00dwin Date: Fri, 18 Oct 2024 22:58:49 -0700 Subject: [PATCH] Added more detailed code comments for the defines --- src/load/load.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/load/load.h b/src/load/load.h index 0b6d1d6..b837758 100644 --- a/src/load/load.h +++ b/src/load/load.h @@ -31,6 +31,10 @@ /** * @brief The upper Hystersis value. * 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 #define HYSTERESIS_HI 900 @@ -39,6 +43,10 @@ /** * @brief The lower Hystersis value. * 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 #define HYSTERESIS_LO 700