Adds funcationality for the second mode added to the maximfast algorithm in firmware 10.1

Author: Elias Santistevan

Examples/Example1_readBPM/Example1_readBPM.ino

@@ -64,7 +64,7 @@ void setup(){
     Serial.println("Could not communicate with the sensor!!!");
 
   Serial.println("Configuring Sensor...."); 
-  int error = bioHub.configBpm(); // Configuring just the BPM settings. 
+  int error = bioHub.configBpm(MODE_ONE); // Configuring just the BPM settings. 
   if(!error){
     Serial.println("Sensor configured.");
   }

Examples/Example2_adjustLEDvalues/Example2_adjustLEDvalues.ino

@@ -1,4 +1,10 @@
 /*
+ This example displays a more manual method of adjusting the way in which the
+ MAX30101 gathers data. Specifically we'll look at how to modify the pulse
+ length of the LEDs within the MAX30101 which impacts the number of samples 
+ 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. 
  A summary of the hardware connections are as follows: 
  SDA -> SDA
  SCL -> SCL
@@ -112,7 +118,7 @@ void setup(){
   Serial.println(sampleVal); 
 
   // Some time to read your settings.
-  delay(2000);
+  delay(4000);
 
 }
 

Examples/Example3_modifyAGCalgo/Example3_modifyAGCalgo.ino

@@ -105,7 +105,7 @@ void setup(){
   Serial.println(sampVal);
 
   Serial.println("Configuing Sensor.");
-  error = configBpm();
+  error = configBpm(MODE_ONE);
   if (error){
     Serial.println("Could not configure the sensor.");
   }

keywords.txt

@@ -52,3 +52,8 @@ eraseFlash	KEYWORD2
 readBootloaderVers	KEYWORD2
 readSensorHubVersion	KEYWORD2
 readAlgorithmVersion	KEYWORD2
+Literals =================================
+MODE_ONE	LITERAL1
+MODE_TWO	LITERAL1 
+ENABLE	LITERAL1
+DISABLE	LITERAL1

src/SparkFun_Bio_Sensor_Hub_Library.cpp

@@ -93,9 +93,11 @@ uint8_t SparkFun_Bio_Sensor_Hub::readSensorHubStatus(){
 // This function sets very basic settings to get sensor and biometric data.
 // The biometric data includes data about heartrate, the confidence
 // level, SpO2 levels, and whether the sensor has detected a finger or not. 
-uint8_t SparkFun_Bio_Sensor_Hub::configBpm(){
+uint8_t SparkFun_Bio_Sensor_Hub::configBpm(uint8_t mode){
 
   uint8_t statusChauf = 0;
+  if (mode == MODE_ONE || mode == MODE_TWO){}
+  else return INCORR_PARAM;
 
   statusChauf = setOutputMode(ALGO_DATA); // Just the data
   if( statusChauf != SUCCESS )
@@ -112,10 +114,12 @@ uint8_t SparkFun_Bio_Sensor_Hub::configBpm(){
   statusChauf = max30101Control(ENABLE); 
   if( statusChauf != SUCCESS )
     return statusChauf; 
- 
-  statusChauf = maximFastAlgoControl(MODE_ONE); 
+   
+  statusChauf = maximFastAlgoControl(mode); 
   if( statusChauf != SUCCESS )
     return statusChauf; 
+  
+  _userSelectedMode = mode;
 
   delay(1000);
   return SUCCESS; 
@@ -144,37 +148,7 @@ uint8_t SparkFun_Bio_Sensor_Hub::configSensor(){
   statusChauf = maximFastAlgoControl(MODE_ONE); //Enable algorithm
   if( statusChauf != SUCCESS )
     return statusChauf; 
-  
-  delay(1000);
-  return SUCCESS; 
-
-}
 
-// This function sets very basic settings to get sensor and biometric data.
-// Sensor data includes 24 bit LED values for the two LED channels: Red and IR.
-// The biometric data includes data about heartrate, the confidence
-// level, SpO2 levels, and whether the sensor has detected a finger or not. 
-// Of note, the number of samples is set to one. 
-uint8_t SparkFun_Bio_Sensor_Hub::configSensorBpm(){
-
-  uint8_t statusChauf; // Our status chauffeur
-
-  statusChauf = setOutputMode(SENSOR_AND_ALGORITHM); // Data and sensor data 
-  if( statusChauf != SUCCESS )
-    return statusChauf; 
-
-  statusChauf = setFifoThreshold(0x01); // One sample before interrupt is fired to the MAX32664
-  if( statusChauf != SUCCESS )
-    return statusChauf; 
-
-  statusChauf = max30101Control(ENABLE); //Enable Sensor. 
-  if( statusChauf != SUCCESS )
-    return statusChauf; 
-
-  statusChauf = maximFastAlgoControl(MODE_ONE); //Enable algorithm
-  if( statusChauf != SUCCESS )
-    return statusChauf; 
-  
   delay(1000);
   return SUCCESS; 
 
@@ -184,12 +158,12 @@ uint8_t SparkFun_Bio_Sensor_Hub::configSensorBpm(){
 // Sensor data includes 24 bit LED values for the two LED channels: Red and IR.
 // The biometric data includes data about heartrate, the confidence
 // level, SpO2 levels, and whether the sensor has detected a finger or not. 
-// In addition mode two also gives data on the R value of the SPO2
-// measurements, and and extended finger status value.
 // Of note, the number of samples is set to one. 
-uint8_t SparkFun_Bio_Sensor_Hub::configSensorBpmTwo(){
+uint8_t SparkFun_Bio_Sensor_Hub::configSensorBpm(uint8_t mode){
 
   uint8_t statusChauf; // Our status chauffeur
+  if (mode == MODE_ONE || mode == MODE_TWO){}
+  else return INCORR_PARAM;
 
   statusChauf = setOutputMode(SENSOR_AND_ALGORITHM); // Data and sensor data 
   if( statusChauf != SUCCESS )
@@ -203,10 +177,12 @@ uint8_t SparkFun_Bio_Sensor_Hub::configSensorBpmTwo(){
   if( statusChauf != SUCCESS )
     return statusChauf; 
 
-  statusChauf = maximFastAlgoControl(MODE_TWO); //Enable algorithm
+  statusChauf = maximFastAlgoControl(mode); //Enable algorithm
   if( statusChauf != SUCCESS )
     return statusChauf; 
 
+  _userSelectedMode = mode;
+
   delay(1000);
   return SUCCESS; 
 
@@ -232,26 +208,64 @@ bioData SparkFun_Bio_Sensor_Hub::readBpm(){
   }
 
   numSamplesOutFifo(); 
+  
+  if (_userSelectedMode = MODE_ONE) {
+
+    readFillArray(READ_DATA_OUTPUT, READ_DATA, MAXFAST_ARRAY_SIZE, bpmArr); 
+
+    // Heart Rate formatting
+    libBpm.heartRate = (uint16_t(bpmArr[0]) << 8); 
+    libBpm.heartRate |= (bpmArr[1]); 
+    libBpm.heartRate /= 10; 
+
+    // Confidence formatting
+    libBpm.confidence = bpmArr[2]; 
+
+    //Blood oxygen level formatting
+    libBpm.oxygen = uint16_t(bpmArr[3]) << 8;
+    libBpm.oxygen |= bpmArr[4]; 
+    libBpm.oxygen /= 10;
+
+    //"Machine State" - has a finger been detected?
+    libBpm.status = bpmArr[5];
+
+    return libBpm;
+  }
+
+  else if (_userSelectedMode = MODE_TWO) {
 
-  readFillArray(READ_DATA_OUTPUT, READ_DATA, WHRM_ARRAY_SIZE, bpmArr); 
+    readFillArray(READ_DATA_OUTPUT, READ_DATA,\
+        MAXFAST_ARRAY_SIZE + MAXFAST_EXTENDED_DATA, bpmArrTwo); 
 
-  // Heart Rate formatting
-  libBpm.heartRate = (uint16_t(bpmArr[0]) << 8); 
-  libBpm.heartRate |= (bpmArr[1]); 
-  libBpm.heartRate /= 10; 
+    // Heart Rate formatting
+    libBpm.heartRate = (uint16_t(bpmArrTwo[0]) << 8); 
+    libBpm.heartRate |= (bpmArrTwo[1]); 
+    libBpm.heartRate /= 10; 
 
-  // Confidence formatting
-  libBpm.confidence = bpmArr[2]; 
+    // Confidence formatting
+    libBpm.confidence = bpmArrTwo[2]; 
 
-  //Blood oxygen level formatting
-  libBpm.oxygen = uint16_t(bpmArr[3]) << 8;
-  libBpm.oxygen |= bpmArr[4]; 
-  libBpm.oxygen /= 10;
+    //Blood oxygen level formatting
+    libBpm.oxygen = uint16_t(bpmArrTwo[3]) << 8;
+    libBpm.oxygen |= bpmArrTwo[4]; 
+    libBpm.oxygen /= 10;
 
-  //"Machine State" - has a finger been detected?
-  libBpm.status = bpmArr[5];
+    //"Machine State" - has a finger been detected?
+    libBpm.status = bpmArrTwo[5];
 
-  return libBpm;
+    //Sp02 r Value formatting
+    libBpm.rValue = uint16_t(bpmArrTwo[6]) << 8;
+    libBpm.rValue |= bpmArrTwo[7]; 
+    libBpm.rValue /= 10;
+
+    //Extended Machine State formatting
+    libBpm.extStatus = bpmArrTwo[8];
+
+    // There are two additional bytes of data that were requested but that
+    // have not been implemented in firmware 10.1 so will not be saved to
+    // user's data.  
+    return libBpm;
+  }
 
 }
 
@@ -286,39 +300,96 @@ bioData SparkFun_Bio_Sensor_Hub::readSensor(){
 bioData SparkFun_Bio_Sensor_Hub::readSensorBpm(){ 
 
   bioData libLedBpm; 
-  readFillArray(READ_DATA_OUTPUT, READ_DATA, WHRM_ARRAY_SIZE + MAX30101_LED_ARRAY, bpmSenArr); 
 
-  // Value of LED one....
-  libLedBpm.irLed = uint32_t(bpmSenArr[0]) << 16; 
-  libLedBpm.irLed |= uint32_t(bpmSenArr[1]) << 8; 
-  libLedBpm.irLed |= bpmSenArr[2]; 
+  if (_userSelectedMode == MODE_ONE){
+
+    readFillArray(READ_DATA_OUTPUT, READ_DATA, MAXFAST_ARRAY_SIZE + MAX30101_LED_ARRAY, bpmSenArr); 
+
+    // Value of LED one....
+    libLedBpm.irLed = uint32_t(bpmSenArr[0]) << 16; 
+    libLedBpm.irLed |= uint32_t(bpmSenArr[1]) << 8; 
+    libLedBpm.irLed |= bpmSenArr[2]; 
+
+    // Value of LED two...
+    libLedBpm.redLed = uint32_t(bpmSenArr[3]) << 16; 
+    libLedBpm.redLed |= uint32_t(bpmSenArr[4]) << 8; 
+    libLedBpm.redLed |= bpmSenArr[5]; 
+
+    // -- What happened here? -- There are two uint32_t values that are given by
+    // the sensor for LEDs that do not exists on the MAX30101. So we have to
+    // request those empty values because they occupy the buffer:
+    // bpmSenArr[6-11]. 
+    
+    // Heart rate formatting
+    libLedBpm.heartRate = (uint16_t(bpmSenArr[12]) << 8); 
+    libLedBpm.heartRate |= (bpmSenArr[13]); 
+    libLedBpm.heartRate /= 10; 
+
+    // Confidence formatting
+    libLedBpm.confidence = bpmSenArr[14]; 
+
+    //Blood oxygen level formatting
+    libLedBpm.oxygen = uint16_t(bpmSenArr[15]) << 8;
+    libLedBpm.oxygen |= bpmSenArr[16]; 
+    libLedBpm.oxygen /= 10;
+
+    //"Machine State" - has a finger been detected?
+    libLedBpm.status = bpmSenArr[17];
+    return libLedBpm;
+  }
+
+  else if (_userSelectedMode == MODE_TWO){
+
+    readFillArray(READ_DATA_OUTPUT, READ_DATA,\
+        MAXFAST_ARRAY_SIZE + MAX30101_LED_ARRAY + MAXFAST_EXTENDED_DATA, bpmSenArrTwo); 
+
+    // Value of LED one....
+    libLedBpm.irLed = uint32_t(bpmSenArr[0]) << 16; 
+    libLedBpm.irLed |= uint32_t(bpmSenArr[1]) << 8; 
+    libLedBpm.irLed |= bpmSenArr[2]; 
+
+    // Value of LED two...
+    libLedBpm.redLed = uint32_t(bpmSenArr[3]) << 16; 
+    libLedBpm.redLed |= uint32_t(bpmSenArr[4]) << 8; 
+    libLedBpm.redLed |= bpmSenArr[5]; 
+
+    // -- What happened here? -- There are two uint32_t values that are given by
+    // the sensor for LEDs that do not exists on the MAX30101. So we have to
+    // request those empty values because they occupy the buffer:
+    // bpmSenArr[6-11]. 
+    
+    // Heart rate formatting
+    libLedBpm.heartRate = (uint16_t(bpmSenArr[12]) << 8); 
+    libLedBpm.heartRate |= (bpmSenArr[13]); 
+    libLedBpm.heartRate /= 10; 
+
+    // Confidence formatting
+    libLedBpm.confidence = bpmSenArr[14]; 
+
+    //Blood oxygen level formatting
+    libLedBpm.oxygen = uint16_t(bpmSenArr[15]) << 8;
+    libLedBpm.oxygen |= bpmSenArr[16]; 
+    libLedBpm.oxygen /= 10;
+
+    //"Machine State" - has a finger been detected?
+    libLedBpm.status = bpmSenArr[17];
+
+    //Sp02 r Value formatting
+    libLedBpm.rValue = uint16_t(bpmArrTwo[18]) << 8;
+    libLedBpm.rValue |= bpmArrTwo[19]; 
+    libLedBpm.rValue /= 10;
+
+    //Extended Machine State formatting
+    libLedBpm.extStatus = bpmArrTwo[20];
+
+    // There are two additional bytes of data that were requested but that
+    // have not been implemented in firmware 10.1 so will not be saved to
+    // user's data.  
+    //
+    return libLedBpm;
+
+  }
 
-  // Value of LED two...
-  libLedBpm.redLed = uint32_t(bpmSenArr[3]) << 16; 
-  libLedBpm.redLed |= uint32_t(bpmSenArr[4]) << 8; 
-  libLedBpm.redLed |= bpmSenArr[5]; 
-
-  // -- What happened here? -- There are two uint32_t values that are given by
-  // the sensor for LEDs that do not exists on the MAX30101. So we have to
-  // request those empty values because they occupy the buffer:
-  // bpmSenArr[6-11]. 
-  
-  // Heart rate formatting
-  libLedBpm.heartRate = (uint16_t(bpmSenArr[12]) << 8); 
-  libLedBpm.heartRate |= (bpmSenArr[13]); 
-  libLedBpm.heartRate /= 10; 
-
-  // Confidence formatting
-  libLedBpm.confidence = bpmSenArr[14]; 
-
-  //Blood oxygen level formatting
-  libLedBpm.oxygen = uint16_t(bpmSenArr[15]) << 8;
-  libLedBpm.oxygen |= bpmSenArr[16]; 
-  libLedBpm.oxygen /= 10;
-
-  //"Machine State" - has a finger been detected?
-  libLedBpm.status = bpmSenArr[17];
-  return libLedBpm;
 
 }
 // This function modifies the pulse width of the MAX30101 LEDs. All of the LEDs