minor edits

name change
removed blocking delay from examples 2+
changed library to use fixed delay while waiting for sensor to measure
changed begin function to bool
updated keywords
added issue template

Author: ciarajekel

ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+### Subject of the issue
+Describe your issue here.
+
+### Your workbench
+* What platform are you using?
+* What version of the device are you using? Is there a firmware version?
+* How is the device wired to your platform?
+* How is everything being powered?
+* Are there any additional details that may help us help you?
+
+### Steps to reproduce
+Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue to a gist.
+
+### Expected behaviour
+Tell us what should happen
+
+### Actual behaviour
+Tell us what happens instead

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -13,7 +13,7 @@
   This example reads the sensors calculated CO2 and TVOC values
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
+#include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
 #include <Wire.h>
 
 SGP30 mySensor; //create an object of the SGP30 class
@@ -22,7 +22,7 @@ void setup() {
   Serial.begin(9600);
   Wire.begin();
   //Initialize sensor
-  if (mySensor.begin() != SUCCESS) {
+  if (mySensor.begin() == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }

examples/Example2_RawSignals/Example2_RawSignals.ino

@@ -14,41 +14,45 @@
   TVOC values  and the raw values for H2 and ethanol.
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
+#include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
 #include <Wire.h>
 
 SGP30 mySensor; //create an object of the SGP30 class
-
+long t1, t2;
 void setup() {
   Serial.begin(9600);
   Wire.begin();
   //Sensor supports I2C speeds up to 400kHz
   Wire.setClock(400000);
   //Initialize sensor
-  if (mySensor.begin() != SUCCESS) {
+  if (mySensor.begin() == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }
   //Initializes sensor for air quality readings
   mySensor.initAirQuality();
-
+  t1 = millis();
 }
 
 void loop() {
   //First fifteen readings will be
   //CO2: 400 ppm  TVOC: 0 ppb
-  delay(1000); //Wait 1 second
-  //measure CO2 and TVOC levels
-  mySensor.measureAirQuality();
-  Serial.print("CO2: ");
-  Serial.print(mySensor.CO2);
-  Serial.print(" ppm\tTVOC: ");
-  Serial.print(mySensor.TVOC);
-  Serial.println(" ppb");
-  //get raw values for H2 and Ethanol
-  mySensor.measureRawSignals();
-  Serial.print("Raw H2: ");
-  Serial.print(mySensor.H2);
-  Serial.print(" \tRaw Ethanol: ");
-  Serial.println(mySensor.ethanol);
+  t2 = millis();
+  if ( t2 >= t1 + 1000) //only will occur if 1 second has passed
+  {
+    t1 = t2;
+    //measure CO2 and TVOC levels
+    mySensor.measureAirQuality();
+    Serial.print("CO2: ");
+    Serial.print(mySensor.CO2);
+    Serial.print(" ppm\tTVOC: ");
+    Serial.print(mySensor.TVOC);
+    Serial.println(" ppb");
+    //get raw values for H2 and Ethanol
+    mySensor.measureRawSignals();
+    Serial.print("Raw H2: ");
+    Serial.print(mySensor.H2);
+    Serial.print(" \tRaw Ethanol: ");
+    Serial.println(mySensor.ethanol);
+  }
 }

examples/Example3_Humidity/Example3_Humidity.ino

@@ -14,12 +14,13 @@
   and updates the SGP30's humidity compensation with the absolute humidity value.
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
+#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 <Wire.h>
 
 SGP30 mySensor; //create an instance of the SGP30 class
 Weather hSensor; //create an instance of the Weather class
+long t1, t2;
 
 byte count = 0;
 
@@ -28,7 +29,7 @@ void setup() {
   Wire.begin();
   Wire.setClock(400000);
   //Initialize the SGP30
-  if (mySensor.begin() != SUCCESS) {
+  if (mySensor.begin() == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }
@@ -48,20 +49,23 @@ 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);
-
+  t1 = millis();
 }
 
 void loop() {
   //First fifteen readings will be
   //CO2: 400 ppm  TVOC: 0 ppb
-  delay(1000); //Wait 1 second
-  mySensor.measureAirQuality();
-  Serial.print("CO2: ");
-  Serial.print(mySensor.CO2);
-  Serial.print(" ppm\tTVOC: ");
-  Serial.print(mySensor.TVOC);
-  Serial.println(" ppb");
-
+  t2 = millis();
+  if ( t2 >= t1 + 1000) //only will occur if 1 second has passed
+  {
+    t1 = t2;  //measure CO2 and TVOC levels
+    mySensor.measureAirQuality();
+    Serial.print("CO2: ");
+    Serial.print(mySensor.CO2);
+    Serial.print(" ppm\tTVOC: ");
+    Serial.print(mySensor.TVOC);
+    Serial.println(" ppb");
+  }
 }
 
 double RHtoAbsolute (float relHumidity, float tempC) {

examples/Example4_ErrorChecking/Example4_ErrorChecking.ino

@@ -13,43 +13,48 @@
   This example measures CO2 and TVOC and reports any errors.
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
+#include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
 #include <Wire.h>
 
 SGP30 mySensor; //create an object of the SGP30 class
 SGP30ERR error;
+long t1, t2;
 
 void setup() {
   Serial.begin(9600);
   Wire.begin();
   //Sensor supports I2C speeds up to 400kHz
   Wire.setClock(400000);
   //Initialize sensor
-  if (mySensor.begin() != SUCCESS) {
+  if (mySensor.begin() == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }
   //Initializes sensor for air quality readings
   mySensor.initAirQuality();
+    t1 = millis();
 }
 
 void loop() {
   //First fifteen readings will be
   //CO2: 400 ppm  TVOC: 0 ppb
-  delay(1000); //Wait 1 second
-  //measure CO2 and TVOC levels
-  error = mySensor.measureAirQuality();
-  if (error == SUCCESS) {
-    Serial.print("CO2: ");
-    Serial.print(mySensor.CO2);
-    Serial.print(" ppm\tTVOC: ");
-    Serial.print(mySensor.TVOC);
-    Serial.println(" ppb");
-  }
-  else if (error == ERR_BAD_CRC) {
-    Serial.println("CRC Failed");
-  }
-  else if (error == ERR_I2C_TIMEOUT) {
-    Serial.println("I2C Timed out");
+  t2 = millis();
+  if ( t2 >= t1 + 1000) //only will occur if 1 second has passed
+  {
+    t1 = t2;  //measure CO2 and TVOC levels
+    error = mySensor.measureAirQuality();
+    if (error == SUCCESS) {
+      Serial.print("CO2: ");
+      Serial.print(mySensor.CO2);
+      Serial.print(" ppm\tTVOC: ");
+      Serial.print(mySensor.TVOC);
+      Serial.println(" ppb");
+    }
+    else if (error == ERR_BAD_CRC) {
+      Serial.println("CRC Failed");
+    }
+    else if (error == ERR_I2C_TIMEOUT) {
+      Serial.println("I2C Timed out");
+    }
   }
 }

examples/Example5_DeviceInfo/Example5_DeviceInfo.ino

@@ -13,7 +13,7 @@
   This example gets the sensor's serial ID and version number.
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
+#include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
 #include <Wire.h>
 
 SGP30 mySensor; //create an object of the SGP30 class
@@ -24,7 +24,7 @@ void setup() {
   //Sensor supports I2C speeds up to 400kHz
   Wire.setClock(400000);
   //Initialize sensor
-  if (mySensor.begin() != SUCCESS) {
+  if (mySensor.begin() == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }

examples/Example6_SchedulerReadings/Example6_SchedulerReadings.ino

@@ -14,7 +14,7 @@
   freeing the main loop from wasteful delays.
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
+#include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
 #include <TaskScheduler.h> // Click here to get the library: http://librarymanager/All#TaskScheduler
 #include <Wire.h>
 
@@ -30,7 +30,7 @@ void setup() {
   Serial.begin(9600);
   Wire.begin();
   Wire.setClock(400000);
-  if (mySensor.begin() != SUCCESS) {
+  if (mySensor.begin() == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }

examples/Example7_Reset/Example7_Reset.ino

@@ -13,9 +13,10 @@
   This example performs a soft reset on the sensor and restores its baseline.
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
+#include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
 #include <Wire.h>
 #include <EEPROM.h>
+long t1, t2;
 
 SGP30 mySensor; //create an object of the SGP30 class
 byte baselineC02Addr = 0x00;
@@ -25,7 +26,7 @@ void setup() {
   Serial.begin(9600);
   Wire.begin();
   Wire.setClock(400000);
-  if (mySensor.begin() != SUCCESS) {
+  if (mySensor.begin() == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }
@@ -64,15 +65,19 @@ void setup() {
   //set the sensor's baseline to the previously gotten baseline
   mySensor.setBaseline(mySensor.baselineCO2, mySensor.baselineTVOC);
   Serial.println("Updated Baseline");
+  t1 = millis();
 }
 
 void loop() {
-  delay(1000); //Wait 1 second
-  mySensor.measureAirQuality();
-  Serial.print("CO2: ");
-  Serial.print(mySensor.CO2);
-  Serial.print(" ppm\t TVOC: ");
-  Serial.print(mySensor.TVOC);
-  Serial.println(" ppb");
-
+  t2 = millis();
+  if ( t2 >= t1 + 1000) //only will occur if 1 second has passed
+  {
+    t1 = t2;  //measure CO2 and TVOC levels
+    mySensor.measureAirQuality();
+    Serial.print("CO2: ");
+    Serial.print(mySensor.CO2);
+    Serial.print(" ppm\tTVOC: ");
+    Serial.print(mySensor.TVOC);
+    Serial.println(" ppb");
+  }
 }

examples/Example8_OtherI2C/Example8_OtherI2C.ino

@@ -13,32 +13,36 @@
   This example reads the sensors calculated CO2 and TVOC values using Software Wire
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
+#include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30
 #include <SoftwareWire.h>
 
 SGP30 mySensor; //create an object of the SGP30 class
+long t1, t2;
 
 void setup() {
   Serial.begin(9600);
   //Initialize sensor, specifying I2C port
-  if (mySensor.begin(Wire) != SUCCESS) {
+  if (mySensor.begin(Wire) == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }
   //Initializes sensor for air quality readings
   mySensor.initAirQuality();
+  t1 = millis();
 }
 
 void loop() {
   //First fifteen readings will be
   //CO2: 400 ppm  TVOC: 0 ppb
-  delay(1000); //Wait 1 second
-  //measure CO2 and TVOC levels
-  mySensor.measureAirQuality();
-  Serial.print("CO2: ");
-  Serial.print(mySensor.CO2);
-  Serial.print(" ppm\tTVOC: ");
-  Serial.print(mySensor.TVOC);
-  Serial.println(" ppb");
-
+  t2 = millis();
+  if ( t2 >= t1 + 1000) //only will occur if 1 second has passed
+  {
+    t1 = t2;  //measure CO2 and TVOC levels
+    mySensor.measureAirQuality();
+    Serial.print("CO2: ");
+    Serial.print(mySensor.CO2);
+    Serial.print(" ppm\tTVOC: ");
+    Serial.print(mySensor.TVOC);
+    Serial.println(" ppb");
+  }
 }

examples/Example9_UnitTest/Example9_UnitTest.ino

@@ -13,7 +13,7 @@
   This example performs the sensor's self test and displays the results.
 */
 
-#include "SparkFun_SGP30_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30#include <Wire.h>
+#include "SparkFun_SGP30_Arduino_Library.h" // Click here to get the library: http://librarymanager/All#SparkFun_SGP30#include <Wire.h>
 
 SGP30 mySensor; //create an object of the SGP30 class
 byte count = 0;
@@ -22,10 +22,11 @@ void setup() {
   Serial.begin(9600);
   Wire.begin();
   Wire.setClock(400000);
-  if (mySensor.begin() != SUCCESS) {
+  if (mySensor.begin() == false) {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }
+  //measureTest() should not be called after a call to initAirQuality()
   error = mySensor.measureTest();
   if (error == SUCCESS) {
     Serial.println("Success!");

keywords.txt

@@ -38,8 +38,8 @@ SUCCESS	LITERAL1
 ERR_BAD_CRC	LITERAL1
 ERR_I2C_TIMEOUT	LITERAL1
 SELF_TEST_FAIL	LITERAL1
-SparkFun_SGP30_Library_h	LITERAL1
-SparkFun_SGP30_Library.h	LITERAL1
+SparkFun_SGP30_Arduino_Library_h	LITERAL1
+SparkFun_SGP30_Arduino_Library.h	LITERAL1
 init_air_quality	LITERAL1
 measure_air_quality	LITERAL1
 get_baseline	LITERAL1
@@ -48,4 +48,5 @@ set_humidity	LITERAL1
 measure_test	LITERAL1
 get_feature_set_version	LITERAL1
 get_serial_id	LITERAL1
-measure_raw_signals	LITERAL1
+measure_raw_signals	LITERAL1
+SGP30_LOOKUP_TABLE	LITERAL1