Maxim Integrated / MAX30101

Library for MAX30101 SpO2 and heart rate sensor

Dependents:   HeartRate HeartRate proj final_project_ee119 ... more

MAX30101.cpp@2:0db1f3bec727, 2017-05-01 (annotated)

Committer:
j3
Date:
Mon May 01 21:00:34 2017 +0000
Revision:
2:0db1f3bec727
Parent:
1:9e2a3b4a24c7
Child:
3:a2effad05c99
Added mbr fx implementations

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 0:2d0c91de9279 1 /*******************************************************************************
j3 0:2d0c91de9279 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
j3 0:2d0c91de9279 3 *
j3 0:2d0c91de9279 4 * Permission is hereby granted, free of charge, to any person obtaining a
j3 0:2d0c91de9279 5 * copy of this software and associated documentation files (the "Software"),
j3 0:2d0c91de9279 6 * to deal in the Software without restriction, including without limitation
j3 0:2d0c91de9279 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 0:2d0c91de9279 8 * and/or sell copies of the Software, and to permit persons to whom the
j3 0:2d0c91de9279 9 * Software is furnished to do so, subject to the following conditions:
j3 0:2d0c91de9279 10 *
j3 0:2d0c91de9279 11 * The above copyright notice and this permission notice shall be included
j3 0:2d0c91de9279 12 * in all copies or substantial portions of the Software.
j3 0:2d0c91de9279 13 *
j3 0:2d0c91de9279 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 0:2d0c91de9279 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 0:2d0c91de9279 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 0:2d0c91de9279 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 0:2d0c91de9279 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 0:2d0c91de9279 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 0:2d0c91de9279 20 * OTHER DEALINGS IN THE SOFTWARE.
j3 0:2d0c91de9279 21 *
j3 0:2d0c91de9279 22 * Except as contained in this notice, the name of Maxim Integrated
j3 0:2d0c91de9279 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 0:2d0c91de9279 24 * Products, Inc. Branding Policy.
j3 0:2d0c91de9279 25 *
j3 0:2d0c91de9279 26 * The mere transfer of this software does not imply any licenses
j3 0:2d0c91de9279 27 * of trade secrets, proprietary technology, copyrights, patents,
j3 0:2d0c91de9279 28 * trademarks, maskwork rights, or any other form of intellectual
j3 0:2d0c91de9279 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 0:2d0c91de9279 30 * ownership rights.
j3 0:2d0c91de9279 31 *******************************************************************************
j3 0:2d0c91de9279 32 */
j3 0:2d0c91de9279 33
j3 0:2d0c91de9279 34
j3 0:2d0c91de9279 35 #include "MAX30101.h"
j3 0:2d0c91de9279 36
j3 0:2d0c91de9279 37
j3 0:2d0c91de9279 38 //*****************************************************************************
j3 0:2d0c91de9279 39 MAX30101::MAX30101(PinName sda, PinName scl):
j3 0:2d0c91de9279 40 m_i2cBus(sda, scl)
j3 0:2d0c91de9279 41 {
j3 0:2d0c91de9279 42 //empty block
j3 0:2d0c91de9279 43 }
j3 0:2d0c91de9279 44
j3 0:2d0c91de9279 45
j3 0:2d0c91de9279 46 //*****************************************************************************
j3 0:2d0c91de9279 47 MAX30101::MAX30101(I2C &i2c):
j3 0:2d0c91de9279 48 m_i2cBus(i2c)
j3 0:2d0c91de9279 49 {
j3 0:2d0c91de9279 50 //empty block
j3 0:2d0c91de9279 51 }
j3 0:2d0c91de9279 52
j3 0:2d0c91de9279 53
j3 0:2d0c91de9279 54 //*****************************************************************************
j3 0:2d0c91de9279 55 MAX30101::~MAX30101()
j3 0:2d0c91de9279 56 {
j3 0:2d0c91de9279 57 //empty block
j3 0:2d0c91de9279 58 }
j3 0:2d0c91de9279 59
j3 0:2d0c91de9279 60
j3 0:2d0c91de9279 61 //*****************************************************************************
j3 0:2d0c91de9279 62 int32_t MAX30101::enableInterrupts(const InterruptBitField_u data)
j3 0:2d0c91de9279 63 {
j3 0:2d0c91de9279 64 char cmdData[3] = {InterruptEnable1, (data.all & 0xF0), (data.all & 0x02)};
j3 0:2d0c91de9279 65
j3 0:2d0c91de9279 66 return m_i2cBus.write(I2C_W_ADRS, cmdData, 3);
j3 0:2d0c91de9279 67 }
j3 0:2d0c91de9279 68
j3 0:2d0c91de9279 69
j3 0:2d0c91de9279 70 //*****************************************************************************
j3 0:2d0c91de9279 71 int32_t MAX30101::getInterruptStatus(InterruptBitField_u &data)
j3 0:2d0c91de9279 72 {
j3 0:2d0c91de9279 73 char local_data[3];
j3 0:2d0c91de9279 74 local_data[0] = InterruptStatus1;
j3 0:2d0c91de9279 75
j3 0:2d0c91de9279 76 int32_t result = m_i2cBus.write(I2C_W_ADRS, local_data, 1);
j3 0:2d0c91de9279 77 if(result == 0)
j3 0:2d0c91de9279 78 {
j3 0:2d0c91de9279 79 result = m_i2cBus.read(I2C_R_ADRS, (local_data + 1), 2);
j3 0:2d0c91de9279 80 if(result == 0)
j3 0:2d0c91de9279 81 {
j3 0:2d0c91de9279 82 data.all = local_data[1] + local_data[2];
j3 0:2d0c91de9279 83 }
j3 0:2d0c91de9279 84 }
j3 0:2d0c91de9279 85
j3 0:2d0c91de9279 86 return result;
j3 0:2d0c91de9279 87 }
j3 0:2d0c91de9279 88
j3 0:2d0c91de9279 89
j3 0:2d0c91de9279 90 //*****************************************************************************
j3 1:9e2a3b4a24c7 91 int32_t MAX30101::setFIFOConfiguration(const FIFO_Configuration_u config)
j3 1:9e2a3b4a24c7 92 {
j3 2:0db1f3bec727 93 return writeRegister(FIFO_Configuration, config.all);
j3 1:9e2a3b4a24c7 94 }
j3 1:9e2a3b4a24c7 95
j3 1:9e2a3b4a24c7 96
j3 1:9e2a3b4a24c7 97 //*****************************************************************************
j3 1:9e2a3b4a24c7 98 int32_t MAX30101::getFIFOConfiguration(FIFO_Configuration_u &config)
j3 1:9e2a3b4a24c7 99 {
j3 2:0db1f3bec727 100 return readRegister(FIFO_Configuration, config.all);
j3 1:9e2a3b4a24c7 101 }
j3 1:9e2a3b4a24c7 102
j3 1:9e2a3b4a24c7 103
j3 1:9e2a3b4a24c7 104 //*****************************************************************************
j3 1:9e2a3b4a24c7 105 int32_t MAX30101::setModeConfiguration(const ModeConfiguration_u config)
j3 1:9e2a3b4a24c7 106 {
j3 2:0db1f3bec727 107 return writeRegister(ModeConfiguration, (config.all & 0xC7));
j3 1:9e2a3b4a24c7 108 }
j3 1:9e2a3b4a24c7 109
j3 1:9e2a3b4a24c7 110
j3 1:9e2a3b4a24c7 111 //*****************************************************************************
j3 1:9e2a3b4a24c7 112 int32_t MAX30101::getModeConfiguration(ModeConfiguration_u &config)
j3 1:9e2a3b4a24c7 113 {
j3 2:0db1f3bec727 114 return readRegister(ModeConfiguration, config.all);
j3 1:9e2a3b4a24c7 115 }
j3 1:9e2a3b4a24c7 116
j3 1:9e2a3b4a24c7 117
j3 1:9e2a3b4a24c7 118 //*****************************************************************************
j3 1:9e2a3b4a24c7 119 int32_t MAX30101::setSpO2Configuration(const SpO2Configuration_u config)
j3 1:9e2a3b4a24c7 120 {
j3 2:0db1f3bec727 121 return writeRegister(SpO2Configuration, (config.all & 0x7F));
j3 1:9e2a3b4a24c7 122 }
j3 1:9e2a3b4a24c7 123
j3 1:9e2a3b4a24c7 124
j3 1:9e2a3b4a24c7 125 //*****************************************************************************
j3 1:9e2a3b4a24c7 126 int32_t MAX30101::getSpO2Configuration(SpO2Configuration_u &config)
j3 1:9e2a3b4a24c7 127 {
j3 2:0db1f3bec727 128 return readRegister(SpO2Configuration, config.all);
j3 1:9e2a3b4a24c7 129 }
j3 1:9e2a3b4a24c7 130
j3 1:9e2a3b4a24c7 131
j3 1:9e2a3b4a24c7 132 //*****************************************************************************
j3 1:9e2a3b4a24c7 133 int32_t MAX30101::setLEDPulseAmplitude(Registers_e reg, const uint8_t amp)
j3 1:9e2a3b4a24c7 134 {
j3 2:0db1f3bec727 135 return writeRegister(reg, amp);
j3 1:9e2a3b4a24c7 136 }
j3 1:9e2a3b4a24c7 137
j3 1:9e2a3b4a24c7 138
j3 1:9e2a3b4a24c7 139 //*****************************************************************************
j3 1:9e2a3b4a24c7 140 int32_t MAX30101::getLEDPulseAmplitude(Registers_e reg, uint8_t &amp)
j3 1:9e2a3b4a24c7 141 {
j3 2:0db1f3bec727 142 return readRegister(reg, amp);
j3 1:9e2a3b4a24c7 143 }
j3 1:9e2a3b4a24c7 144
j3 1:9e2a3b4a24c7 145
j3 1:9e2a3b4a24c7 146 //*****************************************************************************
j3 1:9e2a3b4a24c7 147 int32_t MAX30101::setMultiLEDModeControl(Registers_e reg, const ModeControlReg_u data)
j3 1:9e2a3b4a24c7 148 {
j3 2:0db1f3bec727 149 return writeRegister(reg, data.all);
j3 1:9e2a3b4a24c7 150 }
j3 1:9e2a3b4a24c7 151
j3 1:9e2a3b4a24c7 152
j3 1:9e2a3b4a24c7 153 //*****************************************************************************
j3 1:9e2a3b4a24c7 154 int32_t MAX30101::getMultiLEDModeControl(Registers_e reg, ModeControlReg_u &data)
j3 1:9e2a3b4a24c7 155 {
j3 2:0db1f3bec727 156 return readRegister(reg, data.all);
j3 1:9e2a3b4a24c7 157 }
j3 1:9e2a3b4a24c7 158
j3 1:9e2a3b4a24c7 159
j3 1:9e2a3b4a24c7 160 //*****************************************************************************
j3 1:9e2a3b4a24c7 161 int32_t MAX30101::getDieTemperature(uint16_t &data)
j3 1:9e2a3b4a24c7 162 {
j3 2:0db1f3bec727 163 int32_t result = -1;
j3 2:0db1f3bec727 164
j3 2:0db1f3bec727 165 //Die temp conversion time is 30ms
j3 2:0db1f3bec727 166 //ATTEMPTS > than 30ms at 100KHz SCL for getInterruptStatus call
j3 2:0db1f3bec727 167 const uint32_t ATTEMPTS = 100;
j3 2:0db1f3bec727 168 uint32_t num_reads = 0;
j3 2:0db1f3bec727 169
j3 2:0db1f3bec727 170 //local i2c transaction buffer
j3 2:0db1f3bec727 171 char local_data[2];
j3 2:0db1f3bec727 172 local_data[0] = DieTempConfig;
j3 2:0db1f3bec727 173 local_data[1] = 1;
j3 2:0db1f3bec727 174
j3 2:0db1f3bec727 175 //initiate die temp conversion
j3 2:0db1f3bec727 176 result = m_i2cBus.write(I2C_W_ADRS, local_data, 2, true);
j3 2:0db1f3bec727 177 if(result == 0)
j3 2:0db1f3bec727 178 {
j3 2:0db1f3bec727 179 //object for holding status registers data
j3 2:0db1f3bec727 180 InterruptBitField_u status;
j3 2:0db1f3bec727 181 status.all = 0;
j3 2:0db1f3bec727 182
j3 2:0db1f3bec727 183 //poll status registers until temp ready, or read fails
j3 2:0db1f3bec727 184 do
j3 2:0db1f3bec727 185 {
j3 2:0db1f3bec727 186 result = getInterruptStatus(status);
j3 2:0db1f3bec727 187 num_reads++;
j3 2:0db1f3bec727 188 }
j3 2:0db1f3bec727 189 while(!status.bits.die_temp && (result == 0) && (num_reads < ATTEMPTS));
j3 2:0db1f3bec727 190
j3 2:0db1f3bec727 191 if(status.bits.die_temp)
j3 2:0db1f3bec727 192 {
j3 2:0db1f3bec727 193 //set pointer to temperature integer register
j3 2:0db1f3bec727 194 local_data[0] = DieTempInt;
j3 2:0db1f3bec727 195 result = m_i2cBus.write(I2C_W_ADRS, local_data, 1, true);
j3 2:0db1f3bec727 196 if(result == 0)
j3 2:0db1f3bec727 197 {
j3 2:0db1f3bec727 198 //read two bytes
j3 2:0db1f3bec727 199 result = m_i2cBus.read(I2C_R_ADRS, local_data, 2);
j3 2:0db1f3bec727 200 if(result == 0)
j3 2:0db1f3bec727 201 {
j3 2:0db1f3bec727 202 //stuff data
j3 2:0db1f3bec727 203 data = ( (local_data[0] << 8) | (local_data[1] << 4) );
j3 2:0db1f3bec727 204 data = (data >> 4);
j3 2:0db1f3bec727 205 }
j3 2:0db1f3bec727 206 }
j3 2:0db1f3bec727 207 }
j3 2:0db1f3bec727 208 else
j3 2:0db1f3bec727 209 {
j3 2:0db1f3bec727 210 //if result equals 0 because num_reads exceeded ATTEMPTS,
j3 2:0db1f3bec727 211 //change result to -1. Otherwise keep result's error code.
j3 2:0db1f3bec727 212 result = (result == 0) ? -1 : result;
j3 2:0db1f3bec727 213 }
j3 2:0db1f3bec727 214 }
j3 2:0db1f3bec727 215 return result;
j3 1:9e2a3b4a24c7 216 }
j3 1:9e2a3b4a24c7 217
j3 1:9e2a3b4a24c7 218
j3 1:9e2a3b4a24c7 219 //*****************************************************************************
j3 1:9e2a3b4a24c7 220 int32_t MAX30101::getDieTemperatureC(float &data)
j3 1:9e2a3b4a24c7 221 {
j3 2:0db1f3bec727 222 uint16_t raw_temp;
j3 2:0db1f3bec727 223
j3 2:0db1f3bec727 224 int32_t result = getDieTemperature(raw_temp);
j3 2:0db1f3bec727 225 if(result == 0)
j3 2:0db1f3bec727 226 {
j3 2:0db1f3bec727 227 if(raw_temp & 0x0800)
j3 2:0db1f3bec727 228 {
j3 2:0db1f3bec727 229 data = ((0xFFFFF000 | raw_temp)/16.0F);
j3 2:0db1f3bec727 230 }
j3 2:0db1f3bec727 231 else
j3 2:0db1f3bec727 232 {
j3 2:0db1f3bec727 233 data = (raw_temp/16.0F);
j3 2:0db1f3bec727 234 }
j3 2:0db1f3bec727 235 }
j3 2:0db1f3bec727 236
j3 2:0db1f3bec727 237 return result;
j3 1:9e2a3b4a24c7 238 }
j3 1:9e2a3b4a24c7 239
j3 1:9e2a3b4a24c7 240
j3 1:9e2a3b4a24c7 241 //*****************************************************************************
j3 1:9e2a3b4a24c7 242 float MAX30101::celsius2fahrenheit(float c)
j3 1:9e2a3b4a24c7 243 {
j3 2:0db1f3bec727 244 return ((1.8F * c) + 32.0F);
j3 1:9e2a3b4a24c7 245 }
j3 1:9e2a3b4a24c7 246
j3 1:9e2a3b4a24c7 247
j3 1:9e2a3b4a24c7 248 //*****************************************************************************
j3 1:9e2a3b4a24c7 249 int32_t MAX30101::setProxIntThreshold(const uint8_t data)
j3 1:9e2a3b4a24c7 250 {
j3 2:0db1f3bec727 251 return writeRegister(ProxIntThreshold, data);
j3 1:9e2a3b4a24c7 252 }
j3 1:9e2a3b4a24c7 253
j3 1:9e2a3b4a24c7 254
j3 1:9e2a3b4a24c7 255 //*****************************************************************************
j3 1:9e2a3b4a24c7 256 int32_t MAX30101::getProxIntThreshold(uint8_t &data)
j3 1:9e2a3b4a24c7 257 {
j3 2:0db1f3bec727 258 return readRegister(ProxIntThreshold, data);
j3 1:9e2a3b4a24c7 259 }
j3 1:9e2a3b4a24c7 260
j3 1:9e2a3b4a24c7 261
j3 1:9e2a3b4a24c7 262 //*****************************************************************************
j3 0:2d0c91de9279 263 int32_t MAX30101::writeRegister(Registers_e reg, uint8_t value)
j3 0:2d0c91de9279 264 {
j3 0:2d0c91de9279 265 char local_data[2] = {reg, value};
j3 0:2d0c91de9279 266
j3 0:2d0c91de9279 267 return m_i2cBus.write(I2C_W_ADRS, local_data, 2);
j3 0:2d0c91de9279 268 }
j3 0:2d0c91de9279 269
j3 0:2d0c91de9279 270
j3 0:2d0c91de9279 271 //*****************************************************************************
j3 0:2d0c91de9279 272 int32_t MAX30101::readRegister(Registers_e reg, uint8_t &value)
j3 0:2d0c91de9279 273 {
j3 0:2d0c91de9279 274 int32_t result;
j3 0:2d0c91de9279 275
j3 0:2d0c91de9279 276 char local_data[2];
j3 0:2d0c91de9279 277 local_data[0] = reg;
j3 0:2d0c91de9279 278
j3 0:2d0c91de9279 279 result = m_i2cBus.write(I2C_W_ADRS, local_data, 1);
j3 0:2d0c91de9279 280 if(result == 0)
j3 0:2d0c91de9279 281 {
j3 0:2d0c91de9279 282 result = m_i2cBus.read(I2C_R_ADRS, (local_data + 1), 1);
j3 0:2d0c91de9279 283 if (result == 0)
j3 0:2d0c91de9279 284 {
j3 0:2d0c91de9279 285 value = local_data[1];
j3 0:2d0c91de9279 286 }
j3 0:2d0c91de9279 287 }
j3 0:2d0c91de9279 288
j3 0:2d0c91de9279 289 return result;
j3 0:2d0c91de9279 290 }
j3 0:2d0c91de9279 291