Yu anning / Mbed 2 deprecated LPC_MAX30102

the MAX30102 driver for LPC1768 board

Dependencies:   mbed

MAX30102/MAX30102.cpp@0:82a90765baa2, 2018-10-26 (annotated)

Committer:
anning865
Date:
Fri Oct 26 10:30:22 2018 +0000
Revision:
0:82a90765baa2
The MAX30102 driver for LPC1768

Who changed what in which revision?

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