Joseph Downing / Mbed OS BLEHeartRateMon Featured

Bluetooth Heart Rate Monitor using Maxim MAX32630FTHR & MAXREFDES117

Fork of mbed-os-example-ble-HeartRate by mbed-os-examples

MAX30102/MAX30102.cpp@49:5be03f287022, 2017-12-11 (annotated)

Committer:
Brakkion
Date:
Mon Dec 11 16:22:50 2017 +0000
Revision:
49:5be03f287022
Parent:
47:8ae30057edc0 
Created using MAX32630FTHR & MAXREFDES117

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Brakkion 47:8ae30057edc0 1 /** \file max30102.cpp ******************************************************
Brakkion 47:8ae30057edc0 2 *
Brakkion 47:8ae30057edc0 3 * Project: MAXREFDES117#
Brakkion 47:8ae30057edc0 4 * Filename: max30102.cpp
Brakkion 47:8ae30057edc0 5 * Description: This module is an embedded controller driver for the MAX30102
Brakkion 47:8ae30057edc0 6 *
Brakkion 47:8ae30057edc0 7 *
Brakkion 47:8ae30057edc0 8 * --------------------------------------------------------------------
Brakkion 47:8ae30057edc0 9 *
Brakkion 47:8ae30057edc0 10 * This code follows the following naming conventions:
Brakkion 47:8ae30057edc0 11 *
Brakkion 47:8ae30057edc0 12 * char ch_pmod_value
Brakkion 47:8ae30057edc0 13 * char (array) s_pmod_s_string[16]
Brakkion 47:8ae30057edc0 14 * float f_pmod_value
Brakkion 47:8ae30057edc0 15 * int32_t n_pmod_value
Brakkion 47:8ae30057edc0 16 * int32_t (array) an_pmod_value[16]
Brakkion 47:8ae30057edc0 17 * int16_t w_pmod_value
Brakkion 47:8ae30057edc0 18 * int16_t (array) aw_pmod_value[16]
Brakkion 47:8ae30057edc0 19 * uint16_t uw_pmod_value
Brakkion 47:8ae30057edc0 20 * uint16_t (array) auw_pmod_value[16]
Brakkion 47:8ae30057edc0 21 * uint8_t uch_pmod_value
Brakkion 47:8ae30057edc0 22 * uint8_t (array) auch_pmod_buffer[16]
Brakkion 47:8ae30057edc0 23 * uint32_t un_pmod_value
Brakkion 47:8ae30057edc0 24 * int32_t * pn_pmod_value
Brakkion 47:8ae30057edc0 25 *
Brakkion 47:8ae30057edc0 26 * ------------------------------------------------------------------------- */
Brakkion 47:8ae30057edc0 27 /*******************************************************************************
Brakkion 47:8ae30057edc0 28 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Brakkion 47:8ae30057edc0 29 *
Brakkion 47:8ae30057edc0 30 * Permission is hereby granted, free of charge, to any person obtaining a
Brakkion 47:8ae30057edc0 31 * copy of this software and associated documentation files (the "Software"),
Brakkion 47:8ae30057edc0 32 * to deal in the Software without restriction, including without limitation
Brakkion 47:8ae30057edc0 33 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Brakkion 47:8ae30057edc0 34 * and/or sell copies of the Software, and to permit persons to whom the
Brakkion 47:8ae30057edc0 35 * Software is furnished to do so, subject to the following conditions:
Brakkion 47:8ae30057edc0 36 *
Brakkion 47:8ae30057edc0 37 * The above copyright notice and this permission notice shall be included
Brakkion 47:8ae30057edc0 38 * in all copies or substantial portions of the Software.
Brakkion 47:8ae30057edc0 39 *
Brakkion 47:8ae30057edc0 40 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Brakkion 47:8ae30057edc0 41 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Brakkion 47:8ae30057edc0 42 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Brakkion 47:8ae30057edc0 43 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Brakkion 47:8ae30057edc0 44 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Brakkion 47:8ae30057edc0 45 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Brakkion 47:8ae30057edc0 46 * OTHER DEALINGS IN THE SOFTWARE.
Brakkion 47:8ae30057edc0 47 *
Brakkion 47:8ae30057edc0 48 * Except as contained in this notice, the name of Maxim Integrated
Brakkion 47:8ae30057edc0 49 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Brakkion 47:8ae30057edc0 50 * Products, Inc. Branding Policy.
Brakkion 47:8ae30057edc0 51 *
Brakkion 47:8ae30057edc0 52 * The mere transfer of this software does not imply any licenses
Brakkion 47:8ae30057edc0 53 * of trade secrets, proprietary technology, copyrights, patents,
Brakkion 47:8ae30057edc0 54 * trademarks, maskwork rights, or any other form of intellectual
Brakkion 47:8ae30057edc0 55 * property whatsoever. Maxim Integrated Products, Inc. retains all
Brakkion 47:8ae30057edc0 56 * ownership rights.
Brakkion 47:8ae30057edc0 57 *******************************************************************************
Brakkion 47:8ae30057edc0 58 */
Brakkion 47:8ae30057edc0 59 #include "mbed.h"
Brakkion 47:8ae30057edc0 60 #include "MAX30102.h"
Brakkion 47:8ae30057edc0 61
Brakkion 47:8ae30057edc0 62 #ifdef TARGET_MAX32630FTHR
Brakkion 47:8ae30057edc0 63 I2C i2c(P3_4, P3_5); // SDA, SCL
Brakkion 49:5be03f287022 64 //I2C i2c(I2C1_SDA, I2C1_SCL);
Brakkion 47:8ae30057edc0 65 #else
Brakkion 47:8ae30057edc0 66 I2C i2c(I2C_SDA, I2C_SCL);
Brakkion 47:8ae30057edc0 67 #endif
Brakkion 47:8ae30057edc0 68
Brakkion 47:8ae30057edc0 69 bool maxim_max30102_write_reg(uint8_t uch_addr, uint8_t uch_data)
Brakkion 47:8ae30057edc0 70 /**
Brakkion 47:8ae30057edc0 71 * \brief Write a value to a MAX30102 register
Brakkion 47:8ae30057edc0 72 * \par Details
Brakkion 47:8ae30057edc0 73 * This function writes a value to a MAX30102 register
Brakkion 47:8ae30057edc0 74 *
Brakkion 47:8ae30057edc0 75 * \param[in] uch_addr - register address
Brakkion 47:8ae30057edc0 76 * \param[in] uch_data - register data
Brakkion 47:8ae30057edc0 77 *
Brakkion 47:8ae30057edc0 78 * \retval true on success
Brakkion 47:8ae30057edc0 79 */
Brakkion 47:8ae30057edc0 80 {
Brakkion 47:8ae30057edc0 81 char ach_i2c_data[2];
Brakkion 47:8ae30057edc0 82 ach_i2c_data[0]=uch_addr;
Brakkion 47:8ae30057edc0 83 ach_i2c_data[1]=uch_data;
Brakkion 47:8ae30057edc0 84
Brakkion 47:8ae30057edc0 85 if(i2c.write(I2C_WRITE_ADDR, ach_i2c_data, 2, false)==0)
Brakkion 47:8ae30057edc0 86 return true;
Brakkion 47:8ae30057edc0 87 else
Brakkion 47:8ae30057edc0 88 return false;
Brakkion 47:8ae30057edc0 89 }
Brakkion 47:8ae30057edc0 90
Brakkion 47:8ae30057edc0 91 bool maxim_max30102_read_reg(uint8_t uch_addr, uint8_t *puch_data)
Brakkion 47:8ae30057edc0 92 /**
Brakkion 47:8ae30057edc0 93 * \brief Read a MAX30102 register
Brakkion 47:8ae30057edc0 94 * \par Details
Brakkion 47:8ae30057edc0 95 * This function reads a MAX30102 register
Brakkion 47:8ae30057edc0 96 *
Brakkion 47:8ae30057edc0 97 * \param[in] uch_addr - register address
Brakkion 47:8ae30057edc0 98 * \param[out] puch_data - pointer that stores the register data
Brakkion 47:8ae30057edc0 99 *
Brakkion 47:8ae30057edc0 100 * \retval true on success
Brakkion 47:8ae30057edc0 101 */
Brakkion 47:8ae30057edc0 102 {
Brakkion 47:8ae30057edc0 103 char ch_i2c_data;
Brakkion 47:8ae30057edc0 104 ch_i2c_data=uch_addr;
Brakkion 47:8ae30057edc0 105 if(i2c.write(I2C_WRITE_ADDR, &ch_i2c_data, 1, true)!=0)
Brakkion 47:8ae30057edc0 106 return false;
Brakkion 47:8ae30057edc0 107 if(i2c.read(I2C_READ_ADDR, &ch_i2c_data, 1, false)==0)
Brakkion 47:8ae30057edc0 108 {
Brakkion 47:8ae30057edc0 109 *puch_data=(uint8_t) ch_i2c_data;
Brakkion 47:8ae30057edc0 110 return true;
Brakkion 47:8ae30057edc0 111 }
Brakkion 47:8ae30057edc0 112 else
Brakkion 47:8ae30057edc0 113 return false;
Brakkion 47:8ae30057edc0 114 }
Brakkion 47:8ae30057edc0 115
Brakkion 47:8ae30057edc0 116 bool maxim_max30102_init()
Brakkion 47:8ae30057edc0 117 /**
Brakkion 47:8ae30057edc0 118 * \brief Initialize the MAX30102
Brakkion 47:8ae30057edc0 119 * \par Details
Brakkion 47:8ae30057edc0 120 * This function initializes the MAX30102
Brakkion 47:8ae30057edc0 121 *
Brakkion 47:8ae30057edc0 122 * \param None
Brakkion 47:8ae30057edc0 123 *
Brakkion 47:8ae30057edc0 124 * \retval true on success
Brakkion 47:8ae30057edc0 125 */
Brakkion 47:8ae30057edc0 126 {
Brakkion 47:8ae30057edc0 127 if(!maxim_max30102_write_reg(REG_INTR_ENABLE_1,0xc0)) // INTR setting
Brakkion 47:8ae30057edc0 128 return false;
Brakkion 47:8ae30057edc0 129 if(!maxim_max30102_write_reg(REG_INTR_ENABLE_2,0x00))
Brakkion 47:8ae30057edc0 130 return false;
Brakkion 47:8ae30057edc0 131 if(!maxim_max30102_write_reg(REG_FIFO_WR_PTR,0x00)) //FIFO_WR_PTR[4:0]
Brakkion 47:8ae30057edc0 132 return false;
Brakkion 47:8ae30057edc0 133 if(!maxim_max30102_write_reg(REG_OVF_COUNTER,0x00)) //OVF_COUNTER[4:0]
Brakkion 47:8ae30057edc0 134 return false;
Brakkion 47:8ae30057edc0 135 if(!maxim_max30102_write_reg(REG_FIFO_RD_PTR,0x00)) //FIFO_RD_PTR[4:0]
Brakkion 47:8ae30057edc0 136 return false;
Brakkion 47:8ae30057edc0 137 if(!maxim_max30102_write_reg(REG_FIFO_CONFIG,0x0f)) //sample avg = 1, fifo rollover=false, fifo almost full = 17
Brakkion 47:8ae30057edc0 138 return false;
Brakkion 47:8ae30057edc0 139 if(!maxim_max30102_write_reg(REG_MODE_CONFIG,0x03)) //0x02 for Red only, 0x03 for SpO2 mode 0x07 multimode LED
Brakkion 47:8ae30057edc0 140 return false;
Brakkion 47:8ae30057edc0 141 if(!maxim_max30102_write_reg(REG_SPO2_CONFIG,0x27)) // SPO2_ADC range = 4096nA, SPO2 sample rate (100 Hz), LED pulseWidth (400uS)
Brakkion 47:8ae30057edc0 142 return false;
Brakkion 47:8ae30057edc0 143
Brakkion 47:8ae30057edc0 144 if(!maxim_max30102_write_reg(REG_LED1_PA,0x24)) //Choose value for ~ 7mA for LED1
Brakkion 47:8ae30057edc0 145 return false;
Brakkion 47:8ae30057edc0 146 if(!maxim_max30102_write_reg(REG_LED2_PA,0x24)) // Choose value for ~ 7mA for LED2
Brakkion 47:8ae30057edc0 147 return false;
Brakkion 47:8ae30057edc0 148 if(!maxim_max30102_write_reg(REG_PILOT_PA,0x7f)) // Choose value for ~ 25mA for Pilot LED
Brakkion 47:8ae30057edc0 149 return false;
Brakkion 47:8ae30057edc0 150 return true;
Brakkion 47:8ae30057edc0 151 }
Brakkion 47:8ae30057edc0 152
Brakkion 47:8ae30057edc0 153 bool maxim_max30102_read_fifo(uint32_t *pun_red_led, uint32_t *pun_ir_led)
Brakkion 47:8ae30057edc0 154 /**
Brakkion 47:8ae30057edc0 155 * \brief Read a set of samples from the MAX30102 FIFO register
Brakkion 47:8ae30057edc0 156 * \par Details
Brakkion 47:8ae30057edc0 157 * This function reads a set of samples from the MAX30102 FIFO register
Brakkion 47:8ae30057edc0 158 *
Brakkion 47:8ae30057edc0 159 * \param[out] *pun_red_led - pointer that stores the red LED reading data
Brakkion 47:8ae30057edc0 160 * \param[out] *pun_ir_led - pointer that stores the IR LED reading data
Brakkion 47:8ae30057edc0 161 *
Brakkion 47:8ae30057edc0 162 * \retval true on success
Brakkion 47:8ae30057edc0 163 */
Brakkion 47:8ae30057edc0 164 {
Brakkion 47:8ae30057edc0 165 uint32_t un_temp;
Brakkion 47:8ae30057edc0 166 unsigned char uch_temp;
Brakkion 47:8ae30057edc0 167 *pun_red_led=0;
Brakkion 47:8ae30057edc0 168 *pun_ir_led=0;
Brakkion 47:8ae30057edc0 169 char ach_i2c_data[6];
Brakkion 47:8ae30057edc0 170
Brakkion 47:8ae30057edc0 171 //read and clear status register
Brakkion 47:8ae30057edc0 172 maxim_max30102_read_reg(REG_INTR_STATUS_1, &uch_temp);
Brakkion 47:8ae30057edc0 173 maxim_max30102_read_reg(REG_INTR_STATUS_2, &uch_temp);
Brakkion 47:8ae30057edc0 174
Brakkion 47:8ae30057edc0 175 ach_i2c_data[0]=REG_FIFO_DATA;
Brakkion 47:8ae30057edc0 176 if(i2c.write(I2C_WRITE_ADDR, ach_i2c_data, 1, true)!=0)
Brakkion 47:8ae30057edc0 177 return false;
Brakkion 47:8ae30057edc0 178 if(i2c.read(I2C_READ_ADDR, ach_i2c_data, 6, false)!=0)
Brakkion 47:8ae30057edc0 179 {
Brakkion 47:8ae30057edc0 180 return false;
Brakkion 47:8ae30057edc0 181 }
Brakkion 47:8ae30057edc0 182 un_temp=(unsigned char) ach_i2c_data[0];
Brakkion 47:8ae30057edc0 183 un_temp<<=16;
Brakkion 47:8ae30057edc0 184 *pun_red_led+=un_temp;
Brakkion 47:8ae30057edc0 185 un_temp=(unsigned char) ach_i2c_data[1];
Brakkion 47:8ae30057edc0 186 un_temp<<=8;
Brakkion 47:8ae30057edc0 187 *pun_red_led+=un_temp;
Brakkion 47:8ae30057edc0 188 un_temp=(unsigned char) ach_i2c_data[2];
Brakkion 47:8ae30057edc0 189 *pun_red_led+=un_temp;
Brakkion 47:8ae30057edc0 190
Brakkion 47:8ae30057edc0 191 un_temp=(unsigned char) ach_i2c_data[3];
Brakkion 47:8ae30057edc0 192 un_temp<<=16;
Brakkion 47:8ae30057edc0 193 *pun_ir_led+=un_temp;
Brakkion 47:8ae30057edc0 194 un_temp=(unsigned char) ach_i2c_data[4];
Brakkion 47:8ae30057edc0 195 un_temp<<=8;
Brakkion 47:8ae30057edc0 196 *pun_ir_led+=un_temp;
Brakkion 47:8ae30057edc0 197 un_temp=(unsigned char) ach_i2c_data[5];
Brakkion 47:8ae30057edc0 198 *pun_ir_led+=un_temp;
Brakkion 47:8ae30057edc0 199 *pun_red_led&=0x03FFFF; //Mask MSB [23:18]
Brakkion 47:8ae30057edc0 200 *pun_ir_led&=0x03FFFF; //Mask MSB [23:18]
Brakkion 47:8ae30057edc0 201
Brakkion 47:8ae30057edc0 202
Brakkion 47:8ae30057edc0 203 return true;
Brakkion 47:8ae30057edc0 204 }
Brakkion 47:8ae30057edc0 205
Brakkion 47:8ae30057edc0 206 bool maxim_max30102_reset()
Brakkion 47:8ae30057edc0 207 /**
Brakkion 47:8ae30057edc0 208 * \brief Reset the MAX30102
Brakkion 47:8ae30057edc0 209 * \par Details
Brakkion 47:8ae30057edc0 210 * This function resets the MAX30102
Brakkion 47:8ae30057edc0 211 *
Brakkion 47:8ae30057edc0 212 * \param None
Brakkion 47:8ae30057edc0 213 *
Brakkion 47:8ae30057edc0 214 * \retval true on success
Brakkion 47:8ae30057edc0 215 */
Brakkion 47:8ae30057edc0 216 {
Brakkion 47:8ae30057edc0 217 if(!maxim_max30102_write_reg(REG_MODE_CONFIG,0x40))
Brakkion 47:8ae30057edc0 218 return false;
Brakkion 47:8ae30057edc0 219 else
Brakkion 47:8ae30057edc0 220 return true;
Brakkion 47:8ae30057edc0 221 }