Adding examples. Adding keywords. Adding deprecated settings so original code compiles.

Author: nseidle

examples/CSV_Output/CSV_Output.ino

@@ -5,17 +5,16 @@
   Date: March 9th, 2018
   License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license).
 
-  https://github.com/sparkfun/SparkFun_BME280_Arduino_Library
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/14348 - Qwiic Combo Board
+  https://www.sparkfun.com/products/13676 - BME280 Breakout Board
+  
+  This example shows how to read humidity, pressure, and current temperature from the BME280 over I2C.
 
-  This example shows how to obtain humidity, pressure, and current temperature from the BME280. It
-  assumes an I2C connection.
-
-  Resources:
-  Uses Wire.h for I2C operation
-  Uses SPI.h for SPI operation
-
-  Development environment specifics:
-  Arduino IDE 1.8.5
+  todo
+  example set local ref pressure
+  fix repo description
+  example of reading/writing cal factors
 
 */
 
@@ -27,9 +26,11 @@ BME280 mySensor; //Global sensor object
 void setup()
 {
   Serial.begin(9600);
-  while(!Serial); //Wait for terminal to open
+  while(!Serial);
   Serial.println("Reading basic values from BME280");
 
+  Wire.begin();
+
   if (mySensor.beginI2C() == false) //Begin communication over I2C
   {
     Serial.println("The chip did not respond. Please check wiring.");

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -0,0 +1,73 @@
+/******************************************************************************
+  Read all the regigsters of the BME280
+  BME280 Arduino and Teensy example
+  Marshall Taylor @ SparkFun Electronics
+  May 20, 2015
+
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/14348 - Qwiic Combo Board
+  https://www.sparkfun.com/products/13676 - BME280 Breakout Board
+
+  This example shows how to connect to different I2C address and push to different Wire ports.
+
+  The BME280 has two I2C addresses: 0x77 (jumper open) or 0x76 (jumper closed)
+
+  This sketch configures the BME280 to read all measurements.  The sketch also
+  displays the BME280's physical memory and what the driver perceives the
+  calibration words to be.
+
+*/
+
+#include "Wire.h"
+
+#include "SparkFunBME280.h"
+BME280 mySensorA; //Global sensor object
+
+void setup()
+{
+  Serial.begin(9600);
+  Serial.println("Example showing alternate I2C addresses");
+
+  //Other I2C ports are available but it depends on your platform. 
+  //For example: Wire1, Wire2, softWire, etc
+
+  Wire.begin();
+  Wire.setClock(400000); //Increase to fast I2C speed!
+
+  //Wire1.begin();
+  //Wire1.setClock(400000);
+
+  mySensorA.setI2CAddress(0x77); //The default for the SparkFun Environmental Combo board is 0x77 (jumper open).
+  //If you close the jumper it is 0x76
+  //The I2C address must be set before .begin() otherwise the cal values will fail to load.
+
+  mySensorA.beginI2C(Wire); //Connect to this sensor using the Wire port
+
+  //mySensorB.setI2CAddress(0x76); //Connect to a second sensor
+  //mySensorB.beginI2C(Wire1); //Connect to this sensor using the Wire1 port
+}
+
+void loop()
+{
+  Serial.print("Humidity: ");
+  Serial.print(mySensorA.readFloatHumidity(), 0);
+
+  Serial.print(" Pressure: ");
+  Serial.print(mySensorA.readFloatPressure(), 0);
+
+  Serial.print(" Alt: ");
+  //Serial.print(mySensor.readFloatAltitudeMeters(), 1);
+  Serial.print(mySensorA.readFloatAltitudeFeet(), 1);
+
+  Serial.print(" Temp: ");
+  //Serial.print(mySensor.readTempC(), 2);
+  Serial.print(mySensorA.readTempF(), 2);
+
+  //Serial.print(" TempB: ");
+  //Serial.print(mySensorB.readTempF(), 2);
+
+  Serial.println();
+
+  delay(50);
+}
+

examples/Example2_WireOptions/Example2_WireOptions.ino

@@ -0,0 +1,77 @@
+/*
+  Output all readings in CSV format
+  BME280 Arduino and Teensy example
+  Marshall Taylor @ SparkFun Electronics
+  May 20, 2015
+  https://github.com/sparkfun/SparkFun_BME280_Arduino_Library
+  
+  This sketch outputs BME280 data in comma separated values for generating spreadsheet graphs.
+
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/14348 - Qwiic Combo Board
+  https://www.sparkfun.com/products/13676 - BME280 Breakout Board
+
+  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 "Wire.h"
+
+#include "SparkFunBME280.h"
+BME280 mySensor; //Global sensor object
+
+unsigned long sampleNumber = 0;
+
+void setup()
+{
+  Serial.begin(9600);
+
+  Wire.begin();
+
+  if (mySensor.beginI2C() == false) //Begin communication over I2C
+  {
+    Serial.println("The chip did not respond. Please check wiring.");
+    while(1); //Freeze
+  }
+
+	//Build a first-row of column headers
+  Serial.print("SampleNumber,");
+  Serial.print("Time(ms),");
+	Serial.print("T(deg C),");
+	Serial.print("T(deg F),");
+	Serial.print("P(Pa),");
+	Serial.print("Alt(m),");
+	Serial.print("Alt(ft),");
+	Serial.print("%RH");
+	Serial.println("");
+}
+
+void loop()
+{
+	//Print each row in the loop
+	//Start with temperature, as that data is needed for accurate compensation.
+	//Reading the temperature updates the compensators of the other functions
+	//in the background.
+  Serial.print(sampleNumber);
+  Serial.print(",");
+	Serial.print(millis());
+	Serial.print(",");
+	Serial.print(mySensor.readTempC(), 2);
+	Serial.print(",");
+	Serial.print(mySensor.readTempF(), 3);
+	Serial.print(",");
+	Serial.print(mySensor.readFloatPressure(), 0);
+	Serial.print(",");
+	Serial.print(mySensor.readFloatAltitudeMeters(), 3);
+	Serial.print(",");
+	Serial.print(mySensor.readFloatAltitudeFeet(), 3);
+	Serial.print(",");
+	Serial.print(mySensor.readFloatHumidity(), 0);
+	Serial.println();
+	
+	sampleNumber++;
+	
+	delay(50);
+}

examples/Example3_CSVOutput/Example3_CSVOutput.ino

@@ -0,0 +1,58 @@
+/*
+  Control the various settings of the BME280
+  Nathan Seidle @ SparkFun Electronics
+  March 23, 2018
+
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/14348 - Qwiic Combo Board
+  https://www.sparkfun.com/products/13676 - BME280 Breakout Board
+
+  This example shows how to set the various filter, and oversample settings of the BME280.
+*/
+
+#include "Wire.h"
+
+#include "SparkFunBME280.h"
+BME280 mySensor; //Global sensor object
+
+void setup()
+{
+  Serial.begin(9600);
+  Serial.println("Example showing alternate I2C addresses");
+
+  Wire.begin();
+  Wire.setClock(400000); //Increase to fast I2C speed!
+
+  mySensor.beginI2C();
+
+  mySensor.setFilter(1); //0 to 4 is valid. Filter coefficient. See 3.4.4
+  mySensor.setStandbyTime(0); //0 to 7 valid. Time between readings. See table 27.
+
+  mySensor.setTempOverSample(1); //0 to 16 are valid. 0 disables temp sensing. See table 24.
+  mySensor.setPressureOverSample(1); //0 to 16 are valid. 0 disables pressure sensing. See table 23.
+  mySensor.setHumidityOverSample(1); //0 to 16 are valid. 0 disables humidity sensing. See table 19.
+  
+  mySensor.setMode(MODE_NORMAL); //MODE_SLEEP, MODE_FORCED, MODE_NORMAL is valid. See 3.3
+}
+
+void loop()
+{
+  Serial.print("Humidity: ");
+  Serial.print(mySensor.readFloatHumidity(), 0);
+
+  Serial.print(" Pressure: ");
+  Serial.print(mySensor.readFloatPressure(), 0);
+
+  Serial.print(" Alt: ");
+  //Serial.print(mySensor.readFloatAltitudeMeters(), 1);
+  Serial.print(mySensor.readFloatAltitudeFeet(), 1);
+
+  Serial.print(" Temp: ");
+  //Serial.print(mySensor.readTempC(), 2);
+  Serial.print(mySensor.readTempF(), 2);
+
+  Serial.println();
+
+  delay(50);
+}
+