Renames the example code, adds the second mode for the maximFast algorithm in second example code

Author: Elias Santistevan

Examples/Example1_readBPM/Example1_readBPM.ino renamed to Examples/Example1_config_BPM_Mode1/Example1_config_BPM_Mode1.ino

@@ -0,0 +1,106 @@
+/*
+ This example sketch gives you exactly what the SparkFun Pulse Oximiter and
+ Heart Rate Monitor is designed to do: read heart rate and blood oxygen levels.
+ This board requires I-squared-C connections but also connections to the reset
+ and mfio pins. When using the device keep LIGHT and CONSISTENT pressure on the
+ sensor. Otherwise you may crush the capillaries in your finger which results
+ in bad or no results. This differs from example one by giving an additional
+ two data points: an extended finger status and the r value of the blood oxygen
+ level. A summary of the hardware connections are as follows: 
+ SDA -> SDA
+ SCL -> SCL
+ RESET -> PIN 4
+ MFIO -> PIN 5
+
+ Author: Elias Santistevan
+ Date: 8/2019
+ SparkFun Electronics
+
+ If you run into an error code check the following table to help diagnose your
+ problem: 
+ 1 = Unavailable Command
+ 2 = Unavailable Function
+ 3 = Data Format Error
+ 4 = Input Value Error
+ 5 = Try Again
+ 255 = Error Unknown
+*/
+
+#include <SparkFun_Bio_Sensor_Hub_Library.h>
+#include <Wire.h>
+
+// No other Address options.
+#define DEF_ADDR 0x55
+
+// Reset pin, MFIO pin
+const int resPin = 4;
+const int mfioPin = 5;
+
+// Takes address, reset pin, and MFIO pin.
+SparkFun_Bio_Sensor_Hub bioHub(DEF_ADDR, resPin, mfioPin); 
+
+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
+// specific information on your heartrate and blood oxygen levels. BioData is
+// actually a specific kind of type, known as a "struct". 
+// 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.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.  
+
+
+void setup(){
+
+  Serial.begin(115200);
+
+  Wire.begin();
+  int result = bioHub.begin();
+  if (!result)
+    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){
+    Serial.println("Sensor configured.");
+  }
+  else {
+    Serial.println("Error configuring sensor.");
+    Serial.print("Error: "); 
+    Serial.println(error); 
+  }
+
+  // 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. 
+  delay(4000); 
+  
+}
+
+void loop(){
+
+    // Information from the readBpm function will be saved to our "body"
+    // variable.  
+    body = bioHub.readBpm();
+    Serial.print("Heartrate: ");
+    Serial.println(body.heartRate); 
+    Serial.print("Confidence: ");
+    Serial.println(body.confidence); 
+    Serial.print("Oxygen: ");
+    Serial.println(body.oxygen); 
+    Serial.print("Status: ");
+    Serial.println(body.status); 
+    Serial.print("Extended Status: ");
+    Serial.println(body.extStatus); 
+    Serial.print("Blood Oxygen R value: ");
+    Serial.println(body.rValue); 
+    delay(250); // Slowing it down, we don't need to break our necks here.
+}

Examples/Example2_config_BPM_Mode2/Example2_config_BPM_Mode2.ino

@@ -5,7 +5,6 @@
  pulse width and current consumption of the MAX30101's LEDs as it gathers data
  on light absorption. This particular setting is enabled when calling
  "configBpm" and so in this example we demonstrate how to modify the algorithm.
-
  SDA -> SDA
  SCL -> SCL
  RESET -> PIN 4

Examples/Example3_modifyAGCalgo/Example3_modifyAGCalgo.ino renamed to Examples/Example3_modify_AGC_Algo/Example3_modify_AGC_Algo.ino

@@ -5,6 +5,8 @@
  that can be gathered, so we'll adjust this value as well. In addition we 
  gather additional data from the bioData type: LED samples. This data gives 
  the number of samples gathered by the MAX30101 for both the red and IR LEDs. 
+ As a side note you can also choose MODE_ONE and MODE_TWO for configSensorBpm
+ as well.
  A summary of the hardware connections are as follows: 
  SDA -> SDA
  SCL -> SCL
@@ -74,7 +76,7 @@ void setup(){
     Serial.println("Sensor started!");
 
   Serial.println("Configuring Sensor...."); 
-  int error = bioHub.configSensorBpm(); // Configure Sensor and BPM mode 
+  int error = bioHub.configSensorBpm(MODE_ONE); // Configure Sensor and BPM mode , MODE_TWO also available
   if(!error){
     Serial.println("Sensor configured.");
   }

Examples/Example2_adjustLEDvalues/Example2_adjustLEDvalues.ino renamed to Examples/Example4_config_LEDs_BPM/Example4_config_LEDs_BPM.ino

@@ -209,7 +209,7 @@ bioData SparkFun_Bio_Sensor_Hub::readBpm(){
 
   numSamplesOutFifo(); 
 
-  if (_userSelectedMode = MODE_ONE) {
+  if (_userSelectedMode == MODE_ONE) {
 
     readFillArray(READ_DATA_OUTPUT, READ_DATA, MAXFAST_ARRAY_SIZE, bpmArr); 
 
@@ -232,8 +232,7 @@ bioData SparkFun_Bio_Sensor_Hub::readBpm(){
     return libBpm;
   }
 
-  else if (_userSelectedMode = MODE_TWO) {
-
+  else if (_userSelectedMode == MODE_TWO) {
     readFillArray(READ_DATA_OUTPUT, READ_DATA,\
         MAXFAST_ARRAY_SIZE + MAXFAST_EXTENDED_DATA, bpmArrTwo); 
 
@@ -248,15 +247,16 @@ bioData SparkFun_Bio_Sensor_Hub::readBpm(){
     //Blood oxygen level formatting
     libBpm.oxygen = uint16_t(bpmArrTwo[3]) << 8;
     libBpm.oxygen |= bpmArrTwo[4]; 
-    libBpm.oxygen /= 10;
+    libBpm.oxygen /= 10.0;
 
     //"Machine State" - has a finger been detected?
     libBpm.status = bpmArrTwo[5];
 
     //Sp02 r Value formatting
-    libBpm.rValue = uint16_t(bpmArrTwo[6]) << 8;
-    libBpm.rValue |= bpmArrTwo[7]; 
-    libBpm.rValue /= 10;
+    uint16_t tempVal = uint16_t(bpmArrTwo[6]) << 8;
+    tempVal |= bpmArrTwo[7]; 
+    libBpm.rValue = tempVal;
+    libBpm.rValue /= 10.0;
 
     //Extended Machine State formatting
     libBpm.extStatus = bpmArrTwo[8];
@@ -375,8 +375,9 @@ bioData SparkFun_Bio_Sensor_Hub::readSensorBpm(){
     libLedBpm.status = bpmSenArr[17];
 
     //Sp02 r Value formatting
-    libLedBpm.rValue = uint16_t(bpmArrTwo[18]) << 8;
-    libLedBpm.rValue |= bpmArrTwo[19]; 
+    uint16_t tempVal = uint16_t(bpmArrTwo[6]) << 8;
+    tempVal |= bpmArrTwo[7]; 
+    libLedBpm.rValue = tempVal;  
     libLedBpm.rValue /= 10;
 
     //Extended Machine State formatting
@@ -1031,7 +1032,6 @@ bool SparkFun_Bio_Sensor_Hub::eraseFlash() {
 
 }
 
-// Family Byte: BOOTLOADER_FLASH (0x80), Index Byte: SEND_PAGE_VALUE (0x04)
 // Family Byte: BOOTLOADER_INFO (0x81), Index Byte: BOOTLOADER_VERS (0x00)
 version SparkFun_Bio_Sensor_Hub::readBootloaderVers(){
 
@@ -1044,7 +1044,7 @@ version SparkFun_Bio_Sensor_Hub::readBootloaderVers(){
 
   _i2cPort->requestFrom(_address, static_cast<uint8_t>(4)); 
   uint8_t statusByte = _i2cPort->read();
-  if (!statusByte) { // Pass through if SUCCESS (0x00). 
+  if (statusByte) { // Pass through if SUCCESS (0x00). 
     booVers.major = 0; 
     booVers.minor = 0; 
     booVers.revision = 0; 
@@ -1059,20 +1059,19 @@ version SparkFun_Bio_Sensor_Hub::readBootloaderVers(){
 
 }
 
-// Family Byte: BOOTLOADER_INFO (0x81), Index Byte: PAGE_SIZE (0x01)
 // Family Byte: IDENTITY (0xFF), Index Byte: READ_SENSOR_HUB_VERS (0x03)
 version SparkFun_Bio_Sensor_Hub::readSensorHubVersion(){
 
   version bioHubVers; 
   _i2cPort->beginTransmission(_address);
-  _i2cPort->write(BOOTLOADER_INFO);    
-  _i2cPort->write(BOOTLOADER_VERS);    
+  _i2cPort->write(IDENTITY);    
+  _i2cPort->write(READ_SENSOR_HUB_VERS);    
   _i2cPort->endTransmission();
   delay(CMD_DELAY); 
 
   _i2cPort->requestFrom(_address, static_cast<uint8_t>(4)); 
   uint8_t statusByte = _i2cPort->read();
-  if (!statusByte){ // Pass through if SUCCESS (0x00). 
+  if (statusByte){ // Pass through if SUCCESS (0x00). 
     bioHubVers.major = 0; 
     bioHubVers.minor = 0; 
     bioHubVers.revision = 0; 
@@ -1092,14 +1091,14 @@ version SparkFun_Bio_Sensor_Hub::readAlgorithmVersion(){
 
   version libAlgoVers; 
   _i2cPort->beginTransmission(_address);
-  _i2cPort->write(BOOTLOADER_INFO);    
-  _i2cPort->write(BOOTLOADER_VERS);    
+  _i2cPort->write(IDENTITY);    
+  _i2cPort->write(READ_ALGO_VERS);    
   _i2cPort->endTransmission();
   delay(CMD_DELAY); 
 
   _i2cPort->requestFrom(_address, static_cast<uint8_t>(4)); 
   uint8_t statusByte = _i2cPort->read();
-  if (!statusByte){ // Pass through if SUCCESS (0x00). 
+  if (statusByte){ // Pass through if SUCCESS (0x00). 
     libAlgoVers.major = 0;
     libAlgoVers.minor = 0;
     libAlgoVers.revision = 0;  

src/SparkFun_Bio_Sensor_Hub_Library.cpp

@@ -43,8 +43,8 @@ struct bioData {
   uint8_t  confidence; // 0-100% LSB = 1%
   uint16_t oxygen; // 0-100% LSB = 1%
   uint8_t  status; // 0: Success, 1: Not Ready, 2: Object Detectected, 3: Finger Detected
-  uint16_t rValue;      // -- Algorithm Mode 2 vv
-  uint8_t  extStatus;   // --
+  float    rValue;      // -- Algorithm Mode 2 vv
+  int8_t   extStatus;   // --
   uint8_t  reserveOne;  // --
   uint8_t  resserveTwo; // -- Algorithm Mode 2 ^^