Cleaned up example comments, made ESP32 and Teensy 3.2 compatible.

Author: marshalltaylorSFE

examples/BME280Compensated/BME280Compensated.ino

@@ -1,45 +1,57 @@
+/******************************************************************************
+BME280Compensated.ino
 
-/*
-CCS811 Air Quality Sensor Example Code
-By: Nathan Seidle
-SparkFun Electronics
-Date: February 7th, 2017
-License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license).
+Marshall Taylor @ SparkFun Electronics
 
-Sends the humidity and temperature from a separate sensor to the CCS811 so
-that the CCS811 can adjust its algorithm.
+April 4, 2017
+
+https://github.com/sparkfun/CCS811_Air_Quality_Breakout
+https://github.com/sparkfun/SparkFun_CCS811_Arduino_Library
+
+This example uses a BME280 to gather environmental data that is then used
+to compensate the CCS811.
 
 Hardware Connections (Breakoutboard to Arduino):
-3.3V = 3.3V
-GND = GND
-SDA = A4
-SCL = A5
-WAKE = D2
+  3.3V to 3.3V pin
+  GND to GND pin
+  SDA to A4
+  SCL to A5
+
+Resources:
+Uses Wire.h for i2c operation
+
+Development environment specifics:
+Arduino IDE 1.8.1
+
+This code is released under the [MIT License](http://opensource.org/licenses/MIT).
 
-Serial.print it out at 9600 baud to serial monitor.
-*/
+Please review the LICENSE.md file included with this example. If you have any questions 
+or concerns with licensing, please contact [email protected].
 
-#include <Wire.h>
-#include <SPI.h>
+Distributed as-is; no warranty is given.
+******************************************************************************/
 #include <SparkFunBME280.h>
 #include <SparkFunCCS811.h>
 
-#define CCS811_ADDR 0x5B //7-bit unshifted default I2C Address
+#define CCS811_ADDR 0x5B //Default I2C Address
+//#define CCS811_ADDR 0x5A //Alternate I2C Address
+
 #define PIN_NOT_WAKE 5
 
+//Global sensor objects
 CCS811 myCCS811(CCS811_ADDR);
-
-//Global sensor object
 BME280 myBME280;
-//---------------------------------------------------------------
+
 void setup()
 {
 	Serial.begin(9600);
 	Serial.println();
 	Serial.println("Apply BME280 data to CCS811 for compensation.");
 
+	//This begins the CCS811 sensor and prints error status of .begin()
 	status_t returnCode = myCCS811.begin();
 	Serial.print("CCS811 begin exited with: ");
+	//Pass the error code to a function to print the results
 	printDriverError( returnCode );
 	Serial.println();
 
@@ -67,9 +79,12 @@ void setup()
 //---------------------------------------------------------------
 void loop()
 {
+	//Check to see if data is available
 	if (myCCS811.dataAvailable())
 	{
-		myCCS811.readAlgorithmResults(); //Calling this function updates the global tVOC and CO2 variables
+		//Calling this function updates the global tVOC and eCO2 variables
+		myCCS811.readAlgorithmResults();
+		//printInfoSerial fetches the values of tVOC and eCO2
 		printInfoSerial();
 
 		float BMEtempC = myBME280.readTempC();
@@ -81,10 +96,12 @@ void loop()
 		Serial.println(BMEhumid);
 		Serial.println();
 
+		//This sends the temperature data to the CCS811
 		myCCS811.setEnvironmentalData(BMEhumid, BMEtempC);
 	}
 	else if (myCCS811.checkForStatusError())
 	{
+		//If the CCS811 found an internal error, print it.
 		printSensorError();
 	}
 
@@ -94,11 +111,13 @@ void loop()
 //---------------------------------------------------------------
 void printInfoSerial()
 {
+	//getCO2() gets the previously read data from the library
 	Serial.println("CCS811 data:");
 	Serial.print(" CO2 concentration : "); 
 	Serial.print(myCCS811.getCO2());
 	Serial.println(" ppm");
 
+	//getTVOC() gets the previously read data from the library
 	Serial.print(" TVOC concentration : "); 
 	Serial.print(myCCS811.getTVOC());
 	Serial.println(" ppb");
@@ -137,6 +156,11 @@ void printInfoSerial()
 
 }
 
+//printDriverError decodes the status_t type and prints the
+//type of error to the serial terminal.
+//
+//Save the return value of any function of type status_t, then pass
+//to this function to see what the output was.
 void printDriverError( status_t errorCode )
 {
 	switch( errorCode )
@@ -153,14 +177,16 @@ void printDriverError( status_t errorCode )
 	case SENSOR_INTERNAL_ERROR:
 		Serial.print("INTERNAL_ERROR");
 		break;
+	case SENSOR_GENERIC_ERROR:
+		Serial.print("GENERIC_ERROR");
+		break;
 	default:
 		Serial.print("Unspecified error.");
 	}
 }
 
-//Displays the type of error
-//Calling this causes reading the contents of the ERROR register
-//This should clear the ERROR_ID register
+//printSensorError gets, clears, then prints the errors
+//saved within the error register.
 void printSensorError()
 {
 	uint8_t error = myCCS811.getErrorRegister();

examples/BaselineOperator/BaselineOperator.ino

@@ -1,9 +1,12 @@
-/*
-CCS811 Air Quality Sensor Example Code
-By: Nathan Seidle
-SparkFun Electronics
-Date: February 7th, 2017
-License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license).
+/******************************************************************************
+BaselineOperator.ino
+
+Marshall Taylor @ SparkFun Electronics
+
+April 4, 2017
+
+https://github.com/sparkfun/CCS811_Air_Quality_Breakout
+https://github.com/sparkfun/SparkFun_CCS811_Arduino_Library
 
 This example demonstrates usage of the baseline register.
 
@@ -32,13 +35,25 @@ Hardware Connections (Breakoutboard to Arduino):
   SDA to A4
   SCL to A5
 
-*/
+Resources:
+Uses Wire.h for i2c operation
+Uses EEPROM.h for internal EEPROM driving
+
+Development environment specifics:
+Arduino IDE 1.8.1
 
-#include <Wire.h>
+This code is released under the [MIT License](http://opensource.org/licenses/MIT).
+
+Please review the LICENSE.md file included with this example. If you have any questions 
+or concerns with licensing, please contact [email protected].
+
+Distributed as-is; no warranty is given.
+******************************************************************************/
 #include <SparkFunCCS811.h>
 #include <EEPROM.h>
 
-#define CCS811_ADDR 0x5B //7-bit unshifted default I2C Address
+#define CCS811_ADDR 0x5B //Default I2C Address
+//#define CCS811_ADDR 0x5A //Alternate I2C Address
 
 CCS811 mySensor(CCS811_ADDR);
 
@@ -53,7 +68,7 @@ void setup()
 	printDriverError( returnCode );
 	Serial.println();
 
-	//Check for valid data already saved
+	//This looks for previously saved data in the eeprom at program start
 	if((EEPROM.read(0) == 0xA5)&&(EEPROM.read(1) == 0xB2))
 	{
 		Serial.println("EEPROM contains saved data.");
@@ -84,11 +99,13 @@ void loop()
 		switch(c)
 		{
 			case 's':
+				//This gets the latest baseline from the sensor
 				result = mySensor.getBaseline();
 				Serial.print("baseline for this sensor: 0x");
 				if(result < 0x100) Serial.print("0");
 				if(result < 0x10) Serial.print("0");
 				Serial.println(result, HEX);
+				//The baseline is saved (with valid data indicator bytes)
 				EEPROM.write(0, 0xA5);
 				EEPROM.write(1, 0xB2);
 				EEPROM.write(2, (result >> 8) & 0x00FF);
@@ -98,11 +115,13 @@ void loop()
 				if((EEPROM.read(0) == 0xA5)&&(EEPROM.read(1) == 0xB2))
 				{
 					Serial.println("EEPROM contains saved data.");
+					//The recovered baseline is packed into a 16 bit word
 					baselineToApply = ((unsigned int)EEPROM.read(2) << 8) | EEPROM.read(3);
 					Serial.print("Saved baseline: 0x");
 					if(baselineToApply < 0x100) Serial.print("0");
 					if(baselineToApply < 0x10) Serial.print("0");
 					Serial.println(baselineToApply, HEX);
+					//This programs the baseline into the sensor and monitors error states
 					errorStatus = mySensor.setBaseline( baselineToApply );
 					if( errorStatus == SENSOR_SUCCESS )
 					{
@@ -119,6 +138,7 @@ void loop()
 				}
 				break;
 			case 'c':
+				//Clear data indicator and data from the eeprom
 				Serial.println("Clearing EEPROM space.");
 				EEPROM.write(0, 0x00);
 				EEPROM.write(1, 0x00);
@@ -128,6 +148,7 @@ void loop()
 			case 'r':
 				if (mySensor.dataAvailable())
 				{
+					//Simply print the last sensor data
 					mySensor.readAlgorithmResults();
 
 					Serial.print("CO2[");
@@ -149,6 +170,11 @@ void loop()
 	delay(10);
 }
 
+//printDriverError decodes the status_t type and prints the
+//type of error to the serial terminal.
+//
+//Save the return value of any function of type status_t, then pass
+//to this function to see what the output was.
 void printDriverError( status_t errorCode )
 {
 	switch( errorCode )
@@ -165,7 +191,10 @@ void printDriverError( status_t errorCode )
 	case SENSOR_INTERNAL_ERROR:
 		Serial.print("INTERNAL_ERROR");
 		break;
+	case SENSOR_GENERIC_ERROR:
+		Serial.print("GENERIC_ERROR");
+		break;
 	default:
 		Serial.print("Unspecified error.");
 	}
-}
+}

examples/BasicReadings/BasicReadings.ino

@@ -1,62 +1,84 @@
-/*
-  CCS811 Air Quality Sensor Example Code
-  By: Nathan Seidle
-  SparkFun Electronics
-  Date: February 7th, 2017
-  License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license).
+/******************************************************************************
+BasicReadings.ino
 
-  Read the TVOC and CO2 values from the SparkFun CSS811 breakout board
+Marshall Taylor @ SparkFun Electronics
+Nathan Seidle @ SparkFun Electronics
 
-  A new sensor requires at 48-burn in. Once burned in a sensor requires 
-  20 minutes of run in before readings are considered good.
+April 4, 2017
 
-  Hardware Connections (Breakoutboard to Arduino):
-  3.3V = 3.3V
-  GND = GND
-  SDA = A4
-  SCL = A5
+https://github.com/sparkfun/CCS811_Air_Quality_Breakout
+https://github.com/sparkfun/SparkFun_CCS811_Arduino_Library
 
-  Serial.print it out at 9600 baud to serial monitor.
-*/
+Read the TVOC and CO2 values from the SparkFun CSS811 breakout board
 
-//This is the simplest example.  It throws away most error information and
-//runs at the default 1 sample per second.
+This is the simplest example.  It throws away most error information and
+runs at the default 1 sample per second.
 
-//#include <Wire.h>
+A new sensor requires at 48-burn in. Once burned in a sensor requires 
+20 minutes of run in before readings are considered good.
+
+Hardware Connections (Breakoutboard to Arduino):
+  3.3V to 3.3V pin
+  GND to GND pin
+  SDA to A4
+  SCL to A5
+
+Resources:
+Uses Wire.h for i2c operation
+
+Development environment specifics:
+Arduino IDE 1.8.1
+
+This code is released under the [MIT License](http://opensource.org/licenses/MIT).
+
+Please review the LICENSE.md file included with this example. If you have any questions 
+or concerns with licensing, please contact [email protected].
+
+Distributed as-is; no warranty is given.
+******************************************************************************/
 #include "SparkFunCCS811.h"
 
-#define CCS811_ADDR 0x5B //7-bit unshifted default I2C Address
+#define CCS811_ADDR 0x5B //Default I2C Address
+//#define CCS811_ADDR 0x5A //Alternate I2C Address
 
 CCS811 mySensor(CCS811_ADDR);
 
 void setup()
 {
   Serial.begin(9600);
   Serial.println("CCS811 Basic Example");
-
+	
+	//It is recommended to check return status on .begin(), but it is not
+	//required.
 	status_t returnCode = mySensor.begin();
 	if(returnCode != SENSOR_SUCCESS)
 	{
 		Serial.println(".begin() returned with an error.");
-		while(1);
+		while(1); //Hang if there was a problem.
 	}
 }
 
 void loop()
 {
+	//Check to see if data is ready with .dataAvailable()
   if (mySensor.dataAvailable())
   {
+	  //If so, have the sensor read and calculate the results.
+	  //Get them later
     mySensor.readAlgorithmResults();
 
     Serial.print("CO2[");
+	//Returns calculated CO2 reading
     Serial.print(mySensor.getCO2());
     Serial.print("] tVOC[");
+	//Returns calculated TVOC reading
     Serial.print(mySensor.getTVOC());
     Serial.print("] millis[");
+	//Simply the time since program start
     Serial.print(millis());
     Serial.print("]");
     Serial.println();
   }
 
-  delay(1000); //Wait for next reading
+  delay(10); //Don't spam the I2C bus
 }