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@6:b5ab5204d944, 2017-04-11 (annotated)

Committer:
j3
Date:
Tue Apr 11 22:07:28 2017 +0000
Revision:
6:b5ab5204d944
Parent:
5:24039cc86fc1
Child:
7:f005887f21e7
added suffix to enum, union, struct declaration names (_e, _u, _s) for clarity

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 5:24039cc86fc1 43 * #include "max32630fthr.h"
j3 0:cdad7a9ef486 44 * #include "MAX30205.h"
j3 5:24039cc86fc1 45 *
j3 5:24039cc86fc1 46 * MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3);
j3 5:24039cc86fc1 47 *
j3 5:24039cc86fc1 48 * //Get I2C instance
j3 5:24039cc86fc1 49 * I2C i2cBus(P3_4, P3_5);
j3 5:24039cc86fc1 50 *
j3 5:24039cc86fc1 51 * //Get temp sensor instance
j3 5:24039cc86fc1 52 * MAX30205 bodyTempSensor(i2cBus, 0x4D); //Constructor takes 7-bit slave adrs
j3 0:cdad7a9ef486 53 *
j3 0:cdad7a9ef486 54 * int main(void)
j3 0:cdad7a9ef486 55 * {
j3 0:cdad7a9ef486 56 * //use sensor
j3 0:cdad7a9ef486 57 * }
j3 0:cdad7a9ef486 58 * @endcode
j3 0:cdad7a9ef486 59 */
j3 0:cdad7a9ef486 60
j3 0:cdad7a9ef486 61 class MAX30205
j3 0:cdad7a9ef486 62 {
j3 0:cdad7a9ef486 63
j3 0:cdad7a9ef486 64 public:
j3 0:cdad7a9ef486 65 /// MAX30205 Register Addresses
j3 6:b5ab5204d944 66 enum Registers_e
j3 0:cdad7a9ef486 67 {
j3 0:cdad7a9ef486 68 Temperature = 0x00,
j3 0:cdad7a9ef486 69 Configuration = 0x01,
j3 0:cdad7a9ef486 70 THYST = 0x02,
j3 0:cdad7a9ef486 71 TOS = 0x03
j3 0:cdad7a9ef486 72 };
j3 1:d4271ef9f37f 73
j3 1:d4271ef9f37f 74 ///MAX30205 Configuration register bitfields
j3 6:b5ab5204d944 75 union Configuration_u
j3 1:d4271ef9f37f 76 {
j3 1:d4271ef9f37f 77 uint8_t all;
j3 6:b5ab5204d944 78 struct BitField_s
j3 1:d4271ef9f37f 79 {
j3 1:d4271ef9f37f 80 uint8_t shutdown : 1;
j3 1:d4271ef9f37f 81 uint8_t comp_int : 1;
j3 1:d4271ef9f37f 82 uint8_t os_polarity : 1;
j3 1:d4271ef9f37f 83 uint8_t fault_queue : 2;
j3 1:d4271ef9f37f 84 uint8_t data_format : 1;
j3 1:d4271ef9f37f 85 uint8_t timeout : 1;
j3 1:d4271ef9f37f 86 uint8_t one_shot : 1;
j3 1:d4271ef9f37f 87 }bits;
j3 1:d4271ef9f37f 88 };
j3 0:cdad7a9ef486 89
j3 0:cdad7a9ef486 90 /**
j3 0:cdad7a9ef486 91 * @brief Constructor using I2C PinNames
j3 0:cdad7a9ef486 92 * @param sda - Pinname for sda
j3 0:cdad7a9ef486 93 * @param scl - Pinname for scl
j3 0:cdad7a9ef486 94 * @param slaveAddress - 7-bit I2C address
j3 0:cdad7a9ef486 95 */
j3 4:68e1b36becb0 96 MAX30205(PinName sda, PinName scl, uint8_t slaveAddress);
j3 0:cdad7a9ef486 97
j3 0:cdad7a9ef486 98 /**
j3 0:cdad7a9ef486 99 * @brief Constructor using reference to I2C object
j3 0:cdad7a9ef486 100 * @param i2c - Reference to I2C object
j3 0:cdad7a9ef486 101 * @param slaveAddress - 7-bit I2C address
j3 0:cdad7a9ef486 102 */
j3 4:68e1b36becb0 103 MAX30205(I2C &i2c, uint8_t slaveAddress);
j3 0:cdad7a9ef486 104
j3 0:cdad7a9ef486 105 /** @brief Destructor */
j3 0:cdad7a9ef486 106 ~MAX30205(void);
j3 0:cdad7a9ef486 107
j3 0:cdad7a9ef486 108 /**
j3 0:cdad7a9ef486 109 * @brief Read the temperature from the device into a 16 bit value
j3 0:cdad7a9ef486 110 * @param[out] value - Raw temperature data on success
j3 0:cdad7a9ef486 111 * @return 0 on success, non-zero on failure
j3 0:cdad7a9ef486 112 */
j3 1:d4271ef9f37f 113 int32_t readTemperature(uint16_t &value);
j3 1:d4271ef9f37f 114
j3 1:d4271ef9f37f 115 /**
j3 1:d4271ef9f37f 116 * @brief Read the configuration register
j3 1:d4271ef9f37f 117 * @param config - Reference to Configuration type
j3 1:d4271ef9f37f 118 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 119 */
j3 6:b5ab5204d944 120 int32_t readConfiguration(Configuration_u &config);
j3 1:d4271ef9f37f 121
j3 1:d4271ef9f37f 122 /**
j3 1:d4271ef9f37f 123 * @brief Write the configuration register with given configuration
j3 1:d4271ef9f37f 124 * @param config - Configuration to write
j3 1:d4271ef9f37f 125 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 126 */
j3 6:b5ab5204d944 127 int32_t writeConfiguration(const Configuration_u config);
j3 0:cdad7a9ef486 128
j3 0:cdad7a9ef486 129 /**
j3 0:cdad7a9ef486 130 * @brief Read the THYST value from a specified device instance
j3 0:cdad7a9ef486 131 * @param[out] value - THYST register value on success
j3 0:cdad7a9ef486 132 * @return 0 on success, non-zero on failure
j3 0:cdad7a9ef486 133 */
j3 1:d4271ef9f37f 134 int32_t readTHYST(uint16_t &value);
j3 0:cdad7a9ef486 135
j3 0:cdad7a9ef486 136 /**
j3 0:cdad7a9ef486 137 * @brief Write the THYST to a device instance
j3 0:cdad7a9ef486 138 * @param value - 16-bit value to write
j3 0:cdad7a9ef486 139 * @return 0 on success, non-zero on failure
j3 0:cdad7a9ef486 140 */
j3 1:d4271ef9f37f 141 int32_t writeTHYST(const uint16_t value);
j3 1:d4271ef9f37f 142
j3 1:d4271ef9f37f 143 /**
j3 1:d4271ef9f37f 144 * @brief Read the TOS value from device
j3 1:d4271ef9f37f 145 * @param[out] value - TOS register value on success
j3 1:d4271ef9f37f 146 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 147 */
j3 1:d4271ef9f37f 148 int32_t readTOS(uint16_t &value);
j3 1:d4271ef9f37f 149
j3 1:d4271ef9f37f 150 /**
j3 1:d4271ef9f37f 151 * @brief Write the TOS register
j3 1:d4271ef9f37f 152 * @param value - 16-bit value to write
j3 1:d4271ef9f37f 153 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 154 */
j3 1:d4271ef9f37f 155 int32_t writeTOS(const uint16_t value);
j3 0:cdad7a9ef486 156
j3 0:cdad7a9ef486 157 /**
j3 0:cdad7a9ef486 158 * @brief Convert a raw temperature value into a float
j3 0:cdad7a9ef486 159 * @param rawTemp - raw temperature value to convert
j3 0:cdad7a9ef486 160 * @return the convereted value in degrees C
j3 0:cdad7a9ef486 161 */
j3 0:cdad7a9ef486 162 float toCelsius(uint32_t rawTemp);
j3 0:cdad7a9ef486 163
j3 0:cdad7a9ef486 164 /**
j3 0:cdad7a9ef486 165 * @brief Convert the passed in temperature in C to Fahrenheit
j3 0:cdad7a9ef486 166 * @param temperatureC Temperature in C to convert
j3 0:cdad7a9ef486 167 * @returns Returns the converted Fahrenheit value
j3 0:cdad7a9ef486 168 */
j3 0:cdad7a9ef486 169 float toFahrenheit(float temperatureC);
j3 1:d4271ef9f37f 170
j3 1:d4271ef9f37f 171 protected:
j3 1:d4271ef9f37f 172
j3 1:d4271ef9f37f 173 /**
j3 1:d4271ef9f37f 174 * @brief Write register of device at slave address
j3 1:d4271ef9f37f 175 * @param reg - Register address
j3 1:d4271ef9f37f 176 * @param value - Value to write
j3 1:d4271ef9f37f 177 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 178 */
j3 6:b5ab5204d944 179 int32_t writeRegister(Registers_e reg, uint16_t value);
j3 1:d4271ef9f37f 180
j3 1:d4271ef9f37f 181 /**
j3 1:d4271ef9f37f 182 * @brief Read register of device at slave address
j3 1:d4271ef9f37f 183 * @param reg - Register address
j3 1:d4271ef9f37f 184 * @param[out] value - Read data on success
j3 1:d4271ef9f37f 185 * @return 0 on success, non-zero on failure
j3 1:d4271ef9f37f 186 */
j3 6:b5ab5204d944 187 int32_t readRegister(Registers_e reg, uint16_t &value);
j3 0:cdad7a9ef486 188
j3 0:cdad7a9ef486 189 private:
j3 0:cdad7a9ef486 190 /// I2C object
j3 0:cdad7a9ef486 191 I2C m_i2c;
j3 4:68e1b36becb0 192 /// Device slave addresses
j3 0:cdad7a9ef486 193 uint8_t m_writeAddress, m_readAddress;
j3 0:cdad7a9ef486 194 };
j3 0:cdad7a9ef486 195
j3 0:cdad7a9ef486 196 #endif /* __MAX30205_H_ */