Merge branch 'master' of https://github.com/sparkfun/SparkFun_SGP30_Arduino_Library

Author: Nathan Seidle

README.md

@@ -1,16 +1,16 @@
 SparkFun SGP30 Library
 ===========================================================
- [![SparkX SGP30 Breakout (Qwiic) (SPX-14813)](https://cdn.sparkfun.com/assets/parts/1/3/0/8/1/14813-SGP30_Breakout__Qwiic_-01.jpg)](https://www.sparkfun.com/products/14813) 
+ [![SparkFun Air Quality Sensor - SGP30 (Qwiic) (SEN-16531)](https://cdn.sparkfun.com/assets/parts/1/5/4/0/9/16531-SparkFun_Air_Quality_Sensor_-_SGP30__Qwiic_-05.jpg)](https://www.sparkfun.com/products/16531) 
 
-[*SparkX SGP30 Breakout (Qwiic) (SPX-14813)*](https://www.sparkfun.com/products/14813)
+[*SparkFun Air Quality Sensor - SGP30 (Qwiic) (SEN-16531)*](https://www.sparkfun.com/products/16531)
 
 The SGP30 is an indoor air quality sensor equipped with an I<sup>2</sup>C interface. It outputs equivalent CO<sub>2</sub> in ppm and Total Volatile Organic Compounds (TVOC) in ppb. The sensor also gives access to its raw measurement values of Ethanol and H<sub>2</sub>. 
 
 The SGP30 boasts high stability with low long term drift. With its continuous baseline compensation algorithm, readings stay accurate over time. You can even fine tune your readings by interfacing with an external humidity sensor to add humidity compensation.
 While the CCS811 requires a burn-in of 48 hours and a run-in of 20 minutes the SGP30 is ready to go after just 15 seconds.
 
 SparkFun labored with love to create this code. Feel like supporting open source hardware? 
-Buy a [board](https://www.sparkfun.com/products/14813) from SparkFun!
+Buy a [board](https://www.sparkfun.com/products/16531) from SparkFun!
 
 Shout outs to all those folks that have helped make this library better:
 
@@ -29,7 +29,14 @@ Documentation
 --------------
 
 * **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
-* **[Product Repository](https://github.com/sparkfunX/Qwiic-SGP30-Breakout)** - Main repository (including hardware files)
+* **[Product Repository](https://github.com/sparkfun/SparkFun_Air_Quality_Sensor-SGP30)** - Main repository (including hardware files)
+* **[SGP30 Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-air-quality-sensor---sgp30-qwiic-hookup-guide)** - A short hookup guide to get started with the SparkFun Air Quality Sensor - SGP30 (Qwiic)
+
+Products that use this library
+--------------
+* [SEN-16531](https://www.sparkfun.com/products/16531)- SparkFun Version 1.0
+* [SPX-14813](https://www.sparkfun.com/products/14813)- SparkX Version
+
 
 License Information
 -------------------

examples/Example3_Humidity/Example3_Humidity.ino

@@ -15,11 +15,11 @@
 */
 
 #include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
-#include "SparkFun_Si7021_Breakout_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_Si7021
+#include "SparkFun_SHTC3.h" // Click here to get the library: http://librarymanager/All#SparkFun_SHTC3
 #include <Wire.h>
 
 SGP30 mySensor; //create an instance of the SGP30 class
-Weather hSensor; //create an instance of the Weather class
+SHTC3 humiditySensor; //create an instance of the SHTC3 class
 long t1, t2;
 
 byte count = 0;
@@ -35,13 +35,15 @@ void setup() {
   }
 
   //Initialize the humidity sensor and ping it
-  hSensor.begin();
+  humiditySensor.begin();
+  // Call "update()" to command a measurement, wait for measurement to complete, and update the RH and T members of the object 
+  SHTC3_Status_TypeDef result = humiditySensor.update();
+  delay(190);  
+  // Measure Relative Humidity from the SHTC3
+  float humidity = humiditySensor.toPercent();
 
-  // Measure Relative Humidity from the Si7021
-  float humidity = hSensor.getRH();
-
-  //Measure temperature (in C) from the Si7021
-  float temperature = hSensor.getTemp();
+  //Measure temperature (in C) from the SHTC3
+  float temperature = humiditySensor.toDegC();
 
   //Convert relative humidity to absolute humidity
   double absHumidity = RHtoAbsolute(humidity, temperature);
@@ -56,6 +58,10 @@ void setup() {
   //Set the humidity compensation on the SGP30 to the measured value
   //If no humidity sensor attached, sensHumidity should be 0 and sensor will use default
   mySensor.setHumidity(sensHumidity);
+  Serial.print("Absolute humidity compensation set to: ");
+  Serial.print(absHumidity);
+  Serial.println("g/m^3 ");
+  delay(100);
   t1 = millis();
 }
 
@@ -72,6 +78,34 @@ void loop() {
     Serial.print(mySensor.TVOC);
     Serial.println(" ppb");
   }
+  if (Serial.available()) //check if new data is available on serial port
+  {
+    char ch = Serial.read(); 
+    if (ch == 'h' || ch == 'H') //check if the char input matches either "h" or "H" and if it does, run the compensation routine from the setup
+    {
+      SHTC3_Status_TypeDef result = humiditySensor.update();
+      delay(190);  
+      // Measure Relative Humidity from the SHTC3
+      float humidity = humiditySensor.toPercent();
+    
+      //Measure temperature (in C) from the SHTC3
+      float temperature = humiditySensor.toDegC();
+    
+      //Convert relative humidity to absolute humidity
+      double absHumidity = RHtoAbsolute(humidity, temperature);
+    
+      //Convert the double type humidity to a fixed point 8.8bit number
+      uint16_t sensHumidity = doubleToFixedPoint(absHumidity);
+    
+      //Set the humidity compensation on the SGP30 to the measured value
+      //If no humidity sensor attached, sensHumidity should be 0 and sensor will use default
+      mySensor.setHumidity(sensHumidity);
+      Serial.print("Absolute Humidity Compensation set to: ");
+      Serial.print(absHumidity);
+      Serial.println("g/m^3 ");
+      delay(100);      
+    }
+  }
 }
 
 double RHtoAbsolute (float relHumidity, float tempC) {

library.properties

@@ -1,5 +1,5 @@
 name=SparkFun SGP30 Arduino Library
-version=1.0.2
+version=1.0.3
 author=SparkFun Electronics
 maintainer=SparkFun Electronics
 sentence=Library for the Sensirion SGP30 air quality sensor