Updated the documentation version

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = "Thermostat"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.1
+PROJECT_NUMBER         = 1.2.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

dist/attiny404/production/memoryfile.xml

@@ -4,8 +4,8 @@
     <memory name="program">              
       <units>bytes</units>                 
       <length>4096</length>                 
-      <used>2174</used>                     
-      <free>1922</free>                     
+      <used>2334</used>                     
+      <free>1762</free>                     
     </memory>                              
     <memory name="data">                 
       <units>bytes</units>                 

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

mocks/MockRegEdit/MockRegEdit.c

@@ -75,7 +75,7 @@ void RegEdit_SetNum(void *reg, uint8_t num)
 
 uint8_t RegEdit_ReadReg(void *reg)
 {
-    mock_c()->actualCall("RegEdit_ReadReg")
+    return mock_c()->actualCall("RegEdit_ReadReg")
         ->withPointerParameters("reg", reg)
         ->returnUnsignedIntValueOrDefault(0);
     //Return value is mock controlled. So it does actually return a uint8_t

src/load/load.c

@@ -38,9 +38,23 @@ static bool is_valid_load(uint16_t val)
     return false;
 }
 
-static bool is_below_target(uint16_t val)
+static bool is_high_valid(uint16_t val, bool output_level)
 {
-    if(val < HYSTERESIS){
+    if(val < HYSTERESIS_LO){
+        return true;
+    }
+    else if(val <= HYSTERESIS_HI && output_level) {
+        return true;
+    }
+    return false;
+}
+
+static bool is_low_valid(uint16_t val, bool output_level)
+{
+    if(val > HYSTERESIS_HI) {
+        return true;
+    }
+    else if(val >= HYSTERESIS_HI && output_level) {
         return true;
     }
     return false;
@@ -60,18 +74,23 @@ static uint16_t sample_adc(uint8_t adc_pin)
 void Load_HandleLoadPortA(uint8_t adc_pin, uint8_t out_pin)
 {
     uint16_t val = sample_adc(adc_pin);
-    if(porta_disabled[adc_pin]){
+    bool out_state = RegEdit_IsBitSet((void *) &PORTA.OUT, out_pin);
+
+    if(porta_disabled[adc_pin]) {
         RegEdit_ClearBit((void *) &PORTA.OUT, out_pin);
     }
-    else if(!is_valid_load(val)){
+    else if(!is_valid_load(val)) {
         RegEdit_ClearBit((void *) &PORTA.OUT, out_pin);
         porta_disabled[adc_pin] = true;
     }
-    else if(is_below_target(val)){
+    else if(is_high_valid(val, out_state)) {
         RegEdit_SetBit((void *) &PORTA.DIR, out_pin);
         RegEdit_SetBit((void *) &PORTA.OUT, out_pin);
     }
-    else{
+    else if(is_low_valid(val, out_pin)) {
+        RegEdit_ClearBit((void *) &PORTA.OUT, out_pin);
+    }
+    else {
         RegEdit_ClearBit((void *) &PORTA.OUT, out_pin);
     }
 }
@@ -79,18 +98,23 @@ void Load_HandleLoadPortA(uint8_t adc_pin, uint8_t out_pin)
 void Load_HandleLoadPortB(uint8_t adc_pin, uint8_t out_pin)
 {
     uint16_t val = sample_adc(adc_pin);
-    if(portb_disabled[adc_pin]){
+    bool out_state = RegEdit_IsBitSet((void *) &PORTB.OUT, out_pin);
+    
+    if(portb_disabled[adc_pin]) {
         RegEdit_ClearBit((void *) &PORTB.OUT, out_pin);
     }
-    else if(!is_valid_load(val)){
+    else if(!is_valid_load(val)) {
         RegEdit_ClearBit((void *) &PORTB.OUT, out_pin);
         portb_disabled[adc_pin] = true;
     }
-    else if(is_below_target(val)) {
+    else if(is_high_valid(val, out_state)) {
         RegEdit_SetBit((void *) &PORTB.DIR, out_pin);
         RegEdit_SetBit((void *) &PORTB.OUT, out_pin);
     }
-    else{
+    else if(is_low_valid(val, out_pin)) {
+        RegEdit_ClearBit((void *) &PORTB.OUT, out_pin);
+    }
+    else {
         RegEdit_ClearBit((void *) &PORTB.OUT, out_pin);
     }
 }

src/load/load.h

@@ -28,10 +28,31 @@
 #define HIGHTHRESH 1000
 
 
-#ifndef HYSTERESIS
-#define HYSTERESIS 900
+/**
+ * @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
 #endif
 
+/**
+ * @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
+#endif
+
+
 /**
  * @brief Checks if the adc pin is inbetween LOWTHRESH and HIGHTHRESH and then
  * sets or disables the output pin on PORTA.

tests/load/test_load.cpp

@@ -18,7 +18,6 @@ extern "C"
 #include <iotn404.h> //ATtiny404 header fille.
 #include "load.h"
 #include "MockADC.h"
-#include "MockADC.h"
 }
 
 TEST_GROUP(test_load)
@@ -55,15 +54,25 @@ void setup_adc_expectations(uint8_t adc_pin)
     mock().expectOneCall("ADC_Disable");
 }
 
-void expect_porta_disabled(uint8_t load_pin)
+void expect_porta_disabled(uint8_t load_pin, bool output_level)
 {
+    mock().expectOneCall("RegEdit_IsBitSet")
+        .withPointerParameter("reg", (void *) &PORTA.OUT)
+        .withUnsignedIntParameter("bit_num", load_pin)
+        .andReturnValue(output_level);
+
     mock().expectOneCall("RegEdit_ClearBit")
         .withPointerParameter("reg", (void *) &PORTA.OUT)
         .withUnsignedIntParameter("bit_num", load_pin);
 }
 
-void expect_porta_enabled(uint8_t load_pin)
+void expect_porta_enabled(uint8_t load_pin, bool output_level)
 {
+    mock().expectOneCall("RegEdit_IsBitSet")
+        .withPointerParameter("reg", (void *) &PORTA.OUT)
+        .withUnsignedIntParameter("bit_num", load_pin)
+        .andReturnValue(output_level);
+
     mock().expectOneCall("RegEdit_SetBit")
         .withPointerParameter("reg", (void *) &PORTA.DIR)
         .withUnsignedIntParameter("bit_num", load_pin);
@@ -73,16 +82,26 @@ void expect_porta_enabled(uint8_t load_pin)
         .withUnsignedIntParameter("bit_num", load_pin);
 }
 
-void expect_portb_disabled(uint8_t load_pin)
+void expect_portb_disabled(uint8_t load_pin, bool output_level)
 {
+    mock().expectOneCall("RegEdit_IsBitSet")
+        .withPointerParameter("reg", (void *) &PORTB.OUT)
+        .withUnsignedIntParameter("bit_num", load_pin)
+        .andReturnValue(output_level);
+
     mock().expectOneCall("RegEdit_ClearBit")
         .withPointerParameter("reg", (void *) &PORTB.OUT)
         .withUnsignedIntParameter("bit_num", load_pin);
 }
 
 
-void expect_portb_enabled(uint8_t load_pin)
+void expect_portb_enabled(uint8_t load_pin, bool output_level)
 {
+    mock().expectOneCall("RegEdit_IsBitSet")
+        .withPointerParameter("reg", (void *) &PORTB.OUT)
+        .withUnsignedIntParameter("bit_num", load_pin)
+        .andReturnValue(output_level);
+
     mock().expectOneCall("RegEdit_SetBit")
         .withPointerParameter("reg", (void *) &PORTB.DIR)
         .withUnsignedIntParameter("bit_num", load_pin);
@@ -97,7 +116,7 @@ TEST(test_load, PortAHandlerDisabledHigh)
     MockADC_PushValue(HIGHTHRESH);
 
     setup_adc_expectations(adc_pin);
-    expect_porta_disabled(load_pin);
+    expect_porta_disabled(load_pin, true);
     
     Load_HandleLoadPortA(adc_pin, load_pin);
 }
@@ -107,41 +126,53 @@ TEST(test_load, PortAHandlerDisabledLow)
     MockADC_PushValue(LOWTHRESH);
 
     setup_adc_expectations(adc_pin);
-    expect_porta_disabled(load_pin);
+    expect_porta_disabled(load_pin, false);
     
     Load_HandleLoadPortA(adc_pin, load_pin);
 }
 
-TEST(test_load, PortAHandlerEnabledBelowTarget)
+TEST(test_load, PortAHandlerEnabledRisingEdgeLO)
 {
-    MockADC_PushValue(HYSTERESIS - 1);
+    //Start from the rising edge.
+    MockADC_PushValue(HYSTERESIS_LO - 1);
 
     setup_adc_expectations(adc_pin);
-    expect_porta_enabled(load_pin);
+    expect_porta_enabled(load_pin, false);
+
+    Load_HandleLoadPortA(adc_pin, load_pin);
+}
+
+TEST(test_load, PortAHandlerEnabledRisingEdgeHI)
+{
+    //Start from the rising edge above lo.
+    MockADC_PushValue(HYSTERESIS_HI - 1);
+
+    setup_adc_expectations(adc_pin);
+    expect_porta_enabled(load_pin, true);
 
     Load_HandleLoadPortA(adc_pin, load_pin);
 }
 
 TEST(test_load, PortAHandlerDisabledAboveTarget)
 {
-    MockADC_PushValue(HYSTERESIS);
+    MockADC_PushValue(HYSTERESIS_HI + 1);
 
     setup_adc_expectations(adc_pin);
-    expect_porta_disabled(load_pin);
+    expect_porta_disabled(load_pin, true);
 
     Load_HandleLoadPortA(adc_pin, load_pin);
 }
 
 TEST(test_load, PortAHandlerDisablesUntilPoweReset)
 {
-    MockADC_PushValue(HYSTERESIS - 1);
+    MockADC_PushValue(HYSTERESIS_HI - 1);
     MockADC_PushValue(HIGHTHRESH);
 
     setup_adc_expectations(adc_pin);
-    expect_porta_disabled(load_pin);
+    expect_porta_disabled(load_pin, true);
 
     setup_adc_expectations(adc_pin);
-    expect_porta_disabled(load_pin);
+    expect_porta_disabled(load_pin, false);
 
     Load_HandleLoadPortA(adc_pin, load_pin);
     Load_HandleLoadPortA(adc_pin, load_pin);
@@ -153,7 +184,7 @@ TEST(test_load, PortBHandlerDisabledHigh)
     MockADC_PushValue(HIGHTHRESH);
 
     setup_adc_expectations(adc_pin);
-    expect_portb_disabled(load_pin);
+    expect_portb_disabled(load_pin, true);
     
     Load_HandleLoadPortB(adc_pin, load_pin);
 }
@@ -163,43 +194,66 @@ TEST(test_load, PortBHandlerDisabledLow)
     MockADC_PushValue(LOWTHRESH);
 
     setup_adc_expectations(adc_pin);
-    expect_portb_disabled(load_pin);
+    expect_portb_disabled(load_pin, false);
     
     Load_HandleLoadPortB(adc_pin, load_pin);
 }
 
 
-TEST(test_load, PortBHandlerEnabledBelowTarget)
+TEST(test_load, PortBHandlerEnabledRisingEdgeLO)
 {
-    MockADC_PushValue(HYSTERESIS - 1);
+    //Start from the rising edge.
+    MockADC_PushValue(HYSTERESIS_LO - 1);
 
     setup_adc_expectations(adc_pin);
-    expect_portb_enabled(load_pin);
+    expect_portb_enabled(load_pin, false);
 
     Load_HandleLoadPortB(adc_pin, load_pin);
 }
 
-
-TEST(test_load, PortBHandlerDisabledAboveTarget)
+TEST(test_load, PortBHandlerEnabledRisingEdgeHI)
 {
-    MockADC_PushValue(HYSTERESIS);
+    //Start from the rising edge.
+    MockADC_PushValue(HYSTERESIS_HI - 1);
 
     setup_adc_expectations(adc_pin);
-    expect_portb_disabled(load_pin);
+    expect_portb_enabled(load_pin, true);
+
+    Load_HandleLoadPortB(adc_pin, load_pin);
+}
+
+TEST(test_load, PortBHandlerDisableFallingEdgeLO)
+{
+    //Start from the falling edge.
+    MockADC_PushValue(HYSTERESIS_LO + 1);
+
+    setup_adc_expectations(adc_pin);
+    expect_portb_disabled(load_pin, false);
+
+    Load_HandleLoadPortB(adc_pin, load_pin);
+}
+
+TEST(test_load, PortBHandlerDisableFallingEdgeHI)
+{
+    //Start from the falling edge.
+    MockADC_PushValue(HYSTERESIS_HI + 1);
+
+    setup_adc_expectations(adc_pin);
+    expect_portb_disabled(load_pin, false);
 
     Load_HandleLoadPortB(adc_pin, load_pin);
 }
 
 TEST(test_load, PortBHandlerDisablesUntilPoweReset)
 {
-    MockADC_PushValue(HYSTERESIS - 1);
+    MockADC_PushValue(HYSTERESIS_HI - 1);
     MockADC_PushValue(HIGHTHRESH);
 
     setup_adc_expectations(adc_pin);
-    expect_portb_disabled(load_pin);
+    expect_portb_disabled(load_pin, true);
 
     setup_adc_expectations(adc_pin);
-    expect_portb_disabled(load_pin);
+    expect_portb_disabled(load_pin, false);
 
     Load_HandleLoadPortB(adc_pin, load_pin);
     Load_HandleLoadPortB(adc_pin, load_pin);