Final changes from code review before PR into main branch

For more finite details, see code review document for changes made. Mostly final small tweaks to the code; updated README file

Author: MadisonC-SparkFun

README.md

@@ -1,41 +1,34 @@
-SparkFun <PRODUCT NAME>
+SparkFun STHS34PF80 Arduino Library
 ========================================
 
-[![SparkFun Part Name](URL for picture of part)](URL for product on Sparkfun.com)
 
-[*SparkFun Part Name (SKU)*](URL for product on Sparkfun.com)
-
-<Basic description of the part.>
+This is the SparkFun library for the STMicroelectronics STHS34PF80 IR sensor with an operating wavelength between 5 µm and 20 µm with I<sup>2</sup>C and SPI interface. (https://www.sparkfun.com/products/22494). 
 
 Repository Contents
 -------------------
 
-* **/Documentation** - Data sheets, additional product information
-* **/Enclosure** - Enclosure files 
-* **/Firmware** - Example code 
-* **/Hardware** - Eagle design files (.brd, .sch)
-* **/Libraries** - Libraries for use with the <PRODUCT NAME>
-* **/Production** - Production panel files (.brd)
-* **/Software** - Related software for the <PRODUCT NAME>
+* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
+* **/src** - Source files for the library (.cpp, .h).
+* **/Documentation** - Datasheet and application note for the STHS34PF80.
+* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
+* **library.properties** - General library properties for the Arduino package manager.
+* **[CONTRIBUTING.md](./CONTRIBUTING.md)** - guidance on how to contribute to this library.
+
 
 Documentation
 --------------
-* **[Library](GitHub library URL)** - <LANGUAGE> library for the <PRODUCT NAME>.
-* **[Hookup Guide](Learn.SparkFun URL)** - Basic hookup guide for the <PRODUCT NAME>.
-* **[SparkFun Fritzing repo](https://github.com/sparkfun/Fritzing_Parts)** - Fritzing diagrams for SparkFun products.
-* **[SparkFun 3D Model repo](https://github.com/sparkfun/3D_Models)** - 3D models of SparkFun products. 
-* **[SparkFun Graphical Datasheets](https://github.com/sparkfun/Graphical_Datasheets)** -Graphical Datasheets for various SparkFun products.
-
-Product Versions
-----------------
-* [Part SKU](part URL) - Basic part and short description here
-* [Retail part SKU](retail URL) - Retail packaging of standard description here
-* [Any other parts this repo covers](any other URLs) - Description of said parts
-
-Version History
----------------
-* [vExxFxxZxxHxxLxxSxx](URL for tag specific to this version) - Description 
-* [vEyyFyyZyyHyyLyySyy](URL for tag specific to this version) - Description
+
+* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
+* **[Hookup Guide](https://docs.sparkfun.com/SparkFun_IoT_Brushless_Motor_Driver)** - Basic hookup guide for the SparkFun IoT Motor Driver Breakout (ESP32, TMC6300).
+* **[Product Repository](https://github.com/sparkfun/SparkFun_IoT_Brushless_Motor_Driver)** - Main repository for the IoT Motor Driver (including hardware files)
+
+
+Products that use this Library 
+---------------------------------
+
+* [*SEN-22494*](https://www.sparkfun.com/products/22494)
+* [*SEN-23253*](https://www.sparkfun.com/products/23253)
+
 
 License Information
 -------------------

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -6,6 +6,7 @@ STHS34PF80_I2C mySensor;
 // Values to fill with presence and motion data
 int16_t presenceVal = 0;
 int16_t motionVal = 0;
+float temperatureVal = 0;
 
 
 void setup()
@@ -47,13 +48,22 @@ void loop()
       // Presence Units: cm^-1
       mySensor.getPresenceValue(&presenceVal);
       Serial.print("Presence: ");
-      Serial.println(presenceVal);
+      Serial.print(presenceVal);
+      Serial.println(" cm^-1");
     }
 
     if(status.mot_flag == 1)
     {
       Serial.println("Motion Detected!");
     }
+
+    if(status.tamb_shock_flag == 1)
+    {
+      mySensor.getTemperatureData(&temperatureVal);
+      Serial.print("Temperature: ");
+      Serial.print(temperatureVal);
+      Serial.println(" °C");
+    }
   }
 
 }

examples/Example2_Interrupts/Example2_Interrupts.ino

@@ -31,9 +31,9 @@ void setup()
     }
 
     // Establish communication with device 
-    if(mySensor.begin() != 0)
+    if(mySensor.begin() == false)
     {
-      Serial.println("Sensor failed to begin - Check wiring.");
+      Serial.println("Error setting up device - please check wiring.");
       while(1);
     }
 

examples/Example3_EmbeddedFunctions/Example3_EmbeddedFunctions.ino

@@ -13,7 +13,7 @@ uint8_t hysteresis = 100;
 void setup()
 {
     Serial.begin(115200);
-    Serial.println("STHS34PF80 Example 3: Using Embedded Functions");
+    Serial.println("STHS34PF80 Example 1: Basic Readings");
 
     // Begin I2C
     if(Wire.begin() == false)
@@ -23,9 +23,9 @@ void setup()
     }
 
     // Establish communication with device 
-    if(mySensor.begin() != 0)
+    if(mySensor.begin() == false)
     {
-      Serial.println("Sensor failed to begin - Check wiring.");
+      Serial.println("Error setting up device - please check wiring.");
       while(1);
     }
 
@@ -57,10 +57,12 @@ void setup()
 
 void loop() 
 {
-    // General presence and motion read (from example 1)
-  bool dataReady = mySensor.getDataReady();
-    
-  if(dataReady == 1)
+  // General presence and motion read (from example 1)
+  sths34pf80_tmos_drdy_status_t dataReady;
+  mySensor.getDataReady(&dataReady);
+
+  // Check whether sensor has new data - run through loop if data is ready
+  if(dataReady.drdy == 1)
   {
     sths34pf80_tmos_func_status_t status;
     mySensor.getStatus(&status);

examples/Example4_SPIFunctionality/Example4_SPIFunctionality.ino

@@ -19,11 +19,18 @@ void setup()
 	  digitalWrite(chipSelect, HIGH);
 
     // Begin SPI
-    if( !mySensor.begin(chipSelect) )
+    if(SPI.begin() == false)
     {
-		  Serial.println("Sensor failed to begin - Check wiring.");
-	    while(1);
-	  }
+      Serial.println("SPI Error - check SPI Wiring");
+      while(1);
+    }
+
+    // Establish communication with device 
+    if(mySensor.begin(chipSelect) == false)
+    {
+      Serial.println("Error setting up device - please check wiring.");
+      while(1);
+    }
 
     // Set the ODR to a faster rate for quicker outputs
     // Default ODR: 1Hz
@@ -34,35 +41,36 @@ void setup()
 
 void loop() 
 {
-  bool dataReady = mySensor.getDataReady();
-    
-  // Check if the presence (data ready) flag is high. If so, print the presence value
-  if(dataReady == 1)
+  sths34pf80_tmos_drdy_status_t dataReady;
+  mySensor.getDataReady(&dataReady);
+
+  // Check whether sensor has new data - run through loop if data is ready
+  if(dataReady.drdy == 1)
   {
     sths34pf80_tmos_func_status_t status;
     mySensor.getStatus(&status);
 
-    Serial.println("Data ready!");
-    
-    // If the flag is high, then read out the information
+    // If presence flag is high, then print data
     if(status.pres_flag == 1)
     {
       // Presence Units: cm^-1
       mySensor.getPresenceValue(&presenceVal);
       Serial.print("Presence: ");
       Serial.print(presenceVal);
-      Serial.println("cm^-1");
+      Serial.println(" cm^-1");
     }
 
-    // Motion detected or not
     if(status.mot_flag == 1)
     {
-      Serial.println("Motion detected! ");
+      Serial.println("Motion Detected!");
     }
 
     if(status.tamb_shock_flag == 1)
     {
-      Serial.println("Ambient temperature shock detected! ");
+      mySensor.getTemperatureData(&temperatureVal);
+      Serial.print("Temperature: ");
+      Serial.print(temperatureVal);
+      Serial.println(" °C");
     }
   }
 }

examples/Example5_ArduinoPlotterOutput/Example5_ArduinoPlotterOutput.ino

@@ -9,7 +9,7 @@ int16_t presenceVal = 0;
 void setup()
 {
     Serial.begin(115200);
-    Serial.println("STHS34PF80 Example 5: Arduino Serial Plotter Presence Output");
+    Serial.println("STHS34PF80 Example 1: Basic Readings");
 
     // Begin I2C
     if(Wire.begin() == false)
@@ -19,9 +19,9 @@ void setup()
     }
 
     // Establish communication with device 
-    if(mySensor.begin() != 0)
+    if(mySensor.begin() == false)
     {
-      Serial.println("Sensor failed to begin - Check wiring.");
+      Serial.println("Error setting up device - please check wiring.");
       while(1);
     }
 
@@ -32,10 +32,11 @@ void setup()
 
 void loop()
 {
+  sths34pf80_tmos_drdy_status_t dataReady;
+  mySensor.getDataReady(&dataReady);
 
-  bool dataReady = mySensor.getDataReady();
-    
-  if(dataReady == 1)
+  // Check whether sensor has new data - run through loop if data is ready
+  if(dataReady.drdy == 1)
   {
     sths34pf80_tmos_func_status_t status;
     mySensor.getStatus(&status);