Example clean up. Fix Ex2. An attempt to add support for software I2C.

nseidle · nseidle · commit a6a79eb05fc6 · 2018-03-24T21:24:50.000-06:00
diff --git a/examples/Example1_BasicReadings/Example1_BasicReadings.ino b/examples/Example1_BasicReadings/Example1_BasicReadings.ino
@@ -10,12 +10,19 @@
   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.
+
+  Hardware connections:
+  BME280 -> Arduino
+  GND -> GND
+  3.3 -> 3.3
+  SDA -> A4
+  SCL -> A5
 */
 
-#include "Wire.h"
+#include <Wire.h>
 
 #include "SparkFunBME280.h"
-BME280 mySensor; //Global sensor object
+BME280 mySensor;
 
 void setup()
 {
diff --git a/examples/Example2_I2CAddress/Example2_I2CAddress.ino b/examples/Example2_I2CAddress/Example2_I2CAddress.ino
@@ -0,0 +1,71 @@
+/*
+  Communicate with BME280s with different I2C addresses
+  Nathan Seidle @ SparkFun Electronics
+  March 23, 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 two sensors on the same I2C bus.
+
+  The BME280 has two I2C addresses: 0x77 (jumper open) or 0x76 (jumper closed)
+
+  Hardware connections:
+  BME280 -> Arduino
+  GND -> GND
+  3.3 -> 3.3
+  SDA -> A4
+  SCL -> A5
+*/
+
+#include <Wire.h>
+
+#include "SparkFunBME280.h"
+BME280 mySensorA; //Uses default I2C address 0x77
+BME280 mySensorB; //Uses I2C address 0x76 (jumper closed)
+
+void setup()
+{
+  Serial.begin(9600);
+  Serial.println("Example showing alternate I2C addresses");
+
+  Wire.begin();
+
+  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.
+
+  if(mySensorA.beginI2C() == false) Serial.println("Sensor A connect failed");
+
+  mySensorB.setI2CAddress(0x76); //Connect to a second sensor
+  if(mySensorB.beginI2C() == false) Serial.println("Sensor B connect failed");
+}
+
+void loop()
+{
+  Serial.print("HumidityA: ");
+  Serial.print(mySensorA.readFloatHumidity(), 0);
+
+  Serial.print(" PressureA: ");
+  Serial.print(mySensorA.readFloatPressure(), 0);
+
+  Serial.print(" TempA: ");
+  //Serial.print(mySensorA.readTempC(), 2);
+  Serial.print(mySensorA.readTempF(), 2);
+
+  Serial.print(" HumidityB: ");
+  Serial.print(mySensorB.readFloatHumidity(), 0);
+
+  Serial.print(" PressureB: ");
+  Serial.print(mySensorB.readFloatPressure(), 0);
+
+  Serial.print(" TempB: ");
+  //Serial.print(mySensorB.readTempC(), 2);
+  Serial.print(mySensorB.readTempF(), 2);
+
+  Serial.println();
+
+  delay(50);
+}
+
diff --git a/examples/Example2_WireOptions/Example2_WireOptions.ino b/examples/Example2_WireOptions/Example2_WireOptions.ino
diff --git a/examples/Example3_CSVOutput/Example3_CSVOutput.ino b/examples/Example3_CSVOutput/Example3_CSVOutput.ino
@@ -12,10 +12,10 @@
   https://www.sparkfun.com/products/13676 - BME280 Breakout Board
 */
 
-#include "Wire.h"
+#include <Wire.h>
 
 #include "SparkFunBME280.h"
-BME280 mySensor; //Global sensor object
+BME280 mySensor;
 
 unsigned long sampleNumber = 0;
 
diff --git a/examples/Example4_Settings/Example4_Settings.ino b/examples/Example4_Settings/Example4_Settings.ino
@@ -10,10 +10,10 @@
   This example shows how to set the various filter, and oversample settings of the BME280.
 */
 
-#include "Wire.h"
+#include <Wire.h>
 
 #include "SparkFunBME280.h"
-BME280 mySensor; //Global sensor object
+BME280 mySensor;
 
 void setup()
 {
diff --git a/examples/Example5_ReadAllRegisters/Example5_ReadAllRegisters.ino b/examples/Example5_ReadAllRegisters/Example5_ReadAllRegisters.ino
@@ -16,10 +16,10 @@
   calibration words to be.
 */
 
-#include "Wire.h"
+#include <Wire.h>
 
 #include "SparkFunBME280.h"
-BME280 mySensor; //Global sensor object
+BME280 mySensor;
 
 void setup()
 {
diff --git a/examples/Example6_LowPower/Example6_LowPower.ino b/examples/Example6_LowPower/Example6_LowPower.ino
@@ -11,10 +11,10 @@
   sensor to sleep between readings.
 */
 
-#include "Wire.h"
+#include <Wire.h>
 
 #include "SparkFunBME280.h"
-BME280 mySensor; //Global sensor object
+BME280 mySensor;
 
 void setup()
 {
diff --git a/examples/Example7_RelativeAltitudeChange/Example7_RelativeAltitudeChange.ino b/examples/Example7_RelativeAltitudeChange/Example7_RelativeAltitudeChange.ino
@@ -13,39 +13,23 @@
   This sketch configures a BME280 to measure height changes, with a button
   to zero the local relative altitude.
 
-  Hardware connections:
-  BME280 -> Arduino
-  GND -> GND
-  3.3 -> 3.3
-  SDA -> A4
-  SCL -> A5
-
   To use, run the sketch then press a button on the keyboard. The data on the
   serial monitor will show zero.  Then, move the sensor to a new altitude and watch
   how the output changes!
 
   Note: For most accurate results keep the sensor orientation and temperature the
   same between measurements.
 
-  Resources:
-  Uses Wire.h for I2C operation
-  Uses SPI.h for SPI operation
-  Included CircularBuffer class for averaging
-
-  Development environment specifics:
-  Arduino IDE 1.6.4
-  Teensy loader 1.23
-
   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 techsupport@sparkfun.com.
   Distributed as-is; no warranty is given.
 */
 
-#include "Wire.h"
+#include <Wire.h>
 
 #include "SparkFunBME280.h"
-BME280 mySensor; //Global sensor object
+BME280 mySensor;
 
 #include "CircularBuffer.h"
 
diff --git a/examples/Example8_LocalPressure/Example8_LocalPressure.ino b/examples/Example8_LocalPressure/Example8_LocalPressure.ino
@@ -18,10 +18,10 @@
   29.92 inHg = 1.0 atm = 101325 Pa = 1013.25 mb
 */
 
-#include "Wire.h"
+#include <Wire.h>
 
 #include "SparkFunBME280.h"
-BME280 mySensor; //Global sensor object
+BME280 mySensor;
 
 void setup()
 {
diff --git a/examples/Example9_SoftwareI2C/Example9_SoftwareI2C.ino b/examples/Example9_SoftwareI2C/Example9_SoftwareI2C.ino
@@ -0,0 +1,57 @@
+/*
+  Communicate with BME280s using Software I2C
+  Nathan Seidle @ SparkFun Electronics
+  March 23, 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 sensors using the SoftwareWire library.
+
+  This is an advanced example. You'll need to edit the SparkFunBME280.h file
+  and uncomment the #include <SoftwareWire.h> line to enable Software I2C.
+
+  Since we're using software I2C we can use almost any pins. For this example the 
+  hardware connections:
+  BME280 -> Arduino
+  GND -> GND
+  3.3 -> 3.3
+  SDA -> 6
+  SCL -> 7
+*/
+
+#include <SoftwareWire.h> //SoftwareWire by Testato. Installed from library manager.
+
+//We use pins 6 and 7 in this example but others can be used
+SoftwareWire myWire(6, 7); //SDA, SCL
+
+#include "SparkFunBME280.h"
+BME280 mySensor;
+
+void setup()
+{
+  Serial.begin(9600);
+  Serial.println("Example showing alternate I2C addresses");
+
+  myWire.begin();
+  if(mySensor.beginI2C(myWire) == false) Serial.println("Sensor A connect failed");
+}
+
+void loop()
+{
+  Serial.print("Humidity: ");
+  Serial.print(mySensor.readFloatHumidity(), 0);
+
+  Serial.print(" Pressure: ");
+  Serial.print(mySensor.readFloatPressure(), 0);
+
+  Serial.print(" Temp: ");
+  //Serial.print(mySensor.readTempC(), 2);
+  Serial.print(mySensor.readTempF(), 2);
+
+  Serial.println();
+
+  delay(50);
+}
+
diff --git a/examples/SPI/Example1_BasicReadings/Example1_BasicReadings.ino b/examples/SPI/Example1_BasicReadings/Example1_BasicReadings.ino
@@ -0,0 +1,60 @@
+/*
+  Get basic environmental readings from the BME280
+  By: Nathan Seidle
+  SparkFun Electronics
+  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).
+
+  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 SPI.
+
+  Hardware connections:
+  BME280 -> Arduino
+  GND -> GND
+  3.3 -> 3.3
+  CS -> 10
+  MOSI -> 11
+  MISO -> 12
+  SCK -> 13
+*/
+
+#include <SPI.h>
+
+#include "SparkFunBME280.h"
+BME280 mySensor;
+
+void setup()
+{
+  Serial.begin(9600);
+  Serial.println("Reading basic values from BME280");
+
+  if (mySensor.beginSPI(10) == false) //Begin communication over SPI. Use pin 10 as CS.
+  {
+    Serial.println("The sensor did not respond. Please check wiring.");
+    while(1); //Freeze
+  }
+}
+
+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);
+}
diff --git a/src/SparkFunBME280.cpp b/src/SparkFunBME280.cpp
diff --git a/src/SparkFunBME280.h b/src/SparkFunBME280.h
