Productize / MAX30205

Fork of Maxim's human body temp sensor library that works with mbed-os 5

Fork of MAX30205 by Maxim Integrated

MAX30205.h@1:d4271ef9f37f, 2017-04-06 (annotated)

Committer:
j3
Date:
Thu Apr 06 00:05:03 2017 +0000
Revision:
1:d4271ef9f37f
Parent:
0:cdad7a9ef486
Child:
3:939090042b32
reworked a little more

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 0:cdad7a9ef486 1 /*******************************************************************************
j3 1:d4271ef9f37f 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
j3 0:cdad7a9ef486 3 *
j3 0:cdad7a9ef486 4 * Permission is hereby granted, free of charge, to any person obtaining a
j3 0:cdad7a9ef486 5 * copy of this software and associated documentation files (the "Software"),
j3 0:cdad7a9ef486 6 * to deal in the Software without restriction, including without limitation
j3 0:cdad7a9ef486 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 0:cdad7a9ef486 8 * and/or sell copies of the Software, and to permit persons to whom the
j3 0:cdad7a9ef486 9 * Software is furnished to do so, subject to the following conditions:
j3 0:cdad7a9ef486 10 *
j3 0:cdad7a9ef486 11 * The above copyright notice and this permission notice shall be included
j3 0:cdad7a9ef486 12 * in all copies or substantial portions of the Software.
j3 0:cdad7a9ef486 13 *
j3 0:cdad7a9ef486 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 0:cdad7a9ef486 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 0:cdad7a9ef486 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 0:cdad7a9ef486 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 0:cdad7a9ef486 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 0:cdad7a9ef486 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 0:cdad7a9ef486 20 * OTHER DEALINGS IN THE SOFTWARE.
j3 0:cdad7a9ef486 21 *
j3 0:cdad7a9ef486 22 * Except as contained in this notice, the name of Maxim Integrated
j3 0:cdad7a9ef486 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 0:cdad7a9ef486 24 * Products, Inc. Branding Policy.
j3 0:cdad7a9ef486 25 *
j3 0:cdad7a9ef486 26 * The mere transfer of this software does not imply any licenses
j3 0:cdad7a9ef486 27 * of trade secrets, proprietary technology, copyrights, patents,
j3 0:cdad7a9ef486 28 * trademarks, maskwork rights, or any other form of intellectual
j3 0:cdad7a9ef486 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 0:cdad7a9ef486 30 * ownership rights.
j3 0:cdad7a9ef486 31 *******************************************************************************
j3 0:cdad7a9ef486 32 */
j3 0:cdad7a9ef486 33 #ifndef __MAX30205_H_
j3 0:cdad7a9ef486 34 #define __MAX30205_H_
j3 0:cdad7a9ef486 35
j3 0:cdad7a9ef486 36 #include "mbed.h"
j3 0:cdad7a9ef486 37
j3 0:cdad7a9ef486 38 /**
j3 0:cdad7a9ef486 39 * Driver for the MAX30205
j3 0:cdad7a9ef486 40 *
j3 0:cdad7a9ef486 41 * @code
j3 0:cdad7a9ef486 42 * #include "mbed.h"
j3 0:cdad7a9ef486 43 * #include "MAX30205.h"
j3 0:cdad7a9ef486 44 *
j3 0:cdad7a9ef486 45 * int main(void)
j3 0:cdad7a9ef486 46 * {
j3 0:cdad7a9ef486 47 * I2C i2c(I2C_SDA, I2C_SCL);
j3 0:cdad7a9ef486 48 * MAX30205 sensor(i2c);
j3 0:cdad7a9ef486 49 *
j3 0:cdad7a9ef486 50 * //use sensor
j3 0:cdad7a9ef486 51 * }
j3 0:cdad7a9ef486 52 * @endcode
j3 0:cdad7a9ef486 53 */
j3 0:cdad7a9ef486 54
j3 0:cdad7a9ef486 55 class MAX30205
j3 0:cdad7a9ef486 56 {
j3 0:cdad7a9ef486 57
j3 0:cdad7a9ef486 58 public:
j3 0:cdad7a9ef486 59 /// MAX30205 Register Addresses
j3 0:cdad7a9ef486 60 enum Registers
j3 0:cdad7a9ef486 61 {
j3 0:cdad7a9ef486 62 Temperature = 0x00,
j3 0:cdad7a9ef486 63 Configuration = 0x01,
j3 0:cdad7a9ef486 64 THYST = 0x02,
j3 0:cdad7a9ef486 65 TOS = 0x03
j3 0:cdad7a9ef486 66 };
j3 1:d4271ef9f37f 67
j3 1:d4271ef9f37f 68 ///MAX30205 Configuration register bitfields
j3 1:d4271ef9f37f 69 union Config
j3 1:d4271ef9f37f 70 {
j3 1:d4271ef9f37f 71 uint8_t all;
j3 1:d4271ef9f37f 72 struct BitField
j3 1:d4271ef9f37f 73 {
j3 1:d4271ef9f37f 74 uint8_t shutdown : 1;
j3 1:d4271ef9f37f 75 uint8_t comp_int : 1;
j3 1:d4271ef9f37f 76 uint8_t os_polarity : 1;
j3 1:d4271ef9f37f 77 uint8_t fault_queue : 2;
j3 1:d4271ef9f37f 78 uint8_t data_format : 1;
j3 1:d4271ef9f37f 79 uint8_t timeout : 1;
j3 1:d4271ef9f37f 80 uint8_t one_shot : 1;
j3 1:d4271ef9f37f 81 }bits;
j3 1:d4271ef9f37f 82 };
j3 0:cdad7a9ef486 83
j3 0:cdad7a9ef486 84 /**
j3 0:cdad7a9ef486 85 * @brief Constructor using I2C PinNames
j3 0:cdad7a9ef486 86 * @param sda - Pinname for sda
j3 0:cdad7a9ef486 87 * @param scl - Pinname for scl
j3 0:cdad7a9ef486 88 * @param slaveAddress - 7-bit I2C address
j3 0:cdad7a9ef486 89 */
j3 1:d4271ef9f37f 90 MAX30205(PinName sda, PinName scl, uint8_t slaveAddress, PinName os = NC);
j3 0:cdad7a9ef486 91
j3 0:cdad7a9ef486 92 /**
j3 0:cdad7a9ef486 93 * @brief Constructor using reference to I2C object
j3 0:cdad7a9ef486 94 * @param i2c - Reference to I2C object
j3 0:cdad7a9ef486 95 * @param slaveAddress - 7-bit I2C address
j3 0:cdad7a9ef486 96 */
j3 1:d4271ef9f37f 97 MAX30205(I2C &i2c, uint8_t slaveAddress, PinName os = NC);
j3 0:cdad7a9ef486 98
j3 0:cdad7a9ef486 99 /** @brief Destructor */
j3 0:cdad7a9ef486 100 ~MAX30205(void);
j3 0:cdad7a9ef486 101
j3 0:cdad7a9ef486 102 /**
j3 0:cdad7a9ef486 103 * @brief Read the temperature from the device into a 16 bit value
j3 0:cdad7a9ef486 104 * @param[out] value - Raw temperature data on success
j3 0:cdad7a9ef486 105 * @return 0 on success, non-zero on failure
j3 0:cdad7a9ef486 106 */
j3 1:d4271ef9f37f 107 int32_t readTemperature(uint16_t &value);
j3 1:d4271ef9f37f 108
j3 1:d4271ef9f37f 109 /**
j3 1:d4271ef9f37f 110 * @brief Read the configuration register
j3 1:d4271ef9f37f 111 * @param config - Reference to Configuration type
j3 1:d4271ef9f37f 112 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 113 */
j3 1:d4271ef9f37f 114 int32_t readConfiguration(Config &config);
j3 1:d4271ef9f37f 115
j3 1:d4271ef9f37f 116 /**
j3 1:d4271ef9f37f 117 * @brief Write the configuration register with given configuration
j3 1:d4271ef9f37f 118 * @param config - Configuration to write
j3 1:d4271ef9f37f 119 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 120 */
j3 1:d4271ef9f37f 121 int32_t writeConfiguration(const Config config);
j3 0:cdad7a9ef486 122
j3 0:cdad7a9ef486 123 /**
j3 0:cdad7a9ef486 124 * @brief Read the THYST value from a specified device instance
j3 0:cdad7a9ef486 125 * @param[out] value - THYST register value on success
j3 0:cdad7a9ef486 126 * @return 0 on success, non-zero on failure
j3 0:cdad7a9ef486 127 */
j3 1:d4271ef9f37f 128 int32_t readTHYST(uint16_t &value);
j3 0:cdad7a9ef486 129
j3 0:cdad7a9ef486 130 /**
j3 0:cdad7a9ef486 131 * @brief Write the THYST to a device instance
j3 0:cdad7a9ef486 132 * @param value - 16-bit value to write
j3 0:cdad7a9ef486 133 * @return 0 on success, non-zero on failure
j3 0:cdad7a9ef486 134 */
j3 1:d4271ef9f37f 135 int32_t writeTHYST(const uint16_t value);
j3 1:d4271ef9f37f 136
j3 1:d4271ef9f37f 137 /**
j3 1:d4271ef9f37f 138 * @brief Read the TOS value from device
j3 1:d4271ef9f37f 139 * @param[out] value - TOS register value on success
j3 1:d4271ef9f37f 140 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 141 */
j3 1:d4271ef9f37f 142 int32_t readTOS(uint16_t &value);
j3 1:d4271ef9f37f 143
j3 1:d4271ef9f37f 144 /**
j3 1:d4271ef9f37f 145 * @brief Write the TOS register
j3 1:d4271ef9f37f 146 * @param value - 16-bit value to write
j3 1:d4271ef9f37f 147 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 148 */
j3 1:d4271ef9f37f 149 int32_t writeTOS(const uint16_t value);
j3 0:cdad7a9ef486 150
j3 0:cdad7a9ef486 151 /**
j3 0:cdad7a9ef486 152 * @brief Convert a raw temperature value into a float
j3 0:cdad7a9ef486 153 * @param rawTemp - raw temperature value to convert
j3 0:cdad7a9ef486 154 * @return the convereted value in degrees C
j3 0:cdad7a9ef486 155 */
j3 0:cdad7a9ef486 156 float toCelsius(uint32_t rawTemp);
j3 0:cdad7a9ef486 157
j3 0:cdad7a9ef486 158 /**
j3 0:cdad7a9ef486 159 * @brief Convert the passed in temperature in C to Fahrenheit
j3 0:cdad7a9ef486 160 * @param temperatureC Temperature in C to convert
j3 0:cdad7a9ef486 161 * @returns Returns the converted Fahrenheit value
j3 0:cdad7a9ef486 162 */
j3 0:cdad7a9ef486 163 float toFahrenheit(float temperatureC);
j3 1:d4271ef9f37f 164
j3 1:d4271ef9f37f 165 protected:
j3 1:d4271ef9f37f 166
j3 1:d4271ef9f37f 167 /**
j3 1:d4271ef9f37f 168 * @brief Write register of device at slave address
j3 1:d4271ef9f37f 169 * @param reg - Register address
j3 1:d4271ef9f37f 170 * @param value - Value to write
j3 1:d4271ef9f37f 171 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 172 */
j3 1:d4271ef9f37f 173 int32_t writeRegister(Registers reg, uint16_t value);
j3 1:d4271ef9f37f 174
j3 1:d4271ef9f37f 175 /**
j3 1:d4271ef9f37f 176 * @brief Read register of device at slave address
j3 1:d4271ef9f37f 177 * @param reg - Register address
j3 1:d4271ef9f37f 178 * @param[out] value - Read data on success
j3 1:d4271ef9f37f 179 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 180 */
j3 1:d4271ef9f37f 181 int32_t readRegister(Registers reg, uint16_t &value);
j3 0:cdad7a9ef486 182
j3 0:cdad7a9ef486 183 private:
j3 0:cdad7a9ef486 184 /// I2C object
j3 0:cdad7a9ef486 185 I2C m_i2c;
j3 0:cdad7a9ef486 186 /// Device slave address
j3 0:cdad7a9ef486 187 uint8_t m_writeAddress, m_readAddress;
j3 1:d4271ef9f37f 188 /// Over temperature shutdown interrupt pin
j3 1:d4271ef9f37f 189 DigitalIn m_os;
j3 0:cdad7a9ef486 190 };
j3 0:cdad7a9ef486 191
j3 0:cdad7a9ef486 192 #endif /* __MAX30205_H_ */