Add MS8607 support

Author: nseidle

Firmware/OpenLog_Artemis/OpenLog_Artemis.ino

@@ -33,7 +33,7 @@ enum returnStatus {
 
 //Setup Qwiic Port
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
-#include "Wire.h"
+#include <Wire.h>
 TwoWire qwiic(1); //Will use pads 8/9
 const byte PIN_QWIIC_POWER = 18;
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
@@ -138,6 +138,9 @@ SGP30 vocSensor_SGP30;
 #include "SparkFun_SCD30_Arduino_Library.h" //Click here to get the library: http://librarymanager/All#SparkFun_SCD30
 SCD30 co2Sensor_SCD30;
 
+#include "MS8607_Library.h" //Click here to get the library: http://librarymanager/All#Qwiic_MS8607
+MS8607 pressureSensor_MS8607;
+
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 //Global variables

Firmware/OpenLog_Artemis/Sensors.ino

@@ -207,6 +207,26 @@ bool beginSensors()
     else
       beginSensorOutput += "SCD30 failed to respond. Check wiring.\n";
   }
+
+  if (qwiicAvailable.MS8607 && settings.sensor_MS8607.log && !qwiicOnline.MS8607)
+  {
+    if (pressureSensor_MS8607.begin(qwiic) == true) //Wire port. This checks both 0x40 and 0x76 sensor addresses
+    {
+      if(settings.sensor_MS8607.enableHeater == true)
+        pressureSensor_MS8607.enable_heater();
+      else
+        pressureSensor_MS8607.disable_heater();
+      
+      pressureSensor_MS8607.set_pressure_resolution(settings.sensor_MS8607.pressureResolution);
+      pressureSensor_MS8607.set_humidity_resolution(settings.sensor_MS8607.humidityResolution);
+
+      qwiicOnline.MS8607 = true;
+      beginSensorOutput += "MS8607 Online\n";
+    }
+    else
+      beginSensorOutput += "MS8607 failed to respond. Check wiring.\n";
+  }
+
   return true;
 }
 
@@ -642,6 +662,25 @@ void getData()
     }
   }
 
+  if (qwiicOnline.MS8607 && settings.sensor_MS8607.log)
+  {
+    if (settings.sensor_MS8607.logPressure)
+    {
+      outputData += (String)pressureSensor_MS8607.getPressure() + ",";
+      helperText += "hPa,";
+    }
+    if (settings.sensor_MS8607.logHumidity)
+    {
+      outputData += (String)pressureSensor_MS8607.getHumidity() + ",";
+      helperText += "humidity_%,";
+    }
+    if (settings.sensor_MS8607.logPressure)
+    {
+      outputData += (String)pressureSensor_MS8607.getTemperature() + ",";
+      helperText += "degC,";
+    }
+  }
+
   if (settings.logHertz)
   {
     //Calculate the actual update rate based on the sketch start time and the

Firmware/OpenLog_Artemis/menuAttachedDevices.ino

@@ -103,6 +103,11 @@ void menuAttachedDevices()
       functionPointers[availableDevices - 1] = menuConfigure_SCD30;
       Serial.printf("%d) SCD30 CO2 Sensor\n", availableDevices++);
     }
+    if (qwiicAvailable.MS8607)
+    {
+      functionPointers[availableDevices - 1] = menuConfigure_MS8607;
+      Serial.printf("%d) MS8607 Pressure Humidity Temperature Sensor\n", availableDevices++);
+    }
 
     Serial.println("x) Exit");
 
@@ -155,6 +160,7 @@ bool detectQwiicDevices()
 #define ADR_VEML6075 0x10
 #define ADR_NAU7802 0x2A
 #define ADR_VL53L1X 0x29
+#define ADR_MS8607 0x40 //Humidity portion of the MS8607 sensor
 #define ADR_UBLOX 0x42
 #define ADR_TMP117 0x48 //Alternates: 0x49, 0x4A, and 0x4B
 #define ADR_SGP30 0x58
@@ -167,6 +173,7 @@ bool detectQwiicDevices()
 #define ADR_MCP9600_1 0x66
 #define ADR_BME280_2 0x76
 #define ADR_MS5637 0x76
+//#define ADR_MS8607 0x76 //Pressure portion of the MS8607 sensor. We'll catch the 0x40 first
 #define ADR_BME280_1 0x77
 
 //Given an address, see if it repsonds as we would expect
@@ -230,13 +237,23 @@ bool testDevice(uint8_t i2cAddress)
         qwiicAvailable.VEML6075 = true;
       break;
     case ADR_MS5637:
-      if (pressureSensor_MS5637.begin(qwiic) == true) //Wire port
-        qwiicAvailable.MS5637 = true;
-      break;
+      {
+        //By the time we hit this address, MS8607 should have already been started by its first address
+        if (qwiicAvailable.MS8607 == false)
+        {
+          if (pressureSensor_MS5637.begin(qwiic) == true) //Wire port
+            qwiicAvailable.MS5637 = true;
+        }
+        break;
+      }
     case ADR_SCD30:
       if (co2Sensor_SCD30.begin(qwiic) == true) //Wire port
         qwiicAvailable.SCD30 = true;
       break;
+    case ADR_MS8607:
+      if (pressureSensor_MS8607.begin(qwiic) == true) //Wire port. Tests for both 0x40 and 0x76 I2C addresses.
+        qwiicAvailable.MS8607 = true;
+      break;
     default:
       Serial.printf("Unknown device at address 0x%02X\n", i2cAddress);
       return false;
@@ -1193,3 +1210,126 @@ void menuConfigure_SCD30()
 
   qwiicOnline.SCD30 = false; //Mark as offline so it will be started with new settings
 }
+
+void menuConfigure_MS8607()
+{
+  while (1)
+  {
+    Serial.println();
+    Serial.println("Menu: Configure MS8607 Pressure Humidity Temperature (PHT) Sensor");
+
+    Serial.print("1) Sensor Logging: ");
+    if (settings.sensor_MS8607.log == true) Serial.println("Enabled");
+    else Serial.println("Disabled");
+
+    if (settings.sensor_MS8607.log == true)
+    {
+      Serial.print("2) Log Pressure: ");
+      if (settings.sensor_MS8607.logPressure == true) Serial.println("Enabled");
+      else Serial.println("Disabled");
+
+      Serial.print("3) Log Humidity: ");
+      if (settings.sensor_MS8607.logHumidity == true) Serial.println("Enabled");
+      else Serial.println("Disabled");
+
+      Serial.print("4) Log Temperature: ");
+      if (settings.sensor_MS8607.logTemperature == true) Serial.println("Enabled");
+      else Serial.println("Disabled");
+
+      Serial.print("5) Heater: ");
+      if (settings.sensor_MS8607.enableHeater == true) Serial.println("Enabled");
+      else Serial.println("Disabled");
+
+      Serial.print("6) Set Pressure Resolution: ");
+      if (settings.sensor_MS8607.pressureResolution == MS8607_pressure_resolution_osr_256)
+        Serial.print("0.11");
+      else if (settings.sensor_MS8607.pressureResolution == MS8607_pressure_resolution_osr_512)
+        Serial.print("0.062");
+      else if (settings.sensor_MS8607.pressureResolution == MS8607_pressure_resolution_osr_1024)
+        Serial.print("0.039");
+      else if (settings.sensor_MS8607.pressureResolution == MS8607_pressure_resolution_osr_2048)
+        Serial.print("0.028");
+      else if (settings.sensor_MS8607.pressureResolution == MS8607_pressure_resolution_osr_4096)
+        Serial.print("0.021");
+      else if (settings.sensor_MS8607.pressureResolution == MS8607_pressure_resolution_osr_8192)
+        Serial.print("0.016");
+      Serial.println(" mbar");
+
+      Serial.print("7) Set Humidity Resolution: ");
+      if (settings.sensor_MS8607.humidityResolution == MS8607_humidity_resolution_8b)
+        Serial.print("8");
+      else if (settings.sensor_MS8607.humidityResolution == MS8607_humidity_resolution_10b)
+        Serial.print("10");
+      else if (settings.sensor_MS8607.humidityResolution == MS8607_humidity_resolution_11b)
+        Serial.print("11");
+      else if (settings.sensor_MS8607.humidityResolution == MS8607_humidity_resolution_12b)
+        Serial.print("12");
+      Serial.println(" bits");
+    }
+    Serial.println("x) Exit");
+
+    byte incoming = getByteChoice(menuTimeout); //Timeout after x seconds
+
+    if (incoming == '1')
+      settings.sensor_MS8607.log ^= 1;
+    else if (settings.sensor_MS8607.log == true)
+    {
+      if (incoming == '2')
+        settings.sensor_MS8607.logPressure ^= 1;
+      else if (incoming == '3')
+        settings.sensor_MS8607.logHumidity ^= 1;
+      else if (incoming == '4')
+        settings.sensor_MS8607.logTemperature ^= 1;
+      else if (incoming == '5')
+        settings.sensor_MS8607.enableHeater ^= 1;
+      else if (incoming == '6')
+      {
+        Serial.println("Set Pressure Resolution:");
+        Serial.println("1) 0.11 mbar");
+        Serial.println("2) 0.062 mbar");
+        Serial.println("3) 0.039 mbar");
+        Serial.println("4) 0.028 mbar");
+        Serial.println("5) 0.021 mbar");
+        Serial.println("6) 0.016 mbar");
+        int amt = getNumber(menuTimeout); //x second timeout
+        if (amt >= 1 && amt <= 6)
+          settings.sensor_MS8607.pressureResolution = (MS8607_pressure_resolution)(amt - 1);
+        else
+          Serial.println("Error: Out of range");
+      }
+      else if (incoming == '7')
+      {
+        Serial.println("Set Humidity Resolution:");
+        Serial.println("1) 8 bit");
+        Serial.println("2) 10 bit");
+        Serial.println("3) 11 bit");
+        Serial.println("4) 12 bit");
+        int amt = getNumber(menuTimeout); //x second timeout
+        if (amt >= 1 && amt <= 4)
+        {
+          //Unfortunately these enums aren't sequential so we have to lookup
+          if (amt == 1) settings.sensor_MS8607.humidityResolution = MS8607_humidity_resolution_8b;
+          if (amt == 2) settings.sensor_MS8607.humidityResolution = MS8607_humidity_resolution_10b;
+          if (amt == 3) settings.sensor_MS8607.humidityResolution = MS8607_humidity_resolution_11b;
+          if (amt == 4) settings.sensor_MS8607.humidityResolution = MS8607_humidity_resolution_12b;
+        }
+        else
+          Serial.println("Error: Out of range");
+      }
+      else if (incoming == 'x')
+        break;
+      else if (incoming == STATUS_GETBYTE_TIMEOUT)
+        break;
+      else
+        printUnknown(incoming);
+    }
+    else if (incoming == 'x')
+      break;
+    else if (incoming == STATUS_GETBYTE_TIMEOUT)
+      break;
+    else
+      printUnknown(incoming);
+  }
+
+  qwiicOnline.MS8607 = false; //Mark as offline so it will be started with new settings
+}

Firmware/OpenLog_Artemis/settings.h

@@ -1,3 +1,5 @@
+#include "MS8607_Library.h" //Click here to get the library: http://librarymanager/All#Qwiic_MS8607
+
 //Add the new sensor settings below
 struct struct_LPS25HB {
   bool log = true;
@@ -115,6 +117,17 @@ struct struct_SCD30 {
   int temperatureOffset = 0; //C - Be careful not to overwrite the value on the sensor
 };
 
+
+struct struct_MS8607 {
+  bool log = true;
+  bool logHumidity = true;
+  bool logPressure = true;
+  bool logTemperature = true;
+  bool enableHeater = false; // The TE examples say that get_compensated_humidity and get_dew_point will only work if the heater is OFF
+  MS8607_pressure_resolution pressureResolution = MS8607_pressure_resolution_osr_8192; //17ms per reading, 0.016mbar resolution
+  MS8607_humidity_resolution humidityResolution = MS8607_humidity_resolution_12b; //12-bit
+};
+
 //This is all the settings that can be set on OpenLog. It's recorded to NVM and the config file.
 struct struct_settings {
   int sizeOfSettings = 0;
@@ -169,6 +182,7 @@ struct struct_settings {
   struct_VEML6075 sensor_VEML6075;
   struct_MS5637 sensor_MS5637;
   struct_SCD30 sensor_SCD30;
+  struct_MS8607 sensor_MS8607;
 } settings;
 
 //These are the devices on board OpenLog that may be on or offline.
@@ -195,6 +209,7 @@ struct struct_QwiicSensors {
   bool VEML6075;
   bool MS5637;
   bool SCD30;
+  bool MS8607;
 };
 
 struct_QwiicSensors qwiicAvailable = {
@@ -212,6 +227,7 @@ struct_QwiicSensors qwiicAvailable = {
   .VEML6075 = false,
   .MS5637 = false,
   .SCD30 = false,
+  .MS8607 = false,
 };
 
 struct_QwiicSensors qwiicOnline = {
@@ -229,4 +245,5 @@ struct_QwiicSensors qwiicOnline = {
   .VEML6075 = false,
   .MS5637 = false,
   .SCD30 = false,
+  .MS8607 = false,
 };