Merge pull request #2 from sparkfun/development-2

Development 2 Branch merge to Main post Code Review

Author: MadisonC-SparkFun

Examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -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
 -------------------

README.md

@@ -0,0 +1,70 @@
+#include "SparkFun_STHS34PF80_Arduino_Library.h"
+#include <Wire.h>
+
+STHS34PF80_I2C mySensor;
+
+// Values to fill with presence and motion data
+int16_t presenceVal = 0;
+int16_t motionVal = 0;
+float temperatureVal = 0;
+
+
+void setup()
+{
+    Serial.begin(115200);
+    Serial.println("STHS34PF80 Example 1: Basic Readings");
+
+    // Begin I2C
+    if(Wire.begin() == 0)
+    {
+      Serial.println("I2C Error - check I2C Address");
+      while(1);
+    }
+
+    // Establish communication with device 
+    if(mySensor.begin() != 0)
+    {
+      Serial.println("Error setting up device - please check wiring.");
+      while(1);
+    }
+
+    delay(1000);
+}
+
+void loop()
+{
+  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);
+    
+    // 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");
+    }
+
+    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/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -2,69 +2,80 @@
 #include <Wire.h>
 
 STHS34PF80_I2C mySensor;
-// STHS34PF80_SPI mySensor; 
 
-// Values to fill with presence and motion data
+// Values to fill with presence data
 int16_t presenceVal = 0;
-int16_t motionVal = 0;
 
 // Change the pin number to the pin that has been chosen for your setup
 int intPin = 12;
 
-sths34pf80_tmos_route_int_t interruptRoute = STHS34PF80_TMOS_INT_DRDY;
+// Star the flag as false
+bool volatile interruptFlag = false;
 
+// ISR to set the triggered interrupt
+void isr1()
+{
+  interruptFlag = true;
+}
 
 void setup()
 {
     Serial.begin(115200);
     Serial.println("STHS34PF80 Example 2: Interrupts");
 
-    // Begin I2C transactions
-    Wire.begin();
-
-    // Checks established connection
-    if(mySensor.begin() == false)
+    // Begin I2C
+    if(Wire.begin() == 0)
     {
-      Serial.println("Error"); // fix this print message
+      Serial.println("I2C Error - check I2C Address");
       while(1);
     }
 
-    // Data Ready signal routed to the INT pin
-    mySensor.setTmosRouteInterrupt(interruptRoute);
-
-    // **FINISH READING INTERRUPT SECTION TO MAKE SURE NO MORE IS NEEDED**
+    // Establish communication with device 
+    if(mySensor.begin() != 0)
+    {
+      Serial.println("Error setting up device - please check wiring.");
+      while(1);
+    }
 
     // Set INT pin to be triggered on rising and falling edges of INT pin
     pinMode(intPin, INPUT);
+    // Attach interrupt to the pin as a digital pin that triggers on a change
+    attachInterrupt(digitalPinToInterrupt(intPin), isr1, CHANGE);
+
+    // Route all interrupts from device to interrupt pin
+    mySensor.setTmosRouteInterrupt(STHS34PF80_TMOS_INT_OR);
+
+    // Enable the presence interrupt source 
+    // (see page 17 of application note AN5867 for more information)
+    mySensor.setTmosInterruptOR(STHS34PF80_TMOS_INT_PRESENCE);
+
+    // Set interrupt value to pulsed on the INT pin
+    mySensor.setInterruptPulsed(0);
 
-    delay(1000);
+    delay(500);
 }
 
 void loop() 
 {
-
-  // Value to read interrupt pin status
-  int interruptVal = digitalRead(intPin);
-    
-  if(interruptVal == HIGH)
+  // If interrupt is triggered
+  if(interruptFlag == true)
   {
-    sths34pf80_tmos_func_status_t status = mySensor.getStatus();
+    interruptFlag = false;
+    
+    sths34pf80_tmos_func_status_t status;
+    mySensor.getStatus(&status);
+    
+    Serial.println("Data ready!");
+    
 
     // If the flag is high, then read out the information
     if(status.pres_flag == 1)
     {
       // Presence Units: cm^-1
       mySensor.getPresenceValue(&presenceVal);
       Serial.print("Presence: ");
-      Serial.println(presenceVal);
-    }
-
-    if(status.mot_flag == 1)
-    {
-      mySensor.getMotionValue(&motionVal);
-      Serial.print("Motion: ");
-      Serial.println(motionVal);
+      Serial.print(presenceVal);
+      Serial.println("cm^-1");
     }
   }
-
-}
+}