Merge pull request #80 from sparkfun/release_candidate

Firmware version v1.10

Author: PaulZC

Binaries/OpenLog_Artemis-V10-v110.bin

@@ -1,6 +1,15 @@
 Change Log
 ======================
 
+v1.10
+---------
+
+* Improved support for the MS5837
+* Adds IMU DMP examples
+* Corrects support for the SDP31
+* Updates the low-power code as per [78](https://github.com/sparkfun/OpenLog_Artemis/issues/78)
+* Corrects wakeFromSleep when using the Tx pin for serial output [79](https://github.com/sparkfun/OpenLog_Artemis/issues/79)
+
 v1.9
 ---------
 

Binaries/OpenLog_Artemis-X04-v110.bin

@@ -86,10 +86,12 @@
   (done) Add support for the SGP40 VOC Index sensor
   (done) Add support for the SDP3X Differential Pressure sensor
   (done) Add support for the MS5837 - as used in the BlueRobotics BAR02 and BAR30 water pressure sensors
+  (done) Correct an issue which was causing the OLA to crash when waking from sleep and outputting serial data https://github.com/sparkfun/OpenLog_Artemis/issues/79
+  (done) Correct low-power code as per https://github.com/sparkfun/OpenLog_Artemis/issues/78
 */
 
 const int FIRMWARE_VERSION_MAJOR = 1;
-const int FIRMWARE_VERSION_MINOR = 9;
+const int FIRMWARE_VERSION_MINOR = 10;
 
 //Define the OLA board identifier:
 //  This is an int which is unique to this variant of the OLA and which allows us
@@ -99,7 +101,7 @@ const int FIRMWARE_VERSION_MINOR = 9;
 //    the variant * 0x100 (OLA = 1; GNSS_LOGGER = 2; GEOPHONE_LOGGER = 3)
 //    the major firmware version * 0x10
 //    the minor firmware version
-#define OLA_IDENTIFIER 0x119 // Stored as 281 decimal in OLA_settings.txt
+#define OLA_IDENTIFIER 0x11A // Stored as 282 decimal in OLA_settings.txt
 
 #include "settings.h"
 
@@ -853,6 +855,7 @@ void beginIMU()
       delay(1);
     }
 
+    if (settings.printDebugMessages) myICM.enableDebugging();
     myICM.begin(PIN_IMU_CHIP_SELECT, SPI, 4000000); //Set IMU SPI rate to 4MHz
     if (myICM.status != ICM_20948_Stat_Ok)
     {

CHANGELOG.md

@@ -795,8 +795,8 @@ void gatherDeviceValues()
               float temperature;
               if ((nodeSetting->logPressure) || (nodeSetting->logTemperature))
               {
-                nodeDevice->triggeredMeasurement(nodeSetting->massFlow, nodeSetting->clockStretching);
-                nodeDevice->readMeasurement(&pressure, &temperature);
+                // Each triggered measurement takes 45ms to complete so we need to use continuous measurements
+                nodeDevice->readMeasurement(&pressure, &temperature); // Read the latest measurement
               }
               if (nodeSetting->logPressure)
               {

Firmware/OpenLog_Artemis/OpenLog_Artemis.ino

@@ -501,6 +501,7 @@ bool beginQwiicDevices()
           SDP3X *tempDevice = (SDP3X *)temp->classPtr;
           struct_SDP3X *nodeSetting = (struct_SDP3X *)temp->configPtr; //Create a local pointer that points to same spot as node does
           if (nodeSetting->powerOnDelayMillis > qwiicPowerOnDelayMillis) qwiicPowerOnDelayMillis = nodeSetting->powerOnDelayMillis; // Increase qwiicPowerOnDelayMillis if required
+          tempDevice->stopContinuousMeasurement(temp->address, qwiic); //Make sure continuous measurements are stopped or .begin will fail
           if (tempDevice->begin(temp->address, qwiic) == true) //Address, Wire port. Returns true on success.
             temp->online = true;
         }
@@ -768,14 +769,21 @@ void configureDevice(node * temp)
       //Nothing to configure
       break;
     case DEVICE_PRESSURE_SDP3X:
-      //Nothing to configure
+      {
+        SDP3X *sensor = (SDP3X *)temp->classPtr;
+        struct_SDP3X *sensorSetting = (struct_SDP3X *)temp->configPtr;
+
+        // Each triggered measurement takes 45ms to complete so we need to use continuous measurements
+        sensor->stopContinuousMeasurement(); //Make sure continuous measurements are stopped or startContinuousMeasurement will fail
+        sensor->startContinuousMeasurement(sensorSetting->massFlow, sensorSetting->averaging); //Request continuous measurements
+      }
       break;
     case DEVICE_PRESSURE_MS5837:
       {
         MS5837 *sensor = (MS5837 *)temp->classPtr;
         struct_MS5837 *sensorSetting = (struct_MS5837 *)temp->configPtr;
 
-        //sensor->setModel(sensorSetting->model);
+        //sensor->setModel(sensorSetting->model); // We could override the sensor model, but let's not...
         sensorSetting->model = sensor->getModel();
         sensor->setFluidDensity(sensorSetting->fluidDensity);
       }
@@ -1056,24 +1064,27 @@ deviceType_e testDevice(uint8_t i2cAddress, uint8_t muxAddress, uint8_t portNumb
       break;
     case 0x21:
       {
-        //Confidence: Medium - .begin reads the product ID
+        //Confidence: High - .begin reads the product ID
         SDP3X sensor;
+        sensor.stopContinuousMeasurement(i2cAddress, qwiic); //Make sure continuous measurements are stopped or .begin will fail
         if (sensor.begin(i2cAddress, qwiic) == true) //Address, Wire port
           return (DEVICE_PRESSURE_SDP3X);
       }
       break;
     case 0x22:
       {
-        //Confidence: Medium - .begin reads the product ID
+        //Confidence: High - .begin reads the product ID
         SDP3X sensor;
+        sensor.stopContinuousMeasurement(i2cAddress, qwiic); //Make sure continuous measurements are stopped or .begin will fail
         if (sensor.begin(i2cAddress, qwiic) == true) //Address, Wire port
           return (DEVICE_PRESSURE_SDP3X);
       }
       break;
     case 0x23:
       {
-        //Confidence: Medium - .begin reads the product ID
+        //Confidence: High - .begin reads the product ID
         SDP3X sensor;
+        sensor.stopContinuousMeasurement(i2cAddress, qwiic); //Make sure continuous measurements are stopped or .begin will fail
         if (sensor.begin(i2cAddress, qwiic) == true) //Address, Wire port
           return (DEVICE_PRESSURE_SDP3X);
       }
@@ -1351,7 +1362,10 @@ deviceType_e testDevice(uint8_t i2cAddress, uint8_t muxAddress, uint8_t portNumb
         //Confidence: High - does CRC on internal EEPROM read and checks sensor version
         MS5837 sensor2;
         if (sensor2.begin(qwiic) == true) //Wire port
-          return (DEVICE_PRESSURE_MS5837);
+        {
+          if (sensor2.getModel() <= 1) // Check that getModel returns 0 or 1. It will (hopefully) return 255 if an MS5637 is attached.
+            return (DEVICE_PRESSURE_MS5837);          
+        }
 
         //Confidence: High - does CRC on internal EEPROM read - but do this second as a MS5837 will appear as a MS5637
         MS5637 sensor;
@@ -1427,12 +1441,12 @@ deviceType_e testMuxDevice(uint8_t i2cAddress, uint8_t muxAddress, uint8_t portN
         if (deviceExists(DEVICE_MULTIPLEXER, i2cAddress, muxAddress, portNumber) == true) return (DEVICE_MULTIPLEXER);
 
         // If an MS8607 is connected, multiplexerBegin causes the MS8607 to 'crash' and lock up the I2C bus... So we need to check if an MS8607 is connected first. 
-        // We will use the MS5637 as this will test for itself and the pressure sensor of the MS8607
+        // We will use the MS5637 as this will test for itself, the MS5837 and the pressure sensor of the MS8607
         // Just to make life even more complicated, a mux with address 0x76 will also appear as an MS5637 due to the way the MS5637 eeprom crc check is calculated.
-        // So, we can't use .begin as the test for a MS5637 / MS8607. We need to be more creative!
+        // So, we can't use .begin as the test for a MS5637 / MS5837 / MS8607. We need to be more creative!
         // If we write 0xA0 to i2cAddress and then read two bytes:
         //  A mux will return 0xA0A0
-        //  An MS5637 / MS8607 will return the value stored in its eeprom which _hopefully_ is not 0xA0A0!
+        //  An MS5637 / MS5837 / MS8607 will return the value stored in its eeprom which _hopefully_ is not 0xA0A0!
 
         // Let's hope this doesn't cause problems for the BME280...! We should be OK as the default address for the BME280 is 0x77.
 
@@ -1448,7 +1462,7 @@ deviceType_e testMuxDevice(uint8_t i2cAddress, uint8_t muxAddress, uint8_t portN
           {
             buffer[i] = qwiic.read();
           }
-          if ((buffer[0] != 0xA0) || (buffer[1] != 0xA0)) // If we read back something other than 0xA0A0 then we are probably talking to an MS5637 / MS8607, not a mux
+          if ((buffer[0] != 0xA0) || (buffer[1] != 0xA0)) // If we read back something other than 0xA0A0 then we are probably talking to an MS5637 / MS5837 / MS8607, not a mux
           {
             return (DEVICE_PRESSURE_MS5637);
           }

Firmware/OpenLog_Artemis/Sensors.ino

@@ -137,11 +137,9 @@ void powerDown()
   qwiicPowerOff();
 #endif
 
-  //Power down Flash, SRAM, cache
-  am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_CACHE);         //Turn off CACHE
-  am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_FLASH_512K);    //Turn off everything but lower 512k
-  am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_SRAM_64K_DTCM); //Turn off everything but lower 64k
-  //am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_ALL); //Turn off all memory (doesn't recover)
+  //Power down cache, flash, SRAM
+  am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_ALL); // Power down all flash and cache
+  am_hal_pwrctrl_memory_deepsleep_retain(AM_HAL_PWRCTRL_MEM_SRAM_384K); // Retain all SRAM
 
   //Keep the 32kHz clock running for RTC
   am_hal_stimer_config(AM_HAL_STIMER_CFG_CLEAR | AM_HAL_STIMER_CFG_FREEZE);
@@ -320,11 +318,9 @@ void goToSleep(uint32_t sysTicksToSleep)
   //else
   //  powerLEDOff();
 
-  //Power down Flash, SRAM, cache
-  am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_CACHE);         //Turn off CACHE
-  am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_FLASH_512K);    //Turn off everything but lower 512k
-  //am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_SRAM_64K_DTCM); //Turn off everything but lower 64k (Leaving 64K powered up probably isn't enough - "Global variables use 70496 bytes of dynamic memory.")
-  //am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_ALL); //Turn off all memory (doesn't recover)
+  //Power down cache, flash, SRAM
+  am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_ALL); // Power down all flash and cache
+  am_hal_pwrctrl_memory_deepsleep_retain(AM_HAL_PWRCTRL_MEM_SRAM_384K); // Retain all SRAM
 
   //Use the lower power 32kHz clock. Use it to run CT6 as well.
   am_hal_stimer_config(AM_HAL_STIMER_CFG_CLEAR | AM_HAL_STIMER_CFG_FREEZE);
@@ -365,9 +361,6 @@ void goToSleep(uint32_t sysTicksToSleep)
 //Power everything up gracefully
 void wakeFromSleep()
 {
-  //Power up SRAM, turn on entire Flash
-  am_hal_pwrctrl_memory_deepsleep_powerdown(AM_HAL_PWRCTRL_MEM_MAX);
-
   //Go back to using the main clock
   //am_hal_stimer_int_enable(AM_HAL_STIMER_INT_OVERFLOW);
   //NVIC_EnableIRQ(STIMER_IRQn);
@@ -450,6 +443,7 @@ void wakeFromSleep()
   if (settings.useTxRxPinsForTerminal == false)
   {
     beginSerialLogging(); //20 - 99ms
+    beginSerialOutput();
   }
 
   beginIMU(); //61ms

Firmware/OpenLog_Artemis/autoDetect.ino

@@ -82,7 +82,7 @@ bool detectQwiicDevices()
       {
         if (settings.printDebugMessages == true)
         {
-          SerialPrintf2("detectQwiicDevices: MS8607/MS5637 found at address 0x%02X. Ignoring it for now...\r\n", address);
+          SerialPrintf2("detectQwiicDevices: MS8607/MS5637/MS5837 found at address 0x%02X. Ignoring it for now...\r\n", address);
         }
       }
     }
@@ -103,7 +103,7 @@ bool detectQwiicDevices()
 
   //Before going into mux sub branches, scan the main branch for all remaining devices
   SerialPrintln(F("Identifying Qwiic Devices..."));
-  bool foundMS8607 = false; // The MS8607 appears as two devices (MS8607 and MS5637). We need to skip the MS5637 if we have found a MS8607.
+  bool foundMS8607 = false; // The MS8607 appears as two devices (MS8607 and MS5637). We need to skip the MS5637/MS5837 if we have found a MS8607.
   for (uint8_t address = 1 ; address < 127 ; address++)
   {
     qwiic.beginTransmission(address);
@@ -117,9 +117,9 @@ bool detectQwiicDevices()
       deviceType_e foundType = testDevice(address, 0, 0); //No mux or port numbers for this test
       if (foundType != DEVICE_UNKNOWN_DEVICE)
       {
-        if ((foundType == DEVICE_PRESSURE_MS5637) && (foundMS8607 == true))
+        if ((foundMS8607 == true) && ((foundType == DEVICE_PRESSURE_MS5637) || (foundType == DEVICE_PRESSURE_MS5837)))
         {
-          ; // Skip MS5637 as we have already found an MS8607
+          ; // Skip MS5637/MS5837 as we have already found an MS8607
         }
         else
         {
@@ -2271,9 +2271,9 @@ void menuConfigure_SDP3X(void *configPtr)
       if (sensorSetting->massFlow == true) SerialPrintln(F("Mass Flow"));
       else SerialPrintln(F("Differential Pressure"));
 
-      SerialPrint(F("5) Use Clock Stretching: "));
-      if (sensorSetting->clockStretching == true) SerialPrintln(F("Yes"));
-      else SerialPrintln(F("No"));
+      SerialPrint(F("5) Measurement Averaging: "));
+      if (sensorSetting->averaging == true) SerialPrintln(F("Enabled"));
+      else SerialPrintln(F("Disabled"));
     }
     SerialPrintln(F("x) Exit"));
 
@@ -2290,7 +2290,7 @@ void menuConfigure_SDP3X(void *configPtr)
       else if (incoming == 4)
         sensorSetting->massFlow ^= 1;
       else if (incoming == 5)
-        sensorSetting->clockStretching ^= 1;
+        sensorSetting->averaging ^= 1;
       else if (incoming == STATUS_PRESSED_X)
         break;
       else if (incoming == STATUS_GETNUMBER_TIMEOUT)
@@ -2317,7 +2317,7 @@ void menuConfigure_MS5837(void *configPtr)
     SerialPrintln(F("Menu: Configure MS5837 Pressure Sensor"));
 
     SerialPrint(F("Sensor Model: "));
-    if (sensorSetting->model == true) SerialPrintln(F("MS5837-02BA / BlueRobotics Bar02: 2 Bar Absolute / 10m Depth"));
+    if (sensorSetting->model == 1) SerialPrintln(F("MS5837-02BA / BlueRobotics Bar02: 2 Bar Absolute / 10m Depth"));
     else SerialPrintln(F("MS5837-30BA / BlueRobotics Bar30: 30 Bar Absolute / 300m Depth"));
 
     SerialPrint(F("1) Sensor Logging: "));

Firmware/OpenLog_Artemis/lowerPower.ino

@@ -694,7 +694,7 @@ void recordDeviceSettingsToFile()
             settingsFile.println((String)base + "logPressure=" + nodeSetting->logPressure);
             settingsFile.println((String)base + "logTemperature=" + nodeSetting->logTemperature);
             settingsFile.println((String)base + "massFlow=" + nodeSetting->massFlow);
-            settingsFile.println((String)base + "clockStretching=" + nodeSetting->clockStretching);
+            settingsFile.println((String)base + "averaging=" + nodeSetting->averaging);
           }
           break;
         case DEVICE_PRESSURE_MS5837:
@@ -1259,8 +1259,8 @@ bool parseDeviceLine(char* str) {
             nodeSetting->logTemperature = d;
           else if (strcmp(deviceSettingName, "massFlow") == 0)
             nodeSetting->massFlow = d;
-          else if (strcmp(deviceSettingName, "clockStretching") == 0)
-            nodeSetting->clockStretching = d;
+          else if (strcmp(deviceSettingName, "averaging") == 0)
+            nodeSetting->averaging = d;
           else
             SerialPrintf2("Unknown device setting: %s\r\n", deviceSettingName);
         }

Firmware/OpenLog_Artemis/menuAttachedDevices.ino

@@ -297,7 +297,7 @@ struct struct_SDP3X {
   bool logPressure = true;
   bool logTemperature = true;
   bool massFlow = true;
-  bool clockStretching = false;
+  bool averaging = false;
   unsigned long powerOnDelayMillis = minimumQwiicPowerOnDelay; // Wait for at least this many millis before communicating with this device. Increase if required!
 };
 
@@ -307,7 +307,7 @@ struct struct_MS5837 {
   bool logTemperature = true;
   bool logDepth = true;
   bool logAltitude = true;
-  bool model = true; // Valid options are: 0 (MS5837::MS5837_30BA) and 1 (MS5837::MS5837_02BA)
+  uint8_t model = 1; // Valid options are: 0 (MS5837::MS5837_30BA); 1 (MS5837::MS5837_02BA) and 255 (MS5837::MS5837_UNRECOGNISED)
   float fluidDensity = 997;
   float conversion = 1.0;
   unsigned long powerOnDelayMillis = minimumQwiicPowerOnDelay; // Wait for at least this many millis before communicating with this device. Increase if required!