Initial commit

README.md

@@ -1,2 +1,16 @@
-# rewire_max32664
-An Arduino library for interfacing with the MAX32664
+# ReWire library for MAX32664 / MAX30101
+
+This is an Arduino library for interfacing with the MAX32664. Specifically, this library is tailored to version A of the MAX32664 paired with the MAX30101 sensor.
+
+I have not implemented the full set of functionality (yet). Rather, I've focused on the functions that were most necessary for my application. The library allows you to set up the MAX32664 and stream data in "sensor + algorithm mode", so you are able to visualize both the raw PPG data as well as the calculated HR and SpO2 values. I have not implemented support for an accelerometer.
+
+Feel free to contact me with any questions or issues.
+
+# Comparison to other existing libraries
+
+There are at least two other existing libraries for interfacing with the MAX32664.
+
+The SparkFun library can be found at this link: https://github.com/sparkfun/SparkFun_Bio_Sensor_Hub_Library
+The Protocentral library can be found at this link: https://github.com/Protocentral/protocentral-pulse-express
+
+While each of these libraries can be useful, I decided to roll my own library because I didn't agree with some of the design decisions made in those pre-existing libraries. But if you find those libraries to be more useful to you, by all means you can use whichever library you prefer.

examples/basic_example/basic_example.ino

@@ -0,0 +1,134 @@
+#include <Arduino.h>
+#include <Wire.h>
+#include <ReWire_MAX32664.h>
+
+// Reset pin, MFIO pin
+// Set these to match the pin values on your board!!!
+int reset_pin = 0;
+int mfio_pin = 2;
+
+//An instance of the MAX32664. We are using the default I2C instance.
+//Change this to match the values for your board.
+ReWire_MAX32664 max32664 = ReWire_MAX32664(&Wire, mfio_pin, reset_pin);
+
+void setup()
+{
+    //Initialize serial communication
+    Serial.begin(115200);
+
+    //Initiate a 10-second countdown
+    for (int i = 10; i > 0; i--)
+    {
+        Serial.print("[DEBUG] ");
+        Serial.println(i);
+        delay(1000);
+    }
+    Serial.println("[DEBUG] Countdown completed...");
+
+    //Initialize I2C
+    Serial.println("[DEBUG] Initializing I2C");
+    Wire.begin();
+
+    //Initialize the MAX32664 biohub
+    Serial.println("[DEBUG] Initializing MAX32664");
+    uint8_t device_mode;
+    uint8_t result = max32664.Begin(device_mode);
+    if (result == MAX32664_ReadStatusByteValue::SUCCESS && device_mode == MAX32664_DeviceOperatingMode::ApplicationMode)
+    {
+        //We successfully initialized communication with the sensor
+        Serial.println("[DEBUG] Sensor started!");
+    }
+    else
+    {
+        //We were not able to communicate with the sensor
+        Serial.println("[DEBUG] Could not communicate with the sensor!");
+        while(1)
+        {
+            //empty
+        }
+    }
+
+    //Configure the sensor to output both raw data as well as calculated data
+    Serial.println("[DEBUG] Configuring Sensor....");
+
+    result = max32664.ConfigureDevice_SensorAndAlgorithm();
+    if(result == MAX32664_ReadStatusByteValue::SUCCESS)
+    { 
+        Serial.println("[DEBUG] Sensor configured.");
+    }
+    else 
+    {
+        Serial.println("[DEBUG] Error configuring sensor.");
+        Serial.print("[DEBUG] Error: "); 
+        Serial.println(result);
+        while(1)
+        {
+            //empty
+        } 
+    }
+}
+
+void loop()
+{
+    //In this function, we are following the steps outlined in Table 8 (section 3.2) of 
+    //  the document "measuring-heart-rate-and-spo2-using-the-max32664a.pdf".
+    //  Specifically, we are following the steps 2.1, 2.2, and 2.3 in the "READING SAMPLES"
+    //  portion of Table 8.
+
+    //Step 2.1: Read the sensor hub status byte
+    uint8_t sensor_hub_status;
+    uint8_t read_status = max32664.ReadSensorHubStatus(sensor_hub_status);
+
+    //If the read was successful...
+    if (read_status == MAX32664_ReadStatusByteValue::SUCCESS)
+    {
+        //Note: I am purposefully not checking "sensor_hub_status"
+        //  to see if the DataRdyBit is set, because I've found that
+        //  it doesn't really matter and just slows things down.
+        //  Proceed.
+
+        //Step 2.2: Get the number of samples in the FIFO
+        uint8_t num_available_samples;
+        read_status = max32664.ReadNumberAvailableSamples(num_available_samples);
+
+        //If the read was successful and if there are samples available to read...
+        if (read_status == MAX32664_ReadStatusByteValue::SUCCESS && num_available_samples > 0)
+        {
+            //Step 2.3: Read the data stored in the FIFO
+            for (int i = 0; i < num_available_samples; i++)
+            {
+                MAX32664_Data current_sample;
+                read_status = max32664.ReadSample_SensorAndAlgorithm(current_sample);
+
+                //If the sample was successfully read...
+                if (read_status == MAX32664_ReadStatusByteValue::SUCCESS)
+                {
+                    //Output the sample data to over serial communication
+                    Serial.print(current_sample.ir);
+                    Serial.print("\t");
+                    Serial.print(current_sample.red);
+                    Serial.print("\t");
+                    Serial.print(current_sample.hr);
+                    Serial.print("\t");
+                    Serial.print(current_sample.hr_confidence);
+                    Serial.print("\t");
+                    Serial.print(current_sample.spo2);
+                    Serial.print("\t");
+                    Serial.print(current_sample.algorithm_state);
+                    Serial.print("\t");
+                    Serial.print(current_sample.algorithm_status);
+                    Serial.print("\t");
+                    Serial.print(current_sample.interbeat_interval);
+                    Serial.println("");
+                }
+            }
+        }
+    }
+}
+
+
+
+
+
+
+

library.properties

@@ -0,0 +1,9 @@
+name=ReWire MAX32664 Biosensor Hub Library
+version=1.0
+author=David Pruitt (david@rewire.llc)
+maintainer=ReWire LLC (www.rewire.llc)
+sentence=Library for interfacing with the MAX32664 biometric hub
+paragraph=This library is tailored to version A of the MAX32664 paired with the MAX30101 sensor.
+category=Sensors
+url=https://github.com/ReWire-LLC/rewire_max32664
+architecture=*