v21.07.2 (#217)

James Foster · web-flow · commit 66fabe54cd68 · 2021-07-09T17:27:07.000-07:00
- Memory cleanup to avoid stack/heap collision (fix #186 ?) - Remove many uses of String - Add View Free Memory menu option
diff --git a/.github/actions/spelling/allow/TankControllerLib.cpp.txt b/.github/actions/spelling/allow/TankControllerLib.cpp.txt
@@ -0,0 +1,2 @@
+brkval
+bss
diff --git a/src/Devices/EthernetServer_TC.h b/src/Devices/EthernetServer_TC.h
@@ -17,7 +17,7 @@ class EthernetServer_TC : public EthernetServer {
   // class methods
   static EthernetServer_TC* instance();
   // instance methods
-  virtual String className() const {
+  const char* className() const {
     return "EthernetServer_TC";
   }
   void handleRequest();
diff --git a/src/TankControllerLib.cpp b/src/TankControllerLib.cpp
@@ -19,7 +19,7 @@
 #include "UIState/MainMenu.h"
 #include "UIState/UIState.h"
 
-const char TANK_CONTROLLER_VERSION[] = "21.07.1";
+const char TANK_CONTROLLER_VERSION[] = "21.07.2";
 
 // ------------ Class Methods ------------
 /**
@@ -86,6 +86,23 @@ void TankControllerLib::blink() {
   }
 }
 
+// https://github.com/maniacbug/MemoryFree/blob/master/MemoryFree.cpp
+size_t TankControllerLib::freeMemory() {
+#ifdef MOCK_PINS_COUNT
+  int *__brkval = 0;
+  int __bss_end = 0;
+#else
+  extern int *__brkval;
+  extern int __bss_end;
+#endif
+  int topOfStack;
+
+  if ((size_t)__brkval == 0) {
+    return ((size_t)&topOfStack) - ((size_t)&__bss_end);
+  }
+  return ((size_t)&topOfStack) - ((size_t)__brkval);
+}
+
 /**
  * Is the current UIState one that should disable controls?
  * We don't want to turn on the heat/chill if the temperature probe is out of the tank!
@@ -174,6 +191,7 @@ void TankControllerLib::setup() {
   wdt_enable(WDTO_8S);
   serial("TankControllerLib::setup()");
   SD_TC::instance()->printRootDirectory();
+  serial("Free memory = %i", freeMemory());
 }
 
 /**
diff --git a/src/TankControllerLib.h b/src/TankControllerLib.h
@@ -16,6 +16,7 @@ class TankControllerLib {
 
   // instance methods
   bool isInCalibration();
+  size_t freeMemory();
   void loop();
   void serialEvent();
   void serialEvent1();
diff --git a/src/UIState/CalibrationManagement.h b/src/UIState/CalibrationManagement.h
@@ -15,6 +15,6 @@ class CalibrationManagement : public UIState {
     return "CalibrationManagement";
   }
   const char* prompt() {
-    return "Cal Management  ";
+    return "Cal Management";
   };
 };
diff --git a/src/UIState/EnablePID.h b/src/UIState/EnablePID.h
@@ -18,7 +18,7 @@ class EnablePID : public NumCollectorState {
   }
   float getCurrentValue();
   const char* prompt() {
-    return "PID 1:on; 9:off ";
+    return "PID 1:on; 9:off";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/MainMenu.cpp b/src/UIState/MainMenu.cpp
@@ -11,6 +11,7 @@
 #include "ResetLCDScreen.h"
 #include "SeeDeviceAddress.h"
 #include "SeeDeviceUptime.h"
+#include "SeeFreeMemory.h"
 #include "SeeGoogleMins.h"
 #include "SeeLogFile.h"
 #include "SeePHSlope.h"
@@ -30,28 +31,29 @@
 #include "TemperatureCalibration.h"
 
 MainMenu::MainMenu(TankControllerLib *tc) : UIState(tc) {
-  viewMenus[VIEW_GOOGLE_MINS] = String("View Google mins");
-  viewMenus[VIEW_ADDRESS] = String("View IP and MAC ");
-  viewMenus[VIEW_LOG_FILE] = String("View log file   ");
-  viewMenus[VIEW_PID] = String("View PID        ");
-  viewMenus[VIEW_PH_SLOPE] = String("View pH slope   ");
-  viewMenus[VIEW_TANK_ID] = String("View tank ID    ");
-  viewMenus[VIEW_TIME] = String("View time       ");
-  viewMenus[VIEW_VERSION] = String("View version    ");
+  viewMenus[VIEW_GOOGLE_MINS] = "View Google mins";
+  viewMenus[VIEW_ADDRESS] = "View IP and MAC";
+  viewMenus[VIEW_FREE_MEMORY] = "View free memory";
+  viewMenus[VIEW_LOG_FILE] = "View log file";
+  viewMenus[VIEW_PID] = "View PID";
+  viewMenus[VIEW_PH_SLOPE] = "View pH slope";
+  viewMenus[VIEW_TANK_ID] = "View tank ID";
+  viewMenus[VIEW_TIME] = "View time";
+  viewMenus[VIEW_VERSION] = "View version";
 
-  setMenus[SET_CALIBRATION] = String("pH calibration ");
-  setMenus[SET_CALIBRATION_CLEAR] = String("Clear pH calibra");
-  setMenus[SET_CHILL_OR_HEAT] = String("Set chill/heat  ");
-  setMenus[SET_GOOGLE_MINS] = String("Set Google mins ");
-  setMenus[SET_PH] = String("Set pH target   ");
-  setMenus[SET_KD] = String("Set KD          ");
-  setMenus[SET_KI] = String("Set KI          ");
-  setMenus[SET_KP] = String("Set KP          ");
-  setMenus[SET_PID_ON_OFF] = String("PID on/off      ");
-  setMenus[SET_TANK_ID] = String("Set Tank ID     ");
-  setMenus[SET_TEMP_CALIBRATION] = String("Temp calibration");
-  setMenus[SET_TEMPERATURE] = String("Set temperature ");
-  setMenus[SET_TIME] = String("Set date/time   ");
+  setMenus[SET_CALIBRATION] = "pH calibration";
+  setMenus[SET_CALIBRATION_CLEAR] = "Clear pH calibra";
+  setMenus[SET_CHILL_OR_HEAT] = "Set chill/heat";
+  setMenus[SET_GOOGLE_MINS] = "Set Google mins";
+  setMenus[SET_PH] = "Set pH target";
+  setMenus[SET_KD] = "Set KD";
+  setMenus[SET_KI] = "Set KI";
+  setMenus[SET_KP] = "Set KP";
+  setMenus[SET_PID_ON_OFF] = "PID on/off";
+  setMenus[SET_TANK_ID] = "Set Tank ID";
+  setMenus[SET_TEMP_CALIBRATION] = "Temp calibration";
+  setMenus[SET_TEMPERATURE] = "Set temperature";
+  setMenus[SET_TIME] = "Set date/time";
 }
 
 /**
@@ -140,6 +142,9 @@ void MainMenu::selectView() {
     case VIEW_ADDRESS:
       this->setNextState(static_cast<UIState *>(new SeeDeviceAddress(tc)));
       break;
+    case VIEW_FREE_MEMORY:
+      this->setNextState(static_cast<UIState *>(new SeeFreeMemory(tc)));
+      break;
     case VIEW_LOG_FILE:
       this->setNextState(static_cast<UIState *>(new SeeLogFile(tc)));
       break;
@@ -236,13 +241,13 @@ void MainMenu::loop() {
       if (level2 == -1) {
         LiquidCrystal_TC::instance()->writeLine("View settings", 0);
       } else {
-        LiquidCrystal_TC::instance()->writeLine(viewMenus[level2].c_str(), 0);
+        LiquidCrystal_TC::instance()->writeLine(viewMenus[level2], 0);
       }
     } else {
       if (level2 == -1) {
         LiquidCrystal_TC::instance()->writeLine("Change settings ", 0);
       } else {
-        LiquidCrystal_TC::instance()->writeLine(setMenus[level2].c_str(), 0);
+        LiquidCrystal_TC::instance()->writeLine(setMenus[level2], 0);
       }
     }
     LiquidCrystal_TC::instance()->writeLine("<4   ^2  8v   6>", 1);
diff --git a/src/UIState/MainMenu.h b/src/UIState/MainMenu.h
@@ -21,6 +21,7 @@ class MainMenu : public UIState {
     VIEW_GOOGLE_MINS,
     VIEW_ADDRESS,
     VIEW_VERSION,
+    VIEW_FREE_MEMORY,
     VIEW_COMMAND_COUNT  // always last
   };
   enum SetCommands {
@@ -45,7 +46,7 @@ class MainMenu : public UIState {
     return "MainMenu";
   }
   const char* prompt() {
-    return "Main Menu       ";
+    return "Main Menu";
   };
   bool isMainMenu() {
     return true;
@@ -55,8 +56,8 @@ class MainMenu : public UIState {
 private:
   int16_t level1 = 0;
   int16_t level2 = -1;
-  String viewMenus[VIEW_COMMAND_COUNT];
-  String setMenus[SET_COMMAND_COUNT];
+  const char* viewMenus[VIEW_COMMAND_COUNT];
+  const char* setMenus[SET_COMMAND_COUNT];
   void left();
   void right();
   void up();
diff --git a/src/UIState/PHCalibrationHigh.h b/src/UIState/PHCalibrationHigh.h
@@ -14,7 +14,7 @@ class PHCalibrationHigh : public PHCalibration {
     return "PHCalibrationHigh";
   }
   const char* prompt() {
-    return "pH-Highpoint    ";
+    return "pH-Highpoint";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/PHCalibrationLow.h b/src/UIState/PHCalibrationLow.h
@@ -14,7 +14,7 @@ class PHCalibrationLow : public PHCalibration {
     return "PHCalibrationLow";
   }
   const char* prompt() {
-    return "pH-Lowpoint     ";
+    return "pH-Lowpoint";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/PHCalibrationMid.h b/src/UIState/PHCalibrationMid.h
@@ -14,7 +14,7 @@ class PHCalibrationMid : public PHCalibration {
     return "PHCalibrationMid";
   }
   const char* prompt() {
-    return "pH-Midpoint     ";
+    return "pH-Midpoint";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/ResetLCDScreen.h b/src/UIState/ResetLCDScreen.h
@@ -15,6 +15,6 @@ class ResetLCDScreen : public UIState {
     return "ResetLCDScreen";
   }
   const char* prompt() {
-    return "Clearing Screen ";
+    return "Clearing Screen";
   };
 };
diff --git a/src/UIState/SeeDeviceAddress.h b/src/UIState/SeeDeviceAddress.h
@@ -16,6 +16,6 @@ class SeeDeviceAddress : public UIState {
     return "SeeDeviceAddress";
   }
   const char* prompt() {
-    return "Device address  ";
+    return "Device address";
   };
 };
diff --git a/src/UIState/SeeFreeMemory.cpp b/src/UIState/SeeFreeMemory.cpp
@@ -0,0 +1,11 @@
+#include "SeeFreeMemory.h"
+
+#include "Devices/LiquidCrystal_TC.h"
+#include "TankControllerLib.h"
+
+void SeeFreeMemory::start() {
+  LiquidCrystal_TC::instance()->writeLine(prompt(), 0);
+  char buffer[17];
+  snprintf(buffer, sizeof(buffer), "%i bytes", TankControllerLib::instance()->freeMemory());
+  LiquidCrystal_TC::instance()->writeLine(buffer, 1);
+}
diff --git a/src/UIState/SeeFreeMemory.h b/src/UIState/SeeFreeMemory.h
@@ -0,0 +1,15 @@
+#pragma once
+#include "UIState.h"
+
+class SeeFreeMemory : public UIState {
+public:
+  SeeFreeMemory(TankControllerLib* tc) : UIState(tc) {
+  }
+  void start();
+  const char* name() {
+    return "SeeFreeMemory";
+  }
+  const char* prompt() {
+    return "Free Memory:";
+  };
+};
diff --git a/src/UIState/SeeGoogleMins.h b/src/UIState/SeeGoogleMins.h
@@ -15,6 +15,6 @@ class SeeGoogleMins : public UIState {
     return "SeeGoogleMins";
   }
   const char* prompt() {
-    return "Google Mins:    ";
+    return "Google Mins:";
   };
 };
diff --git a/src/UIState/SeePHSlope.h b/src/UIState/SeePHSlope.h
@@ -16,6 +16,6 @@ class SeePHSlope : public UIState {
     return "SeePHSlope";
   }
   const char* prompt() {
-    return "PH Slope:       ";
+    return "PH Slope:";
   };
 };
diff --git a/src/UIState/SeeTankID.h b/src/UIState/SeeTankID.h
@@ -15,6 +15,6 @@ class SeeTankID : public UIState {
     return "SeeTankID";
   }
   const char* prompt() {
-    return "Tank ID:        ";
+    return "Tank ID:";
   };
 };
diff --git a/src/UIState/SetChillOrHeat.h b/src/UIState/SetChillOrHeat.h
@@ -18,7 +18,7 @@ class SetChillOrHeat : public NumCollectorState {
   }
   float getCurrentValue();
   const char* prompt() {
-    return "1:Chill; 9:Heat ";
+    return "1:Chill; 9:Heat";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/SetGoogleSheetInterval.h b/src/UIState/SetGoogleSheetInterval.h
@@ -21,7 +21,7 @@ class SetGoogleSheetInterval : public NumCollectorState {
     return EEPROM_TC::instance()->getGoogleSheetInterval();
   }
   const char* prompt() {
-    return "G Sheet Minutes ";
+    return "G Sheet Minutes";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/SetKD.h b/src/UIState/SetKD.h
@@ -21,7 +21,7 @@ class SetKD : public NumCollectorState {
     return 1;
   }
   const char* prompt() {
-    return "Set KD          ";
+    return "Set KD";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/SetKI.h b/src/UIState/SetKI.h
@@ -21,7 +21,7 @@ class SetKI : public NumCollectorState {
     return 1;
   }
   const char* prompt() {
-    return "Set KI          ";
+    return "Set KI";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/SetKP.h b/src/UIState/SetKP.h
@@ -21,7 +21,7 @@ class SetKP : public NumCollectorState {
     return 1;
   }
   const char* prompt() {
-    return "Set KP          ";
+    return "Set KP";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/SetTankID.h b/src/UIState/SetTankID.h
@@ -21,7 +21,7 @@ class SetTankID : public NumCollectorState {
     return EEPROM_TC::instance()->getTankID();
   }
   const char* prompt() {
-    return "Set Tank ID#    ";
+    return "Set Tank ID#";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/SetTempSetPoint.h b/src/UIState/SetTempSetPoint.h
@@ -21,7 +21,7 @@ class SetTempSetPoint : public NumCollectorState {
     return 2;
   }
   const char* prompt() {
-    return "Set Temperature ";
+    return "Set Temperature";
   };
   void setValue(float value);
 };
diff --git a/src/UIState/UIState.h b/src/UIState/UIState.h
@@ -30,7 +30,7 @@ class UIState {
   }
   virtual const char* name() = 0;
   virtual const char* prompt() {
-    return "                ";
+    return "";
   }
   virtual void start();
 
diff --git a/test/LiquidCrystalTest.cpp b/test/LiquidCrystalTest.cpp
@@ -19,7 +19,10 @@ unittest(loop) {
   assertEqual(16, lines.at(0).length());
   assertEqual(16, lines.at(1).length());
   assertEqual("Tank Controller ", lines.at(0));
-  assertEqual("v21.07.1 loading", lines.at(1));
+  assertEqual(
+      "v"
+      "21.07.2 loading",  // this allows a word-search to find the number
+      lines.at(1));
 }
 
 unittest(writeLine) {
diff --git a/test/SeeFreeMemoryTest.cpp b/test/SeeFreeMemoryTest.cpp
@@ -0,0 +1,28 @@
+#include <Arduino.h>
+#include <ArduinoUnitTests.h>
+
+#include "EEPROM_TC.h"
+#include "Keypad_TC.h"
+#include "LiquidCrystal_TC.h"
+#include "SeeFreeMemory.h"
+#include "TankControllerLib.h"
+
+unittest(testOutput) {
+  // Set up
+  TankControllerLib* tc = TankControllerLib::instance();
+  LiquidCrystal_TC* display = LiquidCrystal_TC::instance();
+  assertEqual("MainMenu", tc->stateName());
+  SeeFreeMemory* test = new SeeFreeMemory(tc);
+  tc->setNextState(test, true);
+  assertEqual("SeeFreeMemory", tc->stateName());
+
+  // Test the output
+  assertEqual("Free Memory:    ", display->getLines().at(0));
+  assertEqual("16 bytes        ", display->getLines().at(1));
+  // Return to mainMenu
+  Keypad_TC::instance()->_getPuppet()->push_back('D');
+  tc->loop();
+  assertEqual("MainMenu", tc->stateName());
+}
+
+unittest_main()
diff --git a/test/SeeVersionTest.cpp b/test/SeeVersionTest.cpp

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ class EthernetServer_TC : public EthernetServer {`
`17`	`17`	`// class methods`
`18`	`18`	`static EthernetServer_TC* instance();`
`19`	`19`	`// instance methods`
`20`		`- virtual String className() const {`
	`20`	`+ const char* className() const {`
`21`	`21`	`return "EthernetServer_TC";`
`22`	`22`	`}`
`23`	`23`	`void handleRequest();`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,6 @@ class CalibrationManagement : public UIState {`
`15`	`15`	`return "CalibrationManagement";`
`16`	`16`	`}`
`17`	`17`	`const char* prompt() {`
`18`		`- return "Cal Management ";`
	`18`	`+ return "Cal Management";`
`19`	`19`	`};`
`20`	`20`	`};`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class EnablePID : public NumCollectorState {`
`18`	`18`	`}`
`19`	`19`	`float getCurrentValue();`
`20`	`20`	`const char* prompt() {`
`21`		`- return "PID 1:on; 9:off ";`
	`21`	`+ return "PID 1:on; 9:off";`
`22`	`22`	`};`
`23`	`23`	`void setValue(float value);`
`24`	`24`	`};`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class PHCalibrationHigh : public PHCalibration {`
`14`	`14`	`return "PHCalibrationHigh";`
`15`	`15`	`}`
`16`	`16`	`const char* prompt() {`
`17`		`- return "pH-Highpoint ";`
	`17`	`+ return "pH-Highpoint";`
`18`	`18`	`};`
`19`	`19`	`void setValue(float value);`
`20`	`20`	`};`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class PHCalibrationLow : public PHCalibration {`
`14`	`14`	`return "PHCalibrationLow";`
`15`	`15`	`}`
`16`	`16`	`const char* prompt() {`
`17`		`- return "pH-Lowpoint ";`
	`17`	`+ return "pH-Lowpoint";`
`18`	`18`	`};`
`19`	`19`	`void setValue(float value);`
`20`	`20`	`};`