Add settings.openMenuWithPrintable - accessible from the "d" debug menu

Author: PaulZC

Firmware/OpenLog_Artemis/OpenLog_Artemis.ino

@@ -135,12 +135,16 @@
     
   v2.3:
     Resolve https://forum.sparkfun.com/viewtopic.php?f=171&t=58109
-    
+
+  v2.4:
+    Add noPowerLossProtection to the main branch
+    Add changes by KDB: If we are streaming to Serial, start the stream with a Mime Type marker, followed by CR
+    Add debug option to only open the menu using a printable character: based on https://github.com/sparkfun/OpenLog_Artemis/pull/125
     
 */
 
 const int FIRMWARE_VERSION_MAJOR = 2;
-const int FIRMWARE_VERSION_MINOR = 3;
+const int FIRMWARE_VERSION_MINOR = 4;
 
 //Define the OLA board identifier:
 //  This is an int which is unique to this variant of the OLA and which allows us
@@ -150,7 +154,7 @@ const int FIRMWARE_VERSION_MINOR = 3;
 //    the variant * 0x100 (OLA = 1; GNSS_LOGGER = 2; GEOPHONE_LOGGER = 3)
 //    the major firmware version * 0x10
 //    the minor firmware version
-#define OLA_IDENTIFIER 0x123 // Stored as 291 decimal in OLA_settings.txt
+#define OLA_IDENTIFIER 0x124 // Stored as 292 decimal in OLA_settings.txt
 
 //#define noPowerLossProtection // Uncomment this line to disable the sleep-on-power-loss functionality
 
@@ -206,10 +210,6 @@ enum returnStatus {
   STATUS_PRESSED_X,
 };
 
-//Header
-void beginSD(bool silent = false);
-void beginIMU(bool silent = false);
-
 //Setup Qwiic Port
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 #include <Wire.h>
@@ -337,8 +337,6 @@ char serialTimestamp[40]; //Buffer to store serial timestamp, if needed
 volatile static bool powerLossSeen = false; //Flag to indicate if a power loss event has been seen
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
-uint8_t getByteChoice(int numberOfSeconds, bool updateDZSERIAL = false); // Header
-
 // gfvalvo's flash string helper code: https://forum.arduino.cc/index.php?topic=533118.msg3634809#msg3634809
 void SerialPrint(const char *);
 void SerialPrint(const __FlashStringHelper *);
@@ -566,7 +564,7 @@ void setup() {
   //If we are immediately going to go to sleep after the first reading then
   //first present the user with the config menu in case they need to change something
   if (checkIfItIsTimeToSleep())
-    menuMain();
+    menuMain(true); // Always open the menu - even if there is nothing in the serial buffers
 }
 
 void loop() {

Firmware/OpenLog_Artemis/Sensors.h

@@ -9,4 +9,7 @@
 
 void printHelperText(uint8_t);
 void getData(char *buffer, size_t lenBuffer);
-
+uint8_t getByteChoice(int numberOfSeconds, bool updateDZSERIAL = false);
+void menuMain(bool alwaysOpen = false);
+void beginSD(bool silent = false);
+void beginIMU(bool silent = false);

Firmware/OpenLog_Artemis/menuDebug.ino

@@ -17,6 +17,10 @@ void menuDebug()
     if (settings.printGNSSDebugMessages == true) SerialPrintln(F("Enabled"));
     else SerialPrintln(F("Disabled"));
 
+    SerialPrint(F("4) Only Open Main Menu With Printable Char: "));
+    if (settings.openMenuWithPrintable == true) SerialPrintln(F("Yes"));
+    else SerialPrintln(F("No"));
+
     SerialPrintln(F("x) Exit"));
 
     byte incoming = getByteChoice(menuTimeout); //Timeout after x seconds
@@ -46,10 +50,14 @@ void menuDebug()
         settings.resetOnZeroDeviceCount ^= 1;
       }
     }
-   else if (incoming == '3')
+    else if (incoming == '3')
     {
       settings.printGNSSDebugMessages ^= 1;
     }
+    else if (incoming == '4')
+    {
+      settings.openMenuWithPrintable ^= 1;
+    }
     else if (incoming == 'x')
       break;
     else if (incoming == STATUS_GETBYTE_TIMEOUT)

Firmware/OpenLog_Artemis/menuMain.ino

@@ -4,9 +4,28 @@
 
 //Display the options
 //If user doesn't respond within a few seconds, return to main loop
-void menuMain()
+void menuMain(bool alwaysOpen)
 {
   bool restartIMU = false;
+
+  if (settings.openMenuWithPrintable) // If settings.openMenuWithPrintable is true, eat the first character. Return if < 9 (Tab)
+  {
+    if ((settings.useTxRxPinsForTerminal == true) && (Serial1.available()))
+    {
+      uint8_t firstChar = Serial1.read();
+      if (firstChar < 9)
+        return;
+    }
+    else if (Serial.available())
+    {
+      uint8_t firstChar = Serial.read();
+      if (firstChar < 9)
+        return;
+    }
+    else if (!alwaysOpen)
+      return;
+  }
+  
   while (1)
   {
     SerialPrintln(F(""));

Firmware/OpenLog_Artemis/nvm.ino

@@ -181,6 +181,7 @@ void recordSystemSettingsToFile()
     settingsFile.println("identifyBioSensorHubs=" + (String)settings.identifyBioSensorHubs);
     settingsFile.println("serialTxRxDuringSleep=" + (String)settings.serialTxRxDuringSleep);
     settingsFile.println("printGNSSDebugMessages=" + (String)settings.printGNSSDebugMessages);
+    settingsFile.println("openMenuWithPrintable=" + (String)settings.openMenuWithPrintable);
     updateDataFileAccess(&settingsFile); // Update the file access time & date
     settingsFile.close();
   }
@@ -464,6 +465,8 @@ bool parseLine(char* str) {
     settings.serialTxRxDuringSleep = d;
   else if (strcmp(settingName, "printGNSSDebugMessages") == 0)
     settings.printGNSSDebugMessages = d;
+  else if (strcmp(settingName, "openMenuWithPrintable") == 0)
+    settings.openMenuWithPrintable = d;
   else
     {
       SerialPrintf2("Unknown setting %s. Ignoring...\r\n", settingName);

Firmware/OpenLog_Artemis/settings.h

@@ -423,7 +423,8 @@ struct struct_settings {
   unsigned long minimumAwakeTimeMillis = 0; // Set to greater than zero to keep the Artemis awake for this long between sleeps
   bool identifyBioSensorHubs = false; // If true, Bio Sensor Hubs (Pulse Oximeters) will be included in autoDetect (requires exclusive use of pins 32 and 11)
   bool serialTxRxDuringSleep = false; // If true, the Serial Tx and Rx pins are left enabled during sleep - to prevent the COM port reinitializing
-  bool printGNSSDebugMessages = false;
+  bool printGNSSDebugMessages = false; // If true, the GNSS library debug messages are enabled
+  bool openMenuWithPrintable = false; // If true, only a printable char can open the main menu. Chars < 9 (Tab) are ignored
 } settings;
 
 //These are the devices on board OpenLog that may be on or offline.

Firmware/OpenLog_Artemis/support.ino

@@ -1,3 +1,7 @@
+
+
+#include "Sensors.h"
+
 bool useRTCmillis(void)
 {
   return (((settings.useGPIO11ForTrigger == false) && (settings.usBetweenReadings >= maxUsBeforeSleep))