Add debug menu and option to print heap.

Author: nseidle

Firmware/RTK_Surveyor/RTK_Surveyor.ino

@@ -309,18 +309,14 @@ void loop()
 
   updateLogs(); //Record any new data. Create or close files as needed.
 
+  reportHeap(); //If debug enabled, report free heap
+
   //Menu system via ESP32 USB connection
   if (Serial.available()) menuMain(); //Present user menu
 
   //Convert current system time to minutes. This is used in F9PSerialReadTask()/updateLogs() to see if we are within max log window.
   systemTime_minutes = millis() / 1000L / 60;
 
-  if (millis() - lastHeapReport > 1000)
-  {
-    lastHeapReport = millis();
-    Serial.printf("freeHeap: %d\n\r", ESP.getFreeHeap());
-  }
-
   delay(10); //A small delay prevents panic if no other I2C or functions are called
 }
 

Firmware/RTK_Surveyor/System.ino

@@ -751,3 +751,16 @@ bool logUBXMessages()
     return (true);
   return (false);
 }
+
+//If debug option is on, print available heap
+void reportHeap()
+{
+  if (settings.enableHeapReport == true)
+  {
+    if (millis() - lastHeapReport > 1000)
+    {
+      lastHeapReport = millis();
+      Serial.printf("freeHeap: %d\n\r", ESP.getFreeHeap());
+    }
+  }
+}

Firmware/RTK_Surveyor/menuDebug.ino

@@ -0,0 +1,45 @@
+//Toggle control of heap reports and I2C GNSS debug
+void menuDebug()
+{
+  while (1)
+  {
+    Serial.println();
+    Serial.println(F("Menu: Debug Menu"));
+
+    Serial.print(F("1) Toggle I2C Debugging Output: "));
+    if (settings.enableI2Cdebug == true) Serial.println(F("Enabled"));
+    else Serial.println(F("Disabled"));
+
+    Serial.print(F("2) Toggle Heap Reporting: "));
+    if (settings.enableHeapReport == true) Serial.println(F("Enabled"));
+    else Serial.println(F("Disabled"));
+
+    Serial.println(F("x) Exit"));
+
+    byte incoming = getByteChoice(30); //Timeout after x seconds
+
+    if (incoming == '1')
+    {
+      settings.enableI2Cdebug ^= 1;
+    
+      if(settings.enableI2Cdebug)
+        i2cGNSS.enableDebugging(Serial, true); //Enable only the critical debug messages over Serial
+      else
+        i2cGNSS.disableDebugging();
+    }
+    else if (incoming == '2')
+    {
+      settings.enableHeapReport ^= 1;
+    }
+    else if (incoming == 'x')
+      break;
+    else if (incoming == STATUS_GETBYTE_TIMEOUT)
+    {
+      break;
+    }
+    else
+      printUnknown(incoming);
+  }
+
+  while (Serial.available()) Serial.read(); //Empty buffer of any newline chars
+}

Firmware/RTK_Surveyor/menuGNSS.ino

@@ -20,10 +20,6 @@ void menuGNSS()
     if (getSBAS() == true) Serial.println(F("Enabled"));
     else Serial.println(F("Disabled"));
 
-    Serial.print(F("4) Toggle I2C Debugging Output: "));
-    if (settings.enableI2Cdebug == true) Serial.println(F("Enabled"));
-    else Serial.println(F("Disabled"));
-
     Serial.println(F("x) Exit"));
 
     int incoming = getNumber(30); //Timeout after x seconds
@@ -71,15 +67,6 @@ void menuGNSS()
           settings.enableSBAS = true;
       }
     }
-    else if (incoming == 4)
-    {
-      settings.enableI2Cdebug ^= 1;
-    
-      if(settings.enableI2Cdebug)
-        i2cGNSS.enableDebugging(Serial, true); //Enable only the critical debug messages over Serial
-      else
-        i2cGNSS.disableDebugging();
-    }
     else if (incoming == STATUS_PRESSED_X)
       break;
     else if (incoming == STATUS_GETNUMBER_TIMEOUT)

Firmware/RTK_Surveyor/menuMain.ino

@@ -25,6 +25,8 @@ void menuMain()
 
     Serial.println(F("5) Configure Ports"));
 
+    Serial.println(F("d) Configure Debug"));
+
     Serial.println(F("r) Reset all settings to default"));
 
     if(binCount > 0)
@@ -46,6 +48,8 @@ void menuMain()
       menuBase();
     else if (incoming == '5')
       menuPorts();
+    else if (incoming == 'd')
+      menuDebug();
     else if (incoming == 'r')
     {
       Serial.println(F("\r\nResetting to factory defaults. Press 'y' to confirm:"));

Firmware/RTK_Surveyor/nvm.ino

@@ -133,6 +133,7 @@ void recordSystemSettingsToFile()
       settingsFile.println("log.rawx=" + (String)settings.log.rawx);
       settingsFile.println("log.sfrbx=" + (String)settings.log.sfrbx);
       settingsFile.println("enableI2Cdebug=" + (String)settings.enableI2Cdebug);
+      settingsFile.println("enableHeapReport=" + (String)settings.enableHeapReport);
 
       if (online.gnss)
         updateDataFileAccess(&settingsFile); // Update the file access time & date
@@ -364,6 +365,8 @@ bool parseLine(char* str) {
     settings.log.sfrbx = d;
   else if (strcmp(settingName, "enableI2Cdebug") == 0)
     settings.enableI2Cdebug = d;
+  else if (strcmp(settingName, "enableHeapReport") == 0)
+    settings.enableHeapReport = d;
 
   else
     Serial.printf("Unknown setting %s on line: %s\r\n", settingName, str);

Firmware/RTK_Surveyor/settings.h

@@ -109,6 +109,7 @@ struct struct_settings {
   gnssMessages broadcast;
   gnssMessages log;
   bool enableI2Cdebug = false; //Turn on to display GNSS library debug messages
+  bool enableHeapReport = false; //Turn on to display free heap
 } settings;
 
 //These are the devices on board RTK Surveyor that may be on or offline.