Comment changes to examples

Author: nseidle

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -10,12 +10,6 @@
   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.
-
-  todo
-  example set local ref pressure
-  fix repo description
-  example of reading/writing cal factors
-
 */
 
 #include "Wire.h"
@@ -26,14 +20,13 @@ BME280 mySensor; //Global sensor object
 void setup()
 {
   Serial.begin(9600);
-  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.");
+    Serial.println("The sensor did not respond. Please check wiring.");
     while(1); //Freeze
   }
 }

examples/Example3_CSVOutput/Example3_CSVOutput.ino

@@ -10,11 +10,6 @@
   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"
@@ -32,7 +27,7 @@ void setup()
 
   if (mySensor.beginI2C() == false) //Begin communication over I2C
   {
-    Serial.println("The chip did not respond. Please check wiring.");
+    Serial.println("The sensor did not respond. Please check wiring.");
     while(1); //Freeze
   }
 

examples/Example5_ReadAllRegisters/Example5_ReadAllRegisters.ino

@@ -1,4 +1,4 @@
-/******************************************************************************
+/*
   Read all the regigsters of the BME280
   BME280 Arduino and Teensy example
   Marshall Taylor @ SparkFun Electronics
@@ -14,7 +14,6 @@
   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"
@@ -25,18 +24,17 @@ BME280 mySensor; //Global sensor object
 void setup()
 {
   Serial.begin(9600);
+  while(!Serial); //Needed for printing correctly when using a Teensy
   Serial.println("Reading all registers from BME280");
 
   Wire.begin();
 
   if (mySensor.beginI2C() == false) //Begin communication over I2C
   {
-    Serial.println("The chip did not respond. Please check wiring.");
+    Serial.println("The sensor did not respond. Please check wiring.");
     while (1); //Freeze
   }
 
-  Serial.print("Displaying ID, reset and ctrl regs\n");
-
   Serial.print("ID(0xD0): ");
   printyPrintHex(mySensor.readRegister(BME280_CHIP_ID_REG));
 
@@ -52,19 +50,21 @@ void setup()
   Serial.println();
 
   Serial.println("Displaying all regs:");
-  uint8_t memCounter = 0x80;
-  uint8_t tempReadData;
-  for (int rowi = 8 ; rowi < 16 ; rowi++)
+  byte memCounter = 0x80;
+  for (byte row = 8 ; row < 16 ; row++)
   {
     Serial.print("0x");
-    Serial.print(rowi, HEX);
+    Serial.print(row, HEX);
     Serial.print("0:");
-    for (int coli = 0 ; coli < 16 ; coli++)
+
+    for (byte column = 0 ; column < 16 ; column++)
     {
-      tempReadData = mySensor.readRegister(memCounter);
-      Serial.print((tempReadData >> 4) & 0x0F, HEX);//Print first hex nibble
-      Serial.print(tempReadData & 0x0F, HEX);//Print second hex nibble
+      byte tempReadData = mySensor.readRegister(memCounter);
+
+      if(tempReadData < 0x10) Serial.print("0");
+      Serial.print(tempReadData, HEX);
       Serial.print(" ");
+
       memCounter++;
     }
     Serial.println();

examples/Example7_RelativeAltitudeChange/Example7_RelativeAltitudeChange.ino

@@ -66,7 +66,7 @@ void setup()
 
   if (mySensor.beginI2C() == false) //Begin communication over I2C
   {
-    Serial.println("The chip did not respond. Please check wiring.");
+    Serial.println("The sensor did not respond. Please check wiring.");
     while (1); //Freeze
   }
 

keywords.txt

@@ -26,12 +26,12 @@ writeRegister	KEYWORD2
 
 beginI2C	KEYWORD2
 setFilter	KEYWORD2
-setStandByTime	KEYWORD2
+setStandbyTime	KEYWORD2
 setMode	KEYWORD2
 getMode	KEYWORD2
 setTempOverSample	KEYWORD2
 setPressureOverSample	KEYWORD2
-setHumidtyOverSample	KEYWORD2
+setHumidityOverSample	KEYWORD2
 setI2CAddress	KEYWORD2
 isMeasuring	KEYWORD2
 setReferencePressure	KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=SparkFun BME280
-version=2.0.0
+version=2.0.1
 author=SparkFun Electronics
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=A library to drive the Bosch BME280 Altimeter and Pressure sensor

src/SparkFunBME280.cpp

@@ -144,10 +144,9 @@ uint8_t BME280::begin()
 bool BME280::beginI2C(TwoWire &wirePort)
 {
 	settings.I2CPort = &wirePort;
-	
 	settings.commInterface = I2C_MODE;
 	//settings.I2CAddress = 0x77; //We assume user has set the I2C address using setI2CAddress()
-	
+
 	if(begin() == 0x60) return(true); //Begin normal init with these settings. Should return chip ID of 0x60
 	return(false);
 }
@@ -361,8 +360,6 @@ float BME280::getReferencePressure()
 	return(_referencePressure);
 }
 
-
-
 float BME280::readFloatAltitudeMeters( void )
 {
 	float heightOutput = 0;
@@ -405,11 +402,8 @@ float BME280::readFloatHumidity( void )
 	var1 = (var1 > 419430400 ? 419430400 : var1);
 
 	return (float)(var1>>12) / 1024.0;
-
 }
 
-
-
 //****************************************************************************//
 //
 //  Temperature Section