Changes example code to be more clear on the values returned from function calls

Author: Elias Santistevan

Examples/Example1_config_BPM_Mode1/Example1_config_BPM_Mode1.ino

@@ -43,10 +43,10 @@ bioData body;
 // You can choose another variable name other than "body", like "blood", or
 // "readings", but I chose "body". Using this "body" varible in the 
 // following way gives us access to the following data: 
-// body.heartrate - Heartrate
+// body.heartrate  - Heartrate
 // body.confidence - Confidence in the heartrate value
-// body.oxygen - Blood oxygen level
-// body.status - Has a finger been sensed?
+// body.oxygen  - Blood oxygen level
+// body.status  - Has a finger been sensed?
 
 
 void setup(){
@@ -55,14 +55,14 @@ void setup(){
 
  Wire.begin();
  int result = bioHub.begin();
- if (!result)
+ if (result == 0) // Zero errors!
  Serial.println("Sensor started!");
  else
  Serial.println("Could not communicate with the sensor!!!");
 
  Serial.println("Configuring Sensor...."); 
  int error = bioHub.configBpm(MODE_ONE); // Configuring just the BPM settings. 
- if(!error){
+ if(error == 0){ // Zero errors!
  Serial.println("Sensor configured.");
  }
  else {
@@ -74,6 +74,7 @@ void setup(){
  // Data lags a bit behind the sensor, if you're finger is on the sensor when
  // it's being configured this delay will give some time for the data to catch
  // up. 
+ Serial.println("Loading up the buffer with data....");
  delay(4000); 
 
 }

Examples/Example2_config_BPM_Mode2/Example2_config_BPM_Mode2.ino

@@ -45,12 +45,12 @@ bioData body;
 // You can choose another variable name other than "body", like "blood", or
 // "readings", but I chose "body". Using this "body" varible in the 
 // following way gives us access to the following data: 
-// body.heartrate - Heartrate
+// body.heartrate  - Heartrate
 // body.confidence - Confidence in the heartrate value
-// body.oxygen - Blood oxygen level
-// body.status - Has a finger been sensed?
-// body.extStatus - What else is the finger up to?
-// body.rValue - Blood oxygen correlation coefficient. 
+// body.oxygen  - Blood oxygen level
+// body.status  - Has a finger been sensed?
+// body.extStatus  - What else is the finger up to?
+// body.rValue  - Blood oxygen correlation coefficient. 
 
 
 void setup(){
@@ -59,14 +59,14 @@ void setup(){
 
  Wire.begin();
  int result = bioHub.begin();
- if (!result)
+ if (result == 0) //Zero errors!
  Serial.println("Sensor started!");
  else
  Serial.println("Could not communicate with the sensor!!!");
 
  Serial.println("Configuring Sensor...."); 
  int error = bioHub.configBpm(MODE_TWO); // Configuring just the BPM settings. 
- if(!error){
+ if(error == 0){ // Zero errors
  Serial.println("Sensor configured.");
  }
  else {
@@ -78,6 +78,7 @@ void setup(){
  // Data lags a bit behind the sensor, if you're finger is on the sensor when
  // it's being configured this delay will give some time for the data to catch
  // up. 
+ Serial.println("Loading up the buffer with data....");
  delay(4000); 
 
 }

Examples/Example3_modify_AGC_Algo/Example3_modify_AGC_Algo.ino

@@ -39,7 +39,6 @@ int algoSamp = 10; // Number of samples to average (0-255)
 // Takes address, reset pin, and MFIO pin.
 SparkFun_Bio_Sensor_Hub bioHub(resPin, mfioPin); 
 
-sensorAttr attributes;
 bioData body; 
 // What's this!? This is a type (like int, byte, long) unique to the SparkFun
 // Pulse Oximeter and Heart Rate Monitor. Unlike those other types it holds
@@ -48,38 +47,38 @@ bioData body;
 // You can choose another variable name other than "body", like "blood", or
 // "readings", but I chose "body". Using this "body" varible in the 
 // following way gives us access to the following data: 
-// body.heartrate - Heartrate
+// body.heartrate  - Heartrate
 // body.confidence - Confidence in the heartrate value
-// body.oxygen - Blood oxygen level
-// body.status - Has a finger been sensed?
+// body.oxygen  - Blood oxygen level
+// body.status  - Has a finger been sensed?
 
 void setup(){
 
  Serial.begin(115200);
 
  Wire.begin();
  int result = bioHub.begin();
- if (!result)
+ if (result == 0) // Zero errors!
  Serial.println("Sensor started!");
 
  // Adjusting the Automatic Gain Control (AGC) Algorithm
  int error = bioHub.setAlgoRange(algoRange));
- if (error){
+ if (error > 0){
  Serial.println("Could not set algorithm's Range."); 
  }
 
  error = bioHub.setAlgoStepSize(algoStepSize);
- if (error){
+ if (error > 0){
  Serial.println("Could not set the step size."); 
  }
 
  error = bioHub.setAlgoSensitivity(algoSens);
- if (error){
+ if (error > 0){ 
  Serial.println("Could not set the sensitivity.");
  }
 
  error = bioHub.setAlgoSamples(algoSamp);
- if (error){
+ if (error > 0){ 
  Serial.println("Could not set the sample size."); 
  }
 
@@ -102,10 +101,14 @@ void setup(){
 
  Serial.println("Configuing Sensor.");
  error = configBpm(MODE_ONE);
- if (error){
+ if (error > 0){ 
  Serial.println("Could not configure the sensor.");
  }
 
+ // Data lags a bit behind the sensor, if you're finger is on the sensor when
+ // it's being configured this delay will give some time for the data to catch
+ // up. 
+ Serial.println("Loading up the buffer with data....");
  delay(4000);
 
 }

Examples/Example4_config_LEDs_BPM/Example4_config_LEDs_BPM.ino

@@ -56,25 +56,25 @@ bioData body;
 // "body" but you could use another variable name like "blood", "readings",
 // "ledBody" or whatever. Using the variable in the following way gives the
 // following data: 
-// body.irLed - Infrared LED counts. 
-// body.redLed - Red LED counts. 
-// body.heartrate - Heartrate
+// body.irLed  - Infrared LED counts. 
+// body.redLed  - Red LED counts. 
+// body.heartrate  - Heartrate
 // body.confidence - Confidence in the heartrate value
-// body.oxygen - Blood oxygen level
-// body.status - Has a finger been sensed?
+// body.oxygen  - Blood oxygen level
+// body.status  - Has a finger been sensed?
 
 void setup(){
 
  Serial.begin(115200);
 
  Wire.begin();
  int result = bioHub.begin();
- if (!result)
+ if (result == 0) // Zero errors!
  Serial.println("Sensor started!");
 
  Serial.println("Configuring Sensor...."); 
  int error = bioHub.configSensorBpm(MODE_ONE); // Configure Sensor and BPM mode , MODE_TWO also available
- if(!error){
+ if (error == 0){// Zero errors.
  Serial.println("Sensor configured.");
  }
  else {
@@ -85,7 +85,7 @@ void setup(){
 
  // Set pulse width.
  error = bioHub.setPulseWidth(width);
- if (!error){
+ if (error == 0){// Zero errors.
  Serial.println("Pulse Width Set.");
  }
  else {
@@ -102,7 +102,7 @@ void setup(){
  // Set sample rate per second. Remember that not every sample rate is
  // available with every pulse width. Check hookup guide for more information. 
  error = bioHub.setSampleRate(samples);
- if (!error){
+ if (error == 0){// Zero errors.
  Serial.println("Sample Rate Set.");
  }
  else {
@@ -116,7 +116,10 @@ void setup(){
  Serial.print("Sample rate is set to: ");
  Serial.println(sampleVal); 
 
- // Some time to read your settings.
+ // Data lags a bit behind the sensor, if you're finger is on the sensor when
+ // it's being configured this delay will give some time for the data to catch
+ // up. 
+ Serial.println("Loading up the buffer with data....");
  delay(4000);
 
 }