Adding resetOnZeroDeviceCount

Author: PaulZC

Firmware/OpenLog_Artemis/OpenLog_Artemis.ino

@@ -379,7 +379,13 @@ void setup() {
     beginQwiicDevices(); //Begin() each device in the node list
     loadDeviceSettingsFromFile(); //Load config settings into node list
     configureQwiicDevices(); //Apply config settings to each device in the node list
-    printOnlineDevice();
+    int deviceCount = printOnlineDevice();
+    if ((deviceCount == 0) && (settings.resetOnZeroDeviceCount == true))
+    {
+      SerialPrintln(F("*** Zero Qwiic Devices Found! Resetting... ***"));
+      SerialFlush();
+      resetArtemis(); //Thank you and goodnight...
+    }
   }
   else
     SerialPrintln(F("No Qwiic devices detected"));
@@ -766,7 +772,7 @@ void beginSD()
 
     if (sd.begin(PIN_MICROSD_CHIP_SELECT, SD_SCK_MHZ(24)) == false) //Standard SdFat
     {
-      printDebug("SD init failed (first attempt). Trying again...\r\n");
+      printDebug(F("SD init failed (first attempt). Trying again...\r\n"));
       for (int i = 0; i < 250; i++) //Give SD more time to power up, then try again
       {
         checkBattery();
@@ -810,7 +816,7 @@ void enableCIPOpullUp()
   cipoPinCfg.ePullup = AM_HAL_GPIO_PIN_PULLUP_1_5K;
   padMode(MISO, cipoPinCfg, &retval);
   if (retval != AP3_OK)
-    printDebug("Setting CIPO padMode failed!");
+    printDebug(F("Setting CIPO padMode failed!"));
 }
 
 void beginIMU()

Firmware/OpenLog_Artemis/autoDetect.ino

@@ -401,9 +401,10 @@ bool beginQwiicDevices()
           // Delay before starting the second and subsequent SCD30s to try and stagger the measurements and the peak current draw
           if (numberOfSCD30s >= 2)
           {
-            printDebug("beginQwiicDevices: found more than one SCD30. Delaying for 375ms to stagger the peak current draw...\r\n");
+            printDebug(F("beginQwiicDevices: found more than one SCD30. Delaying for 375ms to stagger the peak current draw...\r\n"));
             delay(375);
           }
+          if(settings.printDebugMessages == true) tempDevice->enableDebugging(); // Enable debug messages if required
           temp->online = tempDevice->begin(qwiic); //Wire port
         }
         break;
@@ -475,11 +476,11 @@ bool beginQwiicDevices()
 
     if (temp->online == true)
     {
-      printDebug("beginQwiicDevices: device is online\r\n");
+      printDebug(F("beginQwiicDevices: device is online\r\n"));
     }
     else
     {
-      printDebug("beginQwiicDevices: device is **NOT** online\r\n");
+      printDebug(F("beginQwiicDevices: device is **NOT** online\r\n"));
       everythingStarted = false;
     }
 
@@ -490,7 +491,7 @@ bool beginQwiicDevices()
 }
 
 //Pretty print all the online devices
-void printOnlineDevice()
+int printOnlineDevice()
 {
   int deviceCount = 0;
 
@@ -500,7 +501,7 @@ void printOnlineDevice()
   if (temp == NULL)
   {
     printDebug(F("printOnlineDevice: No devices detected\r\n"));
-    return;
+    return (0);
   }
 
   while (temp != NULL)
@@ -528,6 +529,8 @@ void printOnlineDevice()
   {
     SerialPrintf2("Device count: %d\r\n", deviceCount);
   }
+
+  return (deviceCount);
 }
 
 //Given the node number, apply the node's configuration settings to the device
@@ -1135,7 +1138,7 @@ deviceType_e testDevice(uint8_t i2cAddress, uint8_t muxAddress, uint8_t portNumb
 
         //Confidence: High - begin now checks FW Ver CRC
         SCD30 sensor1;
-        //sensor1.enableDebugging();
+        if(settings.printDebugMessages == true) sensor1.enableDebugging(); // Enable debug messages if required
         // Set measBegin to false. beginQwiicDevices will call begin with measBegin set true.
         if (sensor1.begin(qwiic, true, false) == true) //Wire port, autoCalibrate, measBegin
           return (DEVICE_CO2_SCD30);

Firmware/OpenLog_Artemis/lowerPower.ino

@@ -153,6 +153,77 @@ void powerDown()
   }
 }
 
+//Reset the Artemis
+void resetArtemis(void)
+{
+  //Save files before resetting
+  if (online.dataLogging == true)
+  {
+    sensorDataFile.sync();
+    updateDataFileAccess(&sensorDataFile); // Update the file access time & date
+    sensorDataFile.close(); //No need to close files. https://forum.arduino.cc/index.php?topic=149504.msg1125098#msg1125098
+  }
+  if (online.serialLogging == true)
+  {
+    serialDataFile.sync();
+    updateDataFileAccess(&serialDataFile); // Update the file access time & date
+    serialDataFile.close();
+  }
+
+  delay(sdPowerDownDelay); // Give the SD card time to finish writing ***** THIS IS CRITICAL *****
+
+  SerialFlush(); //Finish any prints
+
+  //  Wire.end(); //Power down I2C
+  qwiic.end(); //Power down I2C
+
+  SPI.end(); //Power down SPI
+
+  power_adc_disable(); //Power down ADC. It it started by default before setup().
+
+  Serial.end(); //Power down UART
+  SerialLog.end();
+
+  //Force the peripherals off
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_IOM0);
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_IOM1);
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_IOM2);
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_IOM3);
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_IOM4);
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_IOM5);
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_ADC);
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_UART0);
+  am_hal_pwrctrl_periph_disable(AM_HAL_PWRCTRL_PERIPH_UART1);
+
+  //Disable pads
+  for (int x = 0; x < 50; x++)
+  {
+    if ((x != ap3_gpio_pin2pad(PIN_POWER_LOSS)) &&
+        //(x != ap3_gpio_pin2pad(PIN_LOGIC_DEBUG)) &&
+        (x != ap3_gpio_pin2pad(PIN_MICROSD_POWER)) &&
+        (x != ap3_gpio_pin2pad(PIN_QWIIC_POWER)) &&
+        (x != ap3_gpio_pin2pad(PIN_IMU_POWER)))
+    {
+      am_hal_gpio_pinconfig(x, g_AM_HAL_GPIO_DISABLE);
+    }
+  }
+
+  //We can't leave these power control pins floating
+  imuPowerOff();
+  microSDPowerOff();
+
+  //Disable power for the Qwiic bus
+  qwiicPowerOff();
+
+  //Disable the power LED
+  powerLEDOff();
+
+  //Enable the Watchdog so it can reset the Artemis
+  startWatchdog();
+  while (1) // That's all folks! Artemis will reset in 1.25 seconds
+    ;
+}
+
 //Power everything down and wait for interrupt wakeup
 void goToSleep(uint32_t sysTicksToSleep)
 {
@@ -360,11 +431,11 @@ void wakeFromSleep()
     SerialLog.begin(settings.serialTerminalBaudRate); // Start the serial port
   }
 
-  printDebug("wakeFromSleep: I'm awake!\r\n");
+  printDebug(F("wakeFromSleep: I'm awake!\r\n"));
   printDebug("wakeFromSleep: adcError is " + (String)adcError + ".");
   if (adcError > 0)
-    printDebug(" This indicates an error was returned by ap3_adc_setup or one of the calls to ap3_set_pin_to_analog.");
-  printDebug("\r\n");
+    printDebug(F(" This indicates an error was returned by ap3_adc_setup or one of the calls to ap3_set_pin_to_analog."));
+  printDebug(F("\r\n"));
 
   beginQwiic(); //Power up Qwiic bus as early as possible
 
@@ -560,3 +631,46 @@ int calculateDayOfYear(int day, int month, int year)
   doy += day;
   return doy;
 }
+
+//WatchDog Timer code by Adam Garbo:
+//https://forum.sparkfun.com/viewtopic.php?f=169&t=52431&p=213296#p213296
+
+// Watchdog timer configuration structure.
+am_hal_wdt_config_t g_sWatchdogConfig = {
+
+  // Configuration values for generated watchdog timer event.
+  .ui32Config = AM_HAL_WDT_LFRC_CLK_16HZ | AM_HAL_WDT_ENABLE_RESET | AM_HAL_WDT_ENABLE_INTERRUPT,
+
+  // Number of watchdog timer ticks allowed before a watchdog interrupt event is generated.
+  .ui16InterruptCount = 16, // Set WDT interrupt timeout for 1 second.
+
+  // Number of watchdog timer ticks allowed before the watchdog will issue a system reset.
+  .ui16ResetCount = 20 // Set WDT reset timeout for 1.25 seconds.
+};
+
+void startWatchdog()
+{
+  // LFRC must be turned on for this example as the watchdog only runs off of the LFRC.
+  am_hal_clkgen_control(AM_HAL_CLKGEN_CONTROL_LFRC_START, 0);
+
+  // Configure the watchdog.
+  am_hal_wdt_init(&g_sWatchdogConfig);
+
+  // Enable the interrupt for the watchdog in the NVIC.
+  NVIC_EnableIRQ(WDT_IRQn);
+  //NVIC_SetPriority(WDT_IRQn, 0); // Set the interrupt priority to 0 = highest (255 = lowest)
+  //am_hal_interrupt_master_enable(); // ap3_initialization.cpp does this - no need to do it here
+
+  // Enable the watchdog.
+  am_hal_wdt_start();
+}
+
+// Interrupt handler for the watchdog.
+extern "C++" void am_watchdog_isr(void)
+{
+  // Clear the watchdog interrupt.
+  am_hal_wdt_int_clear();
+
+  // DON'T Restart the watchdog.
+  //am_hal_wdt_restart(); // "Pet" the dog.
+}

Firmware/OpenLog_Artemis/menuAttachedDevices.ino

@@ -30,7 +30,7 @@
 //Returns true if devices detected > 0
 bool detectQwiicDevices()
 {
-  printDebug("detectQwiicDevices started\r\n");
+  printDebug(F("detectQwiicDevices started\r\n"));
   bool somethingDetected = false;
 
   qwiic.setClock(100000); //During detection, go slow
@@ -154,7 +154,7 @@ bool detectQwiicDevices()
       QWIICMUX *myMux = (QWIICMUX *)muxNode->classPtr;
 
       printDebug("detectQwiicDevices: scanning the ports of multiplexer " + (String)muxNumber);
-      printDebug("\r\n");
+      printDebug(F("\r\n"));
 
       for (int portNumber = 0 ; portNumber < 8 ; portNumber++) //Assumes we are using a mux with 8 ports max
       {
@@ -163,7 +163,7 @@ bool detectQwiicDevices()
 
         printDebug("detectQwiicDevices: scanning port number " + (String)portNumber);
         printDebug(" on multiplexer " + (String)muxNumber);
-        printDebug("\r\n");
+        printDebug(F("\r\n"));
 
         //Scan this new bus for new addresses
         for (uint8_t address = 1 ; address < 127 ; address++)

Firmware/OpenLog_Artemis/menuDebug.ino

@@ -9,6 +9,10 @@ void menuDebug()
     if (settings.printDebugMessages == true) SerialPrintln(F("Enabled"));
     else SerialPrintln(F("Disabled"));
 
+    SerialPrint(F("2) Reset on Zero Device Count: "));
+    if (settings.resetOnZeroDeviceCount == true) SerialPrintln(F("Enabled"));
+    else SerialPrintln(F("Disabled"));
+
     SerialPrintln(F("x) Exit"));
 
     byte incoming = getByteChoice(menuTimeout); //Timeout after x seconds
@@ -17,6 +21,27 @@ void menuDebug()
     {
       settings.printDebugMessages ^= 1;
     }
+    else if (incoming == '2')
+    {
+      if (settings.resetOnZeroDeviceCount == false)
+      {
+        SerialPrintln(F(""));
+        SerialPrintln(F("Enabling resetOnZeroDeviceCount will cause the OLA to completely reset if no devices are found on the Qwiic bus."));
+        SerialPrintln(F("Do not enable this option if you are only logging IMU or Serial data."));
+        SerialPrintln(F("Are you sure? Press 'y' to confirm: "));
+        byte bContinue = getByteChoice(menuTimeout);
+        if (bContinue == 'y')
+        {
+          settings.resetOnZeroDeviceCount ^= 1;
+        }
+        else
+          SerialPrintln(F("\"resetOnZeroDeviceCount\"  aborted"));
+      }
+      else
+      {
+        settings.resetOnZeroDeviceCount ^= 1;
+      }
+    }
     else if (incoming == 'x')
       break;
     else if (incoming == STATUS_GETBYTE_TIMEOUT)

Firmware/OpenLog_Artemis/menuMain.ino

@@ -97,7 +97,7 @@ void menuMain()
     }
     else if (incoming == 'r')
     {
-      SerialPrintln(F("\r\nResetting to factory defaults. Press 'y' to confirm:"));
+      SerialPrintln(F("\r\nResetting to factory defaults. Press 'y' to confirm: "));
       byte bContinue = getByteChoice(menuTimeout);
       if (bContinue == 'y')
       {

Firmware/OpenLog_Artemis/menuTerminal.ino

@@ -288,11 +288,10 @@ void menuLogRate()
       if (settings.useTxRxPinsForTerminal == false)
       {
         SerialPrintln(F(""));
-        SerialPrintln(F("WARNING:"));
         SerialPrintln(F("\"Use TX and RX pins for terminal\" can only be disabled by \"Reset all settings to default\"."));
         SerialPrintln(F("Analog logging on TX/A12 and RX/A13 will be disabled."));
         SerialPrintln(F("Serial logging will be disabled."));
-        SerialPrintln(F("Are you sure? Press 'y' to confirm:"));
+        SerialPrintln(F("Are you sure? Press 'y' to confirm: "));
         byte bContinue = getByteChoice(menuTimeout);
         if (bContinue == 'y')
         {

Firmware/OpenLog_Artemis/nvm.ino

@@ -98,9 +98,9 @@ void recordSystemSettingsToFile()
 
     settingsFile.println("usBetweenReadings=" + (String)tempTime);
 
-    //printDebug("Saving usBetweenReadings to SD card: ");
+    //printDebug(F("Saving usBetweenReadings to SD card: "));
     //printDebug((String)tempTime);
-    //printDebug("\r\n");
+    //printDebug(F("\r\n"));
 
     settingsFile.println("logMaxRate=" + (String)settings.logMaxRate);
     settingsFile.println("enableRTC=" + (String)settings.enableRTC);
@@ -163,6 +163,7 @@ void recordSystemSettingsToFile()
     settingsFile.println("slowLoggingIntervalSeconds=" + (String)settings.slowLoggingIntervalSeconds);
     settingsFile.println("slowLoggingStartMOD=" + (String)settings.slowLoggingStartMOD);
     settingsFile.println("slowLoggingStopMOD=" + (String)settings.slowLoggingStopMOD);
+    settingsFile.println("resetOnZeroDeviceCount=" + (String)settings.resetOnZeroDeviceCount);
     updateDataFileAccess(&settingsFile); // Update the file access time & date
     settingsFile.close();
   }
@@ -295,9 +296,9 @@ bool parseLine(char* str) {
   else if (strcmp(settingName, "usBetweenReadings") == 0)
   {
     settings.usBetweenReadings = d;
-    //printDebug("Read usBetweenReadings from SD card: ");
+    //printDebug(F("Read usBetweenReadings from SD card: "));
     //printDebug(String(d));
-    //printDebug("\r\n");
+    //printDebug(F("\r\n"));
   }
   else if (strcmp(settingName, "logMaxRate") == 0)
     settings.logMaxRate = d;
@@ -421,6 +422,8 @@ bool parseLine(char* str) {
     settings.slowLoggingStartMOD = d;
   else if (strcmp(settingName, "slowLoggingStopMOD") == 0)
     settings.slowLoggingStopMOD = d;
+  else if (strcmp(settingName, "resetOnZeroDeviceCount") == 0)
+    settings.resetOnZeroDeviceCount = d;
   else
     {
       SerialPrintf2("Unknown setting %s. Ignoring...\r\n", settingName);

Firmware/OpenLog_Artemis/settings.h

@@ -359,7 +359,7 @@ struct struct_settings {
   int slowLoggingIntervalSeconds = 300; // Slow logging interval in seconds. Default to 5 mins
   int slowLoggingStartMOD = 1260; // Start slow logging at this many Minutes Of Day. Default to 21:00
   int slowLoggingStopMOD = 420; // Stop slow logging at this many Minutes Of Day. Default to 07:00
-
+  bool resetOnZeroDeviceCount = false; // A work-around for I2C bus crashes. Enable this via the debug menu.
 } settings;
 
 //These are the devices on board OpenLog that may be on or offline.