Add Qwiic bus power control and speed control

Author: nseidle

CHANGELOG.md

@@ -4,10 +4,12 @@ Change Log
 v1.1
 ---------
 
-* Added support for exFat microSD cards. Tested up to 512GB. We still suppport smaller FAT16 and FAT32 formatted cards.
+* Add support for exFat microSD cards. Tested up to 512GB. Smaller FAT16 and FAT32 formatted cards are still supported.
+* Add support for MS8607 PHT sensor
+* Add ability to turn on/off power on Qwiic bus when time between sensor readings is > 2s. By default the bus powers down to save power but there may be instances where user wants to keep sensors powered up and running between reads. This can be accessed via the Attached Devices menu.
+* Add ability to limit I2C bus speed. Most devices operate at 400kHz I2C. Some (MCP9600) are automatically limited by OLA to 100kHz. There may be instances, because of bus length or other, where the user may want to artifically limit the bus speed. This can be access via the Attached Devices menu.
+
 
 v1.0
 ---------
-Initial release. Support for
-
-*
+Initial release.

Firmware/OpenLog_Artemis/Sensors.ino

@@ -716,5 +716,9 @@ void determineMaxI2CSpeed()
   else if (settings.sensor_uBlox.i2cSpeed == 100000)
     maxSpeed = 100000;
 
+  //If user wants to limit the I2C bus speed, do it here
+  if(maxSpeed > settings.qwiicBusMaxSpeed)
+    maxSpeed = settings.qwiicBusMaxSpeed;
+
   qwiic.setClock(maxSpeed);
 }

Firmware/OpenLog_Artemis/lowerPower.ino

@@ -114,10 +114,15 @@ void goToSleep()
     am_hal_gpio_pinconfig(x, g_AM_HAL_GPIO_DISABLE);
 
   //We can't leave these power control pins floating
-  qwiicPowerOff();
   imuPowerOff();
   microSDPowerOff();
 
+  //Keep Qwiic bus powered on if user desires it
+  if (settings.powerDownQwiicBusBetweenReads == true)
+    qwiicPowerOff();
+  else
+    qwiicPowerOn(); //Make sure pins stays as output
+
   //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

Firmware/OpenLog_Artemis/menuAttachedDevices.ino

@@ -26,11 +26,7 @@ void menuAttachedDevices()
 
     //See what's on the I2C bus. Will set the qwiicAvailable bools.
     if (detectQwiicDevices() == false)
-    {
-      Serial.println("No devices detected on Qwiic bus");
-      delay(3000);
-      return;
-    }
+      Serial.println("**No devices detected on Qwiic bus**");
 
     //Create array of pointers to the configure functions
     typedef void(*FunctionPointer)();
@@ -109,6 +105,9 @@ void menuAttachedDevices()
       Serial.printf("%d) MS8607 Pressure Humidity Temperature Sensor\n", availableDevices++);
     }
 
+    functionPointers[availableDevices - 1] = menuConfigure_QwiicBus;
+    Serial.printf("%d) Configure Qwiic Settings\n", availableDevices++);
+
     Serial.println("x) Exit");
 
     byte incoming = getByteChoice(menuTimeout); //Timeout after x seconds
@@ -262,6 +261,46 @@ bool testDevice(uint8_t i2cAddress)
   return true;
 }
 
+void menuConfigure_QwiicBus()
+{
+  while (1)
+  {
+    Serial.println();
+    Serial.println("Menu: Configure Qwiic Bus");
+
+    Serial.print("1) If sensor read time is greater than 2s, turn off bus power: ");
+    if (settings.powerDownQwiicBusBetweenReads == true) Serial.println("Enabled");
+    else Serial.println("Disabled");
+
+    Serial.print("2) Set Max Qwiic Bus Speed: ");
+    Serial.println(settings.qwiicBusMaxSpeed);
+
+    Serial.println("x) Exit");
+
+    byte incoming = getByteChoice(menuTimeout); //Timeout after x seconds
+
+    if (incoming == '1')
+      settings.powerDownQwiicBusBetweenReads ^= 1;
+    else if (incoming == '2')
+    {
+      Serial.print("Enter max frequency to run Qwiic bus: (100000 to 400000): ");
+      int amt = getNumber(menuTimeout);
+      if (amt >= 100000 && amt <= 400000)
+        settings.qwiicBusMaxSpeed = amt;
+      else
+        Serial.println("Error: Out of range");
+    }
+    else if (incoming == 'x')
+      break;
+    else if (incoming == STATUS_GETBYTE_TIMEOUT)
+      break;
+    else
+      printUnknown(incoming);
+  }
+
+  qwiicOnline.LPS25HB = false; //Mark as offline so it will be started with new settings
+}
+
 void menuConfigure_LPS25HB()
 {
   while (1)

Firmware/OpenLog_Artemis/menuDebug.ino

@@ -0,0 +1,27 @@
+void menuDebug()
+{
+  while (1)
+  {
+    Serial.println();
+    Serial.println("Menu: Configure Debug Settings");
+
+    Serial.print("1) Debug Messages: ");
+    if (settings.printDebugMessages == true) Serial.println("Enabled");
+    else Serial.println("Disabled");
+
+    Serial.println("x) Exit");
+
+    byte incoming = getByteChoice(menuTimeout); //Timeout after x seconds
+
+    if (incoming == '1')
+    {
+      settings.printDebugMessages ^= 1;
+    }
+    else if (incoming == 'x')
+      break;
+    else if (incoming == STATUS_GETBYTE_TIMEOUT)
+      break;
+    else
+      printUnknown(incoming);
+  }
+}

Firmware/OpenLog_Artemis/menuMain.ino

@@ -23,11 +23,10 @@ void menuMain()
 
     Serial.println("6) Detect / Configure Attached Devices");
 
-    //Serial.println(") Configure Battery Voltage Logging");
-    //Enable VCC logging
-
     Serial.println("r) Reset all settings to default");
 
+    //Serial.println("d) Debug Menu");
+
     Serial.println("x) Return to logging");
 
     byte incoming = getByteChoice(menuTimeout); //Timeout after x seconds
@@ -45,12 +44,7 @@ void menuMain()
     else if (incoming == '6')
       menuAttachedDevices();
     else if (incoming == 'd')
-    {
-      Serial.print("Debug Messages ");
-      settings.printDebugMessages ^= 1;
-      if(settings.printDebugMessages == true) Serial.println("Enabled");
-      else Serial.println("Disabled");
-    }
+      menuDebug();
     else if (incoming == 'r')
     {
       Serial.println("\n\rResetting to factory defaults. Continue? Press 'y':");

Firmware/OpenLog_Artemis/nvm.ino

@@ -90,6 +90,8 @@ void recordSettingsToFile()
     settingsFile.println("logAnalogVoltages=" + (String)settings.logAnalogVoltages);
     settingsFile.println("localUTCOffset=" + (String)settings.localUTCOffset);
     settingsFile.println("printDebugMessages=" + (String)settings.printDebugMessages);
+    settingsFile.println("powerDownQwiicBusBetweenReads=" + (String)settings.powerDownQwiicBusBetweenReads);
+    settingsFile.println("qwiicBusMaxSpeed=" + (String)settings.qwiicBusMaxSpeed);
     //    settingsFile.println("=" + (String)settings.sensor_LPS25HB.);
 
     settingsFile.close();
@@ -278,6 +280,10 @@ bool parseLine(char* str) {
     settings.localUTCOffset = d;
   else if (strcmp(settingName, "printDebugMessages") == 0)
     settings.printDebugMessages = d;
+  else if (strcmp(settingName, "powerDownQwiicBusBetweenReads") == 0)
+    settings.powerDownQwiicBusBetweenReads = d;
+  else if (strcmp(settingName, "qwiicBusMaxSpeed") == 0)
+    settings.qwiicBusMaxSpeed = d;
   //  else if (strcmp(settingName, "") == 0)
   //    settings. = d;
   else

Firmware/OpenLog_Artemis/settings.h

@@ -169,6 +169,8 @@ struct struct_settings {
   bool logAnalogVoltages = true;
   int localUTCOffset = -7; //Default to Denver because we can
   bool printDebugMessages = false;
+  bool powerDownQwiicBusBetweenReads = true;
+  int qwiicBusMaxSpeed = 400000;
   struct_LPS25HB sensor_LPS25HB;
   struct_uBlox sensor_uBlox;
   struct_VL53L1X sensor_VL53L1X;