Initial commit

Author: ciarajekel

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

LICENSE.md

@@ -0,0 +1,55 @@
+SparkFun License Information
+============================
+
+SparkFun uses two different licenses for our files — one for hardware and one for code.
+
+Hardware
+---------
+
+**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
+
+Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
+
+You are free to:
+
+Share — copy and redistribute the material in any medium or format
+Adapt — remix, transform, and build upon the material
+for any purpose, even commercially.
+The licensor cannot revoke these freedoms as long as you follow the license terms.
+Under the following terms:
+
+Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
+No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+Notices:
+
+You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
+No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
+
+
+Code
+--------
+
+**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
+
+The MIT License (MIT)
+
+Copyright (c) 2016 SparkFun Electronics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,31 @@
+SparkFun SGP30 Library
+===========================================================
+![]()
+
+[*SparkX SGP30 Breakout (Qwiic) (SPX-14813)*](https://www.sparkfun.com/products/14813)
+
+  
+Repository Contents
+-------------------
+
+* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. 
+* **/src** - Source files for the library (.cpp, .h).
+* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. 
+* **library.properties** - General library properties for the Arduino package manager. 
+
+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_LED_Stick)** - Main repository (including hardware files)
+
+License Information
+-------------------
+
+This product is _**open source**_! 
+
+Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license.
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -0,0 +1,30 @@
+#include "SparkFun_SGP30_Library.h"
+#include <Wire.h>
+
+SGP30 mySensor; //create an object of the SGP30 class
+byte count = 0;
+
+void setup() {
+  Serial.begin(9600);
+  Wire.begin();
+  Wire.setClock(400000);
+  mySensor.begin();
+  mySensor.initAirQuality();
+  //ignore first 15 readings
+  while (count < 15) {
+    delay(1000); //Wait 1 second
+    mySensor.measureAirQuality();
+    count++;
+  }
+}
+
+void loop() {
+  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");
+
+}

examples/Example2_Baseline/Example2_Baseline.ino

@@ -0,0 +1,43 @@
+#include "SparkFun_SGP30_Library.h"
+#include <Wire.h>
+#include <EEPROM.h>
+
+SGP30 mySensor; //create an object of the SGP30 class
+byte count = 0;
+byte baselineC02Addr = 0x00;
+byte baselineTVOCAddr = 0x02;
+void setup() {
+  Serial.begin(9600);
+  Wire.begin();
+  Wire.setClock(400000);
+  mySensor.begin();
+  mySensor.initAirQuality();
+  //ignore first 15 readings
+  while (count < 15) {
+    delay(1000); //Wait 1 second
+    mySensor.measureAirQuality();
+    count++;
+  }
+}
+
+void loop() {
+  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");
+  mySensor.getBaseline();
+  if (count == 30) {
+    EEPROM.put(baselineC02Addr, mySensor.baselineCO2);
+    EEPROM.put(baselineTVOCAddr, mySensor.baselineTVOC);
+  }
+  if (count == 33) {
+    EEPROM.get(baselineC02Addr, mySensor.baselineCO2);
+    EEPROM.get(baselineTVOCAddr, mySensor.baselineTVOC);
+    mySensor.setBaseline(mySensor.baselineCO2, mySensor.baselineTVOC);
+
+  }
+  count++;
+}

examples/Example3_Humidity/Example3_Humidity.ino

@@ -0,0 +1,70 @@
+/*
+
+
+  This example uses the Si7021 to get relative humidity
+*/
+
+
+#include "SparkFun_SGP30_Library.h"
+#include "SparkFun_Si7021_Breakout_Library.h"
+#include <Wire.h>
+
+SGP30 mySensor; //create an instance of the SGP30 class
+Weather hSensor; //create an instance of the Weather class
+
+byte count = 0;
+
+void setup() {
+  Serial.begin(9600);
+  Wire.begin();
+  Wire.setClock(400000);
+  //Initialize the SGP30 
+  mySensor.begin();
+  
+  //Initialize the humidity sensor and ping it
+  hSensor.begin();
+  // Measure Relative Humidity from the Si7021
+  float humidity = hSensor.getRH();
+  //Measure temperature (in C) from the Si7021
+  float temperature = hSensor.getTemp();
+  //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
+  mySensor.setHumidity(sensHumidity);
+  
+  //ignore first 15 readings
+  mySensor.initAirQuality();
+  while (count < 15) {
+    delay(1000); //Wait 1 second
+    mySensor.measureAirQuality();
+    count++;
+  }
+}
+
+void loop() {
+  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");
+
+}
+
+double RHtoAbsolute (float relHumidity, float tempC) {
+  double Es = 6.11 * pow(10.0, (7.5 * tempC / (237.7 + tempC)));
+  double vaporPressure = (relHumidity * Es) / 100; //millibars
+  double absHumidity = 1000 * vaporPressure * 100 / ((tempC + 273) * 461.5); //Ideal gas law with unit conversions
+}
+
+uint16_t doubleToFixedPoint( double number) {
+  int power = 1 << 8;
+  double number2 = number * power;
+  uint16_t value = floor(number2 + 0.5);
+  return value;
+}
+
+

examples/Example4_RawSignals/Example4_RawSignals.ino

@@ -0,0 +1,34 @@
+#include "SparkFun_SGP30_Library.h"
+#include <Wire.h>
+
+SGP30 mySensor; //create an object of the SGP30 class
+byte count = 0;
+
+void setup() {
+  Serial.begin(9600);
+  Wire.begin();
+  Wire.setClock(400000);
+  mySensor.begin();
+  mySensor.initAirQuality();
+  //ignore first 15 readings
+  while (count < 15) {
+    delay(1000); //Wait 1 second
+    mySensor.measureAirQuality();
+    count++;
+  }
+}
+
+void loop() {
+  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");
+  mySensor.measureRawSignals();
+  Serial.print("Raw H2: ");
+  Serial.print(mySensor.H2);
+  Serial.print(" \tRaw Ethanol");
+  Serial.println(mySensor.ethanol);
+}

examples/Example5_DeviceInfo/Example5_DeviceInfo.ino

@@ -0,0 +1,23 @@
+#include "SparkFun_SGP30_Library.h"
+#include <Wire.h>
+
+SGP30 mySensor; //create an object of the SGP30 class
+byte count = 0;
+
+void setup() {
+  Serial.begin(9600);
+  Wire.begin();
+  Wire.setClock(400000);
+  mySensor.begin();
+  mySensor.getSerialID();
+  mySensor.getFeatureSetVersion();
+  Serial.print("SerialID: 0x");
+  Serial.print((uint32_t)(mySensor.serialID >> 32), HEX);
+  Serial.print((uint32_t)mySensor.serialID, HEX);
+  Serial.print("\tFeature Set Version: 0x");
+  Serial.print(mySensor.featureSetVersion, HEX);
+}
+
+void loop() {
+
+}

examples/Example6_InterruptReadings/Example6_InterruptReadings.ino

@@ -0,0 +1,56 @@
+#include "SparkFun_SGP30_Library.h"
+#include <Wire.h>
+
+SGP30 mySensor; //create an object of the SGP30 class
+byte count = 0;
+bool intrpt = false;
+
+void setup() {
+  Serial.begin(9600);
+  Wire.begin();
+  Wire.setClock(400000);
+  mySensor.begin();
+  mySensor.initAirQuality();
+  //ignore first 15 readings
+  while (count < 15) {
+    delay(1000); //Wait 1 second
+    mySensor.measureAirQuality();
+    count++;
+  }
+  configureTimer1();
+}
+
+void loop() {
+  if (intrpt == true) {
+    Serial.print("CO2: ");
+    Serial.print(mySensor.CO2);
+    Serial.print(" ppm\tTVOC");
+    Serial.print(mySensor.TVOC);
+    Serial.println(" ppb");
+    intrpt = false;
+  }
+}
+
+void configureTimer1(void) {
+  //https://www.instructables.com/id/Arduino-Timer-Interrupts/
+  cli();//stop interrupts
+  //set timer1 interrupt at 1Hz
+  TCCR1A = 0;// set entire TCCR1A register to 0
+  TCCR1B = 0;// same for TCCR1B
+  TCNT1  = 0;//initialize counter value to 0
+  // set compare match register for 1hz increments
+  OCR1A = 15624;// = (16*10^6) / (1*1024) - 1 (must be <65536)
+  // turn on CTC mode
+  TCCR1B |= (1 << WGM12);
+  // Set CS10 and CS12 bits for 1024 prescaler
+  TCCR1B |= (1 << CS12) | (1 << CS10);
+  // enable timer compare interrupt
+  TIMSK1 |= (1 << OCIE1A);
+  sei();//allow interrupts
+}
+
+ISR(TIMER1_COMPA_vect) {
+  mySensor.measureAirQuality();
+  intrpt = true;
+}
+

examples/Example7_UnitTest/Example7_UnitTest.ino

@@ -0,0 +1,34 @@
+#include "SparkFun_SGP30_Library.h"
+#include <Wire.h>
+
+SGP30 mySensor; //create an object of the SGP30 class
+byte count = 0;
+
+void setup() {
+  Serial.begin(9600);
+  Wire.begin();
+  Wire.setClock(400000);
+  mySensor.begin();
+  mySensor.initAirQuality();
+  //ignore first 15 readings
+  while (count < 15) {
+    delay(1000); //Wait 1 second
+    mySensor.measureAirQuality();
+    count++;
+  }
+}
+
+void loop() {
+  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");
+  mySensor.measureRawSignals();
+  Serial.print("Raw H2: ");
+  Serial.print(mySensor.H2);
+  Serial.print(" \tRaw Ethanol");
+  Serial.println(mySensor.ethanol);
+}