Reworked some examples, made I2C abstraction functions public class members

Author: FischerMoseley

examples/Example2_SetThermocoupleType/Example2_SetThermocoupleType.ino

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

examples/Example6_ConfigureTemperatureAlert/Example6_ConfigureTemperatureAlert.ino

@@ -26,7 +26,7 @@ uint8_t risingAlert = 1; //What alert to use for detecting cold -> hot transitio
 uint8_t fallingAlert = 3; //What alert to use for detecting hot -> cold transitions.
                           //These numbers are arbitrary and can be anything from 1 to 4, but just can't be equal!
 
-float alertTemp = 25.5;  //What temperature to trigger the alert at (before hysteresis).
+float alertTemp = 29.5;  //What temperature to trigger the alert at (before hysteresis).
                         //This is about the surface temperature of my finger, but please change this if 
                         //you have colder/warmer hands or if the ambient temperature is different.
 uint8_t hysteresis = 2; //How much hysteresis to have, in degrees Celcius. Feel free to adjust this, but 2°C seems to be about right.
@@ -53,48 +53,71 @@ void setup(){
     while(1); //hang forever
   }
 
-  //configure the temperature alert for when the thermocouple is touched
-  tempSensor.configAlertEnable(risingAlert, 0); //disable the alert (if it was already enabled) while we configure it
+  tempSensor.configAlertHysteresis(risingAlert, hysteresis);
   tempSensor.configAlertTemp(risingAlert, alertTemp);
   tempSensor.configAlertJunction(risingAlert, 0);
-  tempSensor.configAlertHysteresis(risingAlert, hysteresis);
   tempSensor.configAlertEdge(risingAlert, HIGH);
   tempSensor.configAlertLogicLevel(risingAlert, HIGH);
   tempSensor.configAlertMode(risingAlert, 1);
-  tempSensor.configAlertEnable(risingAlert, 1); //enable the alert!
+  tempSensor.configAlertEnable(risingAlert, true);
 
-  //configure the temperature alert for when the thermocouple is released!
-  tempSensor.configAlertEnable(fallingAlert, 0); //disable the alert (if it was already enabled) while we configure it
+  tempSensor.configAlertHysteresis(fallingAlert, hysteresis);
   tempSensor.configAlertTemp(fallingAlert, alertTemp);
   tempSensor.configAlertJunction(fallingAlert, 0);
-  tempSensor.configAlertHysteresis(fallingAlert, hysteresis);
   tempSensor.configAlertEdge(fallingAlert, HIGH);
   tempSensor.configAlertLogicLevel(fallingAlert, HIGH);
   tempSensor.configAlertMode(fallingAlert, 1);
-  tempSensor.configAlertEnable(fallingAlert, 1); //enable the alert!
+  tempSensor.configAlertEnable(fallingAlert, true);
+
+  Serial.print("alert 1 hysteresis: ");
+  Serial.println(tempSensor.readSingleRegister(ALERT1_HYSTERESIS), BIN);
+  Serial.print("alert 1 limit: ");
+  Serial.println(tempSensor.readDoubleRegister(ALERT1_LIMIT), BIN);
+  Serial.print("alert 1 config: ");
+  Serial.println(tempSensor.readSingleRegister(ALERT1_CONFIG), BIN);
+
+  Serial.print("alert 3 hysteresis: ");
+  Serial.println(tempSensor.readSingleRegister(ALERT3_HYSTERESIS), BIN);
+  Serial.print("alert 3 limit: ");
+  Serial.println(tempSensor.readDoubleRegister(ALERT3_LIMIT), BIN);
+  Serial.print("alert 3 config: ");
+  Serial.println(tempSensor.readSingleRegister(ALERT3_CONFIG), BIN);
 }
 
 unsigned long clock = millis();
 uint16_t updateTime = 200;
 void loop(){
-  if(clock < (millis() + updateTime)){
+  if((clock + updateTime) < millis()){
     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");
+
+    if(tempSensor.isTempGreaterThanLimit(risingAlert)){
+      Serial.print(" Temperature exceeds limit 1!");
+    }
+
+    if(tempSensor.isTempGreaterThanLimit(fallingAlert)){
+      Serial.print(" Temperature exeeds limit 3!");
+    }
+
     Serial.println(); 
+    clock = millis();
   }
 
-  if(tempSensor.isAlertTriggered(risingAlert)){
-    Serial.println("Thermocouple has been touched!");
-    tempSensor.clearAlert(risingAlert);
-  }
+  if(Serial.available()){
+    byte foo = Serial.read();
+    if(foo == '1'){
+      Serial.print("clearing alert 1: ");
+      Serial.println(tempSensor.clearAlertPin(1));
+    }
 
-  if(tempSensor.isAlertTriggered(fallingAlert)){
-    Serial.println("Thermocouple has been released!");
-    tempSensor.clearAlert(fallingAlert);
+    if(foo == '3'){
+      Serial.print("clearing alert 3: ");
+      Serial.println(tempSensor.clearAlertPin(3));
+    }
   }
 }

src/SparkFun_MCP9600.cpp

@@ -260,9 +260,7 @@ bool MCP9600::configAlertTemp(uint8_t number, float temp){
   if(temp < 0) signedTempLimit *= -1; //if the original temp limit was negative we shifted away the sign bit, so reapply it if necessary
 
   //write the new temp limit to the MCP9600, return if it was successful
-  bool failed = writeSingleRegister(tempLimitRegister, highByte(signedTempLimit));
-  failed |= writeSingleRegister(tempLimitRegister + 0x01, lowByte(signedTempLimit));
-  return failed;
+  return writeDoubleRegister(tempLimitRegister, signedTempLimit);
 }
 
 bool MCP9600::configAlertJunction(uint8_t number, bool junction){
@@ -419,7 +417,7 @@ bool MCP9600::configAlertEnable(uint8_t number, bool enable){
   return writeSingleRegister(alertConfigRegister, config);
 }
 
-bool MCP9600::clearAlert(uint8_t number){
+bool MCP9600::clearAlertPin(uint8_t number){
   MCP9600_Register alertConfigRegister; //pick the register we need to use
   switch (number) {
   case 1:
@@ -448,14 +446,28 @@ bool MCP9600::clearAlert(uint8_t number){
 
   //write the new register to the MCP9600, return if it was successful
   return writeSingleRegister(alertConfigRegister, alertConfig);
-    
 }
 
-bool MCP9600::isAlertTriggered(uint8_t number){
+bool MCP9600::isTempGreaterThanLimit(uint8_t number){
   if(number > 4) return; //if a nonexistent alert number is given, return with nothing
   uint8_t status = readSingleRegister(SENSOR_STATUS);
-
-  return bitRead(status, number - 0x01);
+  switch (number){
+  case 1:
+    return bitRead(status, 0);
+    break;
+  case 2:
+    return bitRead(status, 1);
+    break;
+  case 3:
+    return bitRead(status, 2);
+    break;
+  case 4:
+    return bitRead(status, 3);
+    break;
+  default:
+    return;
+    break;
+  }
 }
 
 
@@ -493,4 +505,12 @@ bool MCP9600::writeSingleRegister(MCP9600_Register reg, uint8_t data){
   _i2cPort->write(reg);
   _i2cPort->write(data);
   return (_i2cPort->endTransmission() != 0);
+}
+
+bool MCP9600::writeDoubleRegister(MCP9600_Register reg, uint16_t data){
+  _i2cPort->beginTransmission(_deviceAddress);
+  _i2cPort->write(reg);
+  _i2cPort->write(highByte(data));
+  _i2cPort->write(lowByte(data));
+  return (_i2cPort->endTransmission() != 0);
 }

src/SparkFun_MCP9600.h

@@ -139,15 +139,20 @@ class MCP9600{
   bool configAlertLogicLevel(uint8_t number, bool level);           //Configures whether the hardware alert pin is active-high or active-low. Set to 1 for active-high, 0 for active-low.
   bool configAlertMode(uint8_t number, bool mode);                  //Configures whether the MCP9600 treats the alert like a comparator or an interrrupt. Set to 1 for interrupt, 0 for comparator. More information is on pg. 34 of the datasheet.
   bool configAlertEnable(uint8_t number, bool enable);              //Configures whether or not the interrupt is enabled or not. Set to 1 to enable, or 0 to disable.
-  bool clearAlert(uint8_t number);                                  //Clears the interrupt bit on the specified alert channel               
-  bool isAlertTriggered(uint8_t number);                            //Returns true if the interrupt has been triggered, false otherwise
+  bool clearAlertPin(uint8_t number);                               //Clears the interrupt on the specified alert channel, resetting the value of the pin.           
+  bool isTempGreaterThanLimit(uint8_t number);                      //Returns true if the interrupt has been triggered, false otherwise
 
+
+  //debug
+  uint8_t readSingleRegister(MCP9600_Register reg);                 //Attempts to read a single register, will keep trying for retryAttempts amount of times
+  uint16_t readDoubleRegister(MCP9600_Register reg);                //Attempts to read two registers, will keep trying for retryAttempts amount of times
+  bool writeSingleRegister(MCP9600_Register reg, uint8_t data);     //Attempts to write data into a single 8-bit register. Does not check to make sure it was written successfully. Returns 0 if there wasn't an error on I2C transmission, and 1 otherwise.
+  bool writeDoubleRegister(MCP9600_Register reg, uint16_t data);    //Attempts to write data into a double (two 8-bit) registers. Does not check to make sure it was written successfully. Returns 0 if there wasn't an error on I2C transmission, and 1 otherwise.
+ 
+ 
   //Internal I2C Abstraction
   private:
   TwoWire *_i2cPort;                                                //Generic connection to user's chosen I2C port
   uint8_t _deviceAddress;                                           //I2C address of the MCP9600
-  uint8_t readSingleRegister(MCP9600_Register reg);                 //Attempts to read a single register, will keep trying for retryAttempts amount of times
-  uint16_t readDoubleRegister(MCP9600_Register reg);                //Attempts to read two registers, will keep trying for retryAttempts amount of times
-  bool writeSingleRegister(MCP9600_Register reg, uint8_t data);     //Attempts to write data into a single 8-bit register. Does not check to make sure it was written successfully.
 };
 #endif