Added mode (burst/shutdown) configuration ability

Currently untested

Author: FischerMoseley

examples/Example2_SetThermocoupleType/Example2_SetThermocoupleType.ino

@@ -19,7 +19,7 @@
 
 #include <SparkFun_MCP9600.h>
 MCP9600 tempSensor;
-thermocoupleType type = S_type; //the type of thermocouple to change to!
+thermocoupleType type = TYPE_S; //the type of thermocouple to change to!
 
 void setup(){
     Serial.begin(115200);

examples/Example4_SetResolution/Example4_SetResolution.ino

@@ -43,8 +43,8 @@
 #include <SparkFun_MCP9600.h>
 MCP9600 tempSensor;
 
-ambientResolution ambientRes = RES_ZERO_POINT_0625;
-thermocoupleResolution thermocoupleRes = RES_14_BIT;
+Ambient_Resolution ambientRes = RES_ZERO_POINT_0625;
+Thermocouple_Resolution thermocoupleRes = RES_14_BIT;
 
 void setup(){
   Serial.begin(115200);
@@ -69,12 +69,6 @@ void setup(){
   //set the resolution on the ambient (cold) junction
   tempSensor.setAmbientResolution(ambientRes);
   tempSensor.setThermocoupleResolution(thermocoupleRes);
-
-  //this is just debug, remove it if you're reading this
-  Serial.print("Ambient Resolution Config successful?: ");
-  Serial.println(tempSensor.getAmbientResolution() == ambientRes);
-  Serial.print("Thermocouple Resolution Config successful?: ");
-  Serial.println(tempSensor.getThermocoupleResolution() == thermocoupleRes);
 }
 
 void loop(){ //print the thermocouple, ambient and delta temperatures every 200ms

examples/Example5_BurstMode/Example5_BurstMode.ino

@@ -0,0 +1,67 @@
+/*
+  Configuring Burst Mode with the MCP9600 Thermocouple Amplifier
+  By: Fischer Moseley
+  SparkFun Electronics
+  Date: July 10, 2019
+  License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware License).
+
+  This example configures the shutdown (or "operating") mode that the MCP9600 runs in. Shutdown mode disables all
+  power consuming activities on the MCP9600, including measurements, but it will still respond to I2C commands sent
+  over Qwiic. Burst mode is similar, where the MCP9600 is shutdown until the Arduino asks it to wake up and take a 
+  number of samples, apply any filtering, update any outputs, and then go back to sleep. This example walks through
+  that process!
+
+  Hardware Connections:
+  Attach the Qwiic Shield to your Arduino/Photon/ESP32 or other
+  Plug the sensor onto the shield
+  Serial.print it out at 115200 baud to serial monitor.
+*/
+
+#include <SparkFun_MCP9600.h>
+MCP9600 tempSensor;
+Shutdown_Mode mode = BURST;
+Burst_Sample samples = SAMPLES_32;
+
+void setup(){
+  Serial.begin(115200);
+  //check if the sensor is connected
+  if(tempSensor.isConnected()){
+    Serial.println("Device will acknowledge!");
+  }
+  else {
+    Serial.println("Device did not acknowledge! Freezing.");
+    while(1); //hang forever
+  }
+
+  //check if the Device ID is correct
+  if(tempSensor.checkDeviceID()){
+    Serial.println("Device ID is correct!");        
+  }
+  else {
+    Serial.println("Device ID is not correct! Freezing.");
+    while(1); //hang forever
+  }
+
+  //put the MCP9600 into burst mode!
+  tempSensor.setShutdownMode(BURST);
+  tempSensor.setBurstSamples(samples);  
+}
+
+void loop(){
+  if(tempSensor.burstAvailable()){ //if there's a new burst measurement, get the data and print it
+
+    //print the thermocouple, ambient and delta temperatures
+    Serial.print("Thermocouple: ");
+    Serial.print(tempSensor.thermocoupleTemp());
+    Serial.print(" °C   Ambient: ");
+    Serial.print(tempSensor.ambientTemp());
+    Serial.print(" °C   Temperature Delta: ");
+    Serial.print(tempSensor.tempDelta());
+    Serial.print(" °C");
+    Serial.println();
+
+    //clear the register and start a new burst cycle!
+    tempSensor.startBurst();
+  }
+  delay(200); //we want to be able to see our data, so we won't let it print any faster than 200ms
+}

src/SparkFun_MCP9600.cpp

@@ -68,10 +68,25 @@ float MCP9600::tempDelta(){
   return ((float)raw * DEV_RESOLUTION);
 }
 
+signed long MCP9600::rawADC(){
+  for(byte attempts; attempts <= retryAttempts; attempts++){
+    _i2cPort->beginTransmission(DEV_ADDR);
+    _i2cPort->write(RAW_ADC);
+    _i2cPort->endTransmission();
+
+    if(_i2cPort->requestFrom(DEV_ADDR, 3) != 0){
+      signed long data = _i2cPort->read() << 16;
+      data |= _i2cPort->read() << 8;
+      data |= _i2cPort->read();
+      return data;
+    }
+  }
+}
+
 
 /*--------------------------- Measurement Configuration --------------- */
 
-bool MCP9600::setAmbientResolution(ambientResolution res){
+bool MCP9600::setAmbientResolution(Ambient_Resolution res){
   uint8_t config = readSingleRegister(DEVICE_CONFIG); //get current device configuration so we don't wipe everything else
   bitWrite(config, 7, res); //set the bit that controls the ambient (cold) junction resolution
 
@@ -80,12 +95,12 @@ bool MCP9600::setAmbientResolution(ambientResolution res){
   return failed; //return 1 if the write failed or the register wasn't properly set, 0 otherwise
 }
 
-ambientResolution MCP9600::getAmbientResolution(){
+Ambient_Resolution MCP9600::getAmbientResolution(){
   uint8_t config = readSingleRegister(DEVICE_CONFIG); //grab current device configuration 
   return bitRead(config, 7); //return 7th bit from config register
 }
 
-bool MCP9600::setThermocoupleResolution(thermocoupleResolution res){
+bool MCP9600::setThermocoupleResolution(Thermocouple_Resolution res){
   uint8_t config = readSingleRegister(DEVICE_CONFIG); //grab current device configuration so we don't wipe everything else
   bool highResolutionBit = bitRead(res, 1);
   bool lowResolutionBit = bitRead(res, 0);
@@ -97,17 +112,17 @@ bool MCP9600::setThermocoupleResolution(thermocoupleResolution res){
   return failed; //return 1 if the write failed or the register wasn't properly set, 0 otherwise
 }
 
-thermocoupleResolution MCP9600::getThermocoupleResolution(){
+Thermocouple_Resolution MCP9600::getThermocoupleResolution(){
   uint8_t config = readSingleRegister(DEVICE_CONFIG); //grab current device configuration 
-  thermocoupleResolution res; //define new thermocoupleResolution enum to return
+  Thermocouple_Resolution res; //define new thermocoupleResolution enum to return
   bool highResolutionBit = bitRead(config, 6);
   bool lowResolutionBit = bitRead(config, 5);
   bitWrite(res, 1, highResolutionBit); //set 1st bit of the enum to the 6th bit of the config register
   bitWrite(res, 0, lowResolutionBit); //set 0th bit of the enum to the 5th bit of the config register
   return res;
 }
 
-uint8_t MCP9600::setThermocoupleType(thermocoupleType type){
+uint8_t MCP9600::setThermocoupleType(Thermocouple_Type type){
   uint8_t config = readSingleRegister(THERMO_SENSOR_CONFIG); //grab current device configuration so we don't wipe everything else
   bitClear(config, 4); //clear the necessary bits so that they can be set
   bitClear(config, 5);
@@ -119,7 +134,7 @@ uint8_t MCP9600::setThermocoupleType(thermocoupleType type){
   return 0; //otherwise return 0
 }
 
-thermocoupleType MCP9600::getThermocoupleType(){
+Thermocouple_Type MCP9600::getThermocoupleType(){
   uint8_t config = readSingleRegister(THERMO_SENSOR_CONFIG);
   return (config >> 4); //clear the non-thermocouple-type bits in the config registe
 }
@@ -141,6 +156,57 @@ uint8_t MCP9600::getFilterCoeffecients(){
   return ((config << 5) >> 5); //clear the non-filter-coeffecients data in the config register
 }
 
+bool MCP9600::setBurstSamples(Burst_Sample samples){
+  uint8_t config = readSingleRegister(DEVICE_CONFIG);
+  bool highResolutionBit = bitRead(samples, 2);
+  bool midResolutionBit = bitRead(samples, 1);
+  bool lowResolutionBit = bitRead(samples, 0);
+  bitWrite(config, 4, highResolutionBit); //write 2nd bit of samples to 4th of config
+  bitWrite(config, 3, midResolutionBit); //write 1st bit of samples to 3rd of config
+  bitWrite(config, 2, lowResolutionBit); //write 0th bit of samples to 2nd of config
+
+  bool failed = writeSingleRegister(DEVICE_CONFIG, config); //write new config register to MCP9600
+  failed &= (readSingleRegister(DEVICE_CONFIG) != config); //double check that it was written properly
+  return failed; //return 1 if the write failed or the register wasn't properly set, 0 otherwise
+}
+
+Burst_Sample MCP9600::getBurstSamples(){
+  uint8_t config = readSingleRegister(DEVICE_CONFIG);
+  bool highResolutionBit = bitRead(config, 4);
+  bool midResolutionBit = bitRead(config, 3);
+  bool lowResolutionBit = bitRead(config, 2);
+  Burst_Sample samples;
+  bitWrite(samples, 2, highResolutionBit); //write 4th bit of config to 2nd bit of samples
+  bitWrite(samples, 1, midResolutionBit); //write 3rd bit of config to 1st bit of samples
+  bitWrite(samples, 0, lowResolutionBit); //write 2nd bit of config to 0th bit of samples
+  return samples;
+}
+
+bool MCP9600::burstAvailable(){
+  uint8_t status = readSingleRegister(SENSOR_STATUS);
+  return (status >> 7); //return only the 7th bit where the burst complete flag is
+}
+
+bool MCP9600::startBurst(){
+  uint8_t status = readSingleRegister(SENSOR_STATUS);
+  bitWrite(status, 7, 0); //clear the 7th bit of the status register, and send over I2C
+  return writeSingleRegister(SENSOR_STATUS, status); //return whether the write was successful
+}
+
+bool MCP9600::setShutdownMode(Shutdown_Mode mode){
+  uint8_t config = readSingleRegister(DEVICE_CONFIG);
+  config = (config >> 2) << 2; //clear last two bits of the device config register
+  config |= mode;
+
+  bool failed = writeSingleRegister(DEVICE_CONFIG, config); //write new config register to MCP9600
+  failed &= (readSingleRegister(DEVICE_CONFIG) != config); //double check that it was written properly
+  return failed; //return 1 if the write failed or the register wasn't properly set, 0 otherwise
+}
+
+Shutdown_Mode MCP9600::getShutdownMode(){
+  uint8_t config = readSingleRegister(DEVICE_CONFIG);
+  return ((config << 6) >> 6); //clear all bits except the last two and return
+}
 
 /*------------------------- Internal I2C Abstraction ---------------- */
 

src/SparkFun_MCP9600.h

@@ -34,35 +34,53 @@ enum MCP9600_Register {
   HOT_JUNC_TEMP = 0x00,
   DELTA_JUNC_TEMP = 0x01,
   COLD_JUNC_TEMP = 0x02,
-  STATUS = 0x04,
+  RAW_ADC = 0x03,
+  SENSOR_STATUS = 0x04,
   THERMO_SENSOR_CONFIG = 0x05,
   DEVICE_CONFIG = 0x06,
   DEVICE_ID = 0x20,
 };
 
-enum thermocoupleType {
-  K_type = 0b000,
-  J_type = 0b001,
-  T_type = 0b010,
-  N_type = 0b011,
-  S_type = 0b100,
-  E_type = 0b101,
-  B_type = 0b110,
-  R_type = 0b111,
+enum Thermocouple_Type {
+  TYPE_K = 0b000,
+  TYPE_J = 0b001,
+  TYPE_T = 0b010,
+  TYPE_N = 0b011,
+  TYPE_S = 0b100,
+  TYPE_E = 0b101,
+  TYPE_B = 0b110,
+  TYPE_R = 0b111,
 };
 
-enum ambientResolution {
+enum Ambient_Resolution {
   RES_ZERO_POINT_0625 = 0b0,
   RES_ZERO_POINT_25 = 0b1,
 };
 
-enum thermocoupleResolution {
+enum Thermocouple_Resolution {
   RES_18_BIT = 0b00,
   RES_16_BIT = 0b01,
   RES_14_BIT = 0b10,
   RES_12_BIT = 0b11,
 };
 
+enum Burst_Sample {
+  SAMPLES_1 = 0b000,
+  SAMPLES_2 = 0b001,
+  SAMPLES_4 = 0b010,
+  SAMPLES_8 = 0b011,
+  SAMPLES_16 = 0b100,
+  SAMPLES_32 = 0b101,
+  SAMPLES_64 = 0b110,
+  SAMPLES_128 = 0b111,
+};
+
+enum Shutdown_Mode {
+  NORMAL = 0b00,
+  SHUTDOWN = 0b01,
+  BURST = 0b10,
+};
+
 class MCP9600{
   public:
 
@@ -79,18 +97,25 @@ class MCP9600{
   float thermocoupleTemp();                                         //Returns the thermocouple temperature in degrees Celcius
   float ambientTemp();                                              //Returns the ambient (IC die) temperature in degrees Celcius
   float tempDelta();                                                //Returns the difference in temperature between the thermocouple and ambient junctions, in degrees Celcius
+  signed long rawADC();                                             //Returns the raw contents of the raw ADC register
 
   //Measurement configuration
-  bool setAmbientResolution(ambientResolution res);                 //Changes the resolution on the cold (ambient) junction, for either 0.0625 or 0.25 degree C resolution. Lower resolution reduces conversion time.
-  ambientResolution getAmbientResolution();                         //Returns the resolution on the cold (ambient) junction, for either 0.0625 or 0.25 degree C resolution. Lower resolution reduces conversion time.
-  bool setThermocoupleResolution(thermocoupleResolution res);       //Changes the resolution on the hot (thermocouple) junction, for either 18, 16, 14, or 12-bit resolution. Lower resolution reduces conversion time.
-  thermocoupleResolution getThermocoupleResolution();               //Returns the resolution on the hot (thermocouple) junction, for either 18, 16, 14, or 12-bit resolution. Lower resolution reduces conversion time.
+  bool setAmbientResolution(Ambient_Resolution res);                //Changes the resolution on the cold (ambient) junction, for either 0.0625 or 0.25 degree C resolution. Lower resolution reduces conversion time.
+  Ambient_Resolution getAmbientResolution();                        //Returns the resolution on the cold (ambient) junction, for either 0.0625 or 0.25 degree C resolution. Lower resolution reduces conversion time.
+  bool setThermocoupleResolution(Thermocouple_Resolution res);      //Changes the resolution on the hot (thermocouple) junction, for either 18, 16, 14, or 12-bit resolution. Lower resolution reduces conversion time.
+  Thermocouple_Resolution getThermocoupleResolution();        //Returns the resolution on the hot (thermocouple) junction, for either 18, 16, 14, or 12-bit resolution. Lower resolution reduces conversion time.
 
-  uint8_t setThermocoupleType(thermocoupleType type);               //Changes the type of thermocouple connected to the MCP9600. Supported types are KJTNSEBR.
-  thermocoupleType getThermocoupleType();                           //Returns the type of thermocouple connected to the MCP9600 as found in its configuration register. Supported types are KJTNSEBR.
+  uint8_t setThermocoupleType(Thermocouple_Type type);              //Changes the type of thermocouple connected to the MCP9600. Supported types are KJTNSEBR.
+  Thermocouple_Type getThermocoupleType();                          //Returns the type of thermocouple connected to the MCP9600 as found in its configuration register. Supported types are KJTNSEBR.
   uint8_t setFilterCoeffecients(uint8_t coeffecient);               //Changes the weight of the on-chip exponential moving average filter. Set this to 0 for no filter, 1 for minimum filter, and 7 for maximum filter.
   uint8_t getFilterCoeffecients();                                  //Returns the weight of the on-chip exponential moving average filter.
 
+  bool setBurstSamples(Burst_Sample samples);                       //Changes the amount of samples to take in burst mode. Returns 0 if set sucessfully, 1 otherwise.
+  Burst_Sample getBurstSamples();                                   //Returns the amount of samples to take in burst mode, according to the device's configuration register.  
+  bool burstAvailable();                                            //Returns true if all the burst samples have been taken and the results are ready. Returns false otherwise.
+  bool startBurst();                                                //Initiates a burst on the MCP9600.
+  bool setShutdownMode(Shutdown_Mode mode);                         //Changes the shutdown "operating" mode of the MCP9600. Configurable to Normal, Shutdown, and Burst. Returns 0 if properly set, 1 otherwise.
+  Shutdown_Mode getShutdownMode();                                  //Returns the shutdown "operating" mode of the MCP9600. Configurable to Normal, Shutdown, and Burst.
 
   //Internal I2C Abstraction
   private: