dogukan barkan / Mbed 2 deprecated HSP_SpO2

SpO2 algorithm used in MAX30101 onboard MAX32620HSP. Algorithm is not perfect but it works

Dependencies:   mbed MAX14720 USBDevice

MAX30102/MAX30102.cpp@0:af4d13000e95, 2019-03-28 (annotated)

Committer:
douqan93
Date:
Thu Mar 28 08:07:54 2019 +0000
Revision:
0:af4d13000e95
This program for MAX32620HSP's onboard SpO2 sensor (MAX30101). Algorithm is not perfect but it works.

Who changed what in which revision?

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