Changes from code review

See code review comments doc for more details

Author: MadisonC-SparkFun

Examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -32,10 +32,11 @@ void setup()
 
 void loop()
 {
-  bool dataReady =  mySensor.getDataReady();
-    
+  sths34pf80_tmos_drdy_status_t dataReady;
+  mySensor.getDataReady(&dataReady);
+
   // Check whether sensor has new data - run through loop if data is ready
-  if(dataReady == 1)
+  if(dataReady.drdy == 1)
   {
     sths34pf80_tmos_func_status_t status;
     mySensor.getStatus(&status);
@@ -57,63 +58,3 @@ void loop()
 
 }
 
-
-
-
-
-
-
-// #include "SparkFun_STHS34PF80_Arduino_Library.h"
-// #include <Wire.h>
-
-// STHS34PF80_I2C mySensor;
-
-// // Global Presence Value
-// int16_t presenceVal = 0;
-
-// void setup()
-// {
-//     Serial.begin(115200);
-//     Serial.println("STHS34PF80 Example 5: Arduino Serial Plotter Presence Output");
-
-//     // Begin I2C
-//     if(Wire.begin() == false)
-//     {
-//       Serial.println("I2C Error - check I2C Address");
-//       while(1);
-//     }
-
-//     // Establish communication with device 
-//     if(mySensor.begin() != 0)
-//     {
-//       Serial.println("Sensor failed to begin - Check wiring.");
-//       while(1);
-//     }
-
-//     Serial.println("Open the Serial Plotter for graphical viewing");
-
-//     // Default ODR: 1Hz
-
-//     delay(1000);
-// }
-
-// void loop()
-// {
-
-//   bool dataReady = mySensor.getDataReady();
-    
-//   if(dataReady == 1)
-//   {
-//     sths34pf80_tmos_func_status_t status;
-//     mySensor.getStatus(&status);
-    
-    
-//     // If the flag is high, then read out the information
-//     if(status.pres_flag == 1)
-//     {
-//       mySensor.getPresenceValue(&presenceVal);
-//       Serial.println(presenceVal);
-//     }
-//   }
-      
-// }

examples/Example2_Interrupts/Example2_Interrupts.ino

@@ -20,7 +20,6 @@ void isr1()
 
 void setup()
 {
-    // Begin I2C transactions
     Serial.begin(115200);
     Serial.println("STHS34PF80 Example 2: Interrupts");
 

examples/Example5_ArduinoPlotterOutput/Example5_ArduinoPlotterOutput.ino

@@ -27,8 +27,6 @@ void setup()
 
     Serial.println("Open the Serial Plotter for graphical viewing");
 
-    // Default ODR: 1Hz
-
     delay(1000);
 }
 

src/SparkFun_STHS34PF80_Arduino_Library.cpp

@@ -1,6 +1,6 @@
 #include "SparkFun_STHS34PF80_Arduino_Library.h"
 
-int32_t STHS34PF80_I2C::begin(uint8_t devAddr)
+int32_t STHS34PF80_I2C::begin(uint8_t devAddr, TwoWire& wirePort)
 {
     bus.init(devAddr, Wire);
     sensor.read_reg = STHS34PF80_I2C::read;

src/SparkFun_STHS34PF80_Arduino_Library.h

@@ -28,7 +28,7 @@ Distributed as-is; no warranty is given.
 class STHS34PF80_I2C : public STHS34PF80
 {
     public: 
-        int32_t begin(uint8_t devAddr = STHS34PF80_I2C_ADD >> 1);
+        int32_t begin(uint8_t devAddr = STHS34PF80_I2C_ADD >> 1, TwoWire& wirePort = Wire);
         static int32_t read(void *, uint8_t, uint8_t *, uint16_t);
         static int32_t write(void *, uint8_t, const uint8_t *, uint16_t);
         static void delayMS(uint32_t millisec);

src/sths34pf80_class.cpp

@@ -26,8 +26,8 @@ int32_t STHS34PF80::begin()
     // Set ambient temperature average (AVG_TAMB = 8)
     int32_t tAmbErr = setAverageTAmbientNumber(STHS34PF80_AVG_T_8);
 
-    // Block data rate update (BDU) to 1Hz
-    int32_t blockErr = setBlockDataUpdate(STHS34PF80_TMOS_ODR_AT_1Hz);
+    // Set block data rate update to true
+    int32_t blockErr = setBlockDataUpdate(true);
 
     // Set the data rate (ODR) to 1Hz
     int32_t odrErr = setTmosODR(STHS34PF80_TMOS_ODR_AT_1Hz);
@@ -71,13 +71,9 @@ int32_t STHS34PF80::isConnected()
 
 /// @brief Checks to see if the data ready flag is high
 /// @return Data ready code (0 for not ready, 1 for ready)
-bool STHS34PF80::getDataReady()
+int32_t STHS34PF80::getDataReady(sths34pf80_tmos_drdy_status_t *drdy)
 {
-    sths34pf80_tmos_drdy_status_t dataReady;
-
-    sths34pf80_tmos_drdy_status_get(&sensor, &dataReady);
-
-    return dataReady.drdy;
+    return sths34pf80_tmos_drdy_status_get(&sensor, drdy);
 }
 
 /// @brief This function checks the status of the of the device if
@@ -146,7 +142,7 @@ int32_t STHS34PF80::getTemperatureData(float *tempVal)
     int32_t retVal = sths34pf80_tobject_raw_get(&sensor, &tempValFill);
 
     // Divide the raw value by the sensitivity
-    *tempVal = tempValFill / sensitivity;
+    *tempVal = (float)tempValFill / sensitivity;
 
     return retVal;
 }
@@ -231,7 +227,7 @@ int32_t STHS34PF80::getTmosSensitivity(float *sense)
     uint16_t res1 = 2048;
     float res2 = 16;
 
-    *sense = (senseFill - res1) / res2;
+    *sense = (float)(senseFill - res1) / res2;
     return err;
 }
 
@@ -292,17 +288,17 @@ int32_t STHS34PF80::setTmosODR(sths34pf80_tmos_odr_t val)
 ///  for output registers TOBJECT (26h - 27h) and TAMBIENT (28h - 29h).
 /// @param val Block data update bit (0 disabled, 1 enabled), -1 for error
 /// @return Error code (0 no error)
-int32_t STHS34PF80::getBlockDataUpdate(uint8_t *val)
+int32_t STHS34PF80::getBlockDataUpdate(bool *val)
 {
-    return sths34pf80_block_data_update_get(&sensor, val);
+    return sths34pf80_block_data_update_get(&sensor, (uint8_t*)val);
 }
 
 /// @brief This function sets the block data update feature
 ///  for output registeres TOBJECT (26h - 27h) and TAMBIENT (28h - 29h).
 ///  Block data update bit (0 disabled, 1 enabled)
 /// @param val Value to set the block data update bit
 /// @return Error code (0 no error)
-int32_t STHS34PF80::setBlockDataUpdate(uint8_t val)
+int32_t STHS34PF80::setBlockDataUpdate(bool val)
 {
     return sths34pf80_block_data_update_set(&sensor, val);
 }

src/sths34pf80_class.h

@@ -9,7 +9,7 @@ class STHS34PF80
     public:
         int32_t begin(); // Resets the device and sets the values needed for sensor use
         int32_t isConnected(); // Determines connection to device
-        bool getDataReady(); // Returns if the data is ready to be read or not
+        int32_t getDataReady(sths34pf80_tmos_drdy_status_t *drdy); // Returns if the data is ready to be read or not
         int32_t getStatus(sths34pf80_tmos_func_status_t *statusVal); // Returns the status of the device
         int32_t reset(); // Set the boot bit, wait 3ms (as per the datasheet), then resets the algorithm
 
@@ -34,8 +34,8 @@ class STHS34PF80
         int32_t getTmosODR(sths34pf80_tmos_odr_t *val); // Returns the block data update feature for output registers
         int32_t setTmosODR(sths34pf80_tmos_odr_t val); // Sets the block data update feature
 
-        int32_t getBlockDataUpdate(uint8_t *val); // Enables the block data update feature 
-        int32_t setBlockDataUpdate(uint8_t val); // Sets the block data
+        int32_t getBlockDataUpdate(bool *val); // Enables the block data update feature 
+        int32_t setBlockDataUpdate(bool val); // Sets the block data
 
         int32_t getTmosOneShot(sths34pf80_tmos_one_shot_t *val); // Returns the state of the trigger one-shot acquisition
         int32_t setTmosOneShot(sths34pf80_tmos_one_shot_t val); // Sets the trigger one-shot acquisiton