Maxim Integrated / MAX30205_Clinical_Temperature_Sensor

Maxim Integrated MAX30205 C, C++ source code driver software: MAX30205 is accurate to +-0.1°C over the range of 37.0°C to 39.0°C. One-shot, shutdown modes are available for reduced power usage. Thermostat thresholds allow for temperature hysteresis or for alarm settings. The MAX30205 is available in a compact 3x3 mm, 8-pin TDFN package. Operating supply voltage range is 2.7V to 3.3V. Typical applications are for clinical digital thermometers, thermostats with hysteresis, and temperature alarms.

Dependents:   MAX30205_Human_Body_Temperature_Sensor

max30205_cpp.h@9:d98e4a80a866, 2019-04-15 (annotated)

Committer:
phonemacro
Date:
Mon Apr 15 21:18:33 2019 +0000
Revision:
9:d98e4a80a866
Child:
10:9c5dc1393570
Initial converstion to c, c++ code

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phonemacro 9:d98e4a80a866 1 /*******************************************************************************
phonemacro 9:d98e4a80a866 2 * Copyright (C) 2019 Maxim Integrated Products, Inc., All Rights Reserved.
phonemacro 9:d98e4a80a866 3 *
phonemacro 9:d98e4a80a866 4 * Permission is hereby granted, free of charge, to any person obtaining a
phonemacro 9:d98e4a80a866 5 * copy of this software and associated documentation files (the "Software"),
phonemacro 9:d98e4a80a866 6 * to deal in the Software without restriction, including without limitation
phonemacro 9:d98e4a80a866 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
phonemacro 9:d98e4a80a866 8 * and/or sell copies of the Software, and to permit persons to whom the
phonemacro 9:d98e4a80a866 9 * Software is furnished to do so, subject to the following conditions:
phonemacro 9:d98e4a80a866 10 *
phonemacro 9:d98e4a80a866 11 * The above copyright notice and this permission notice shall be included
phonemacro 9:d98e4a80a866 12 * in all copies or substantial portions of the Software.
phonemacro 9:d98e4a80a866 13 *
phonemacro 9:d98e4a80a866 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
phonemacro 9:d98e4a80a866 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
phonemacro 9:d98e4a80a866 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
phonemacro 9:d98e4a80a866 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
phonemacro 9:d98e4a80a866 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
phonemacro 9:d98e4a80a866 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
phonemacro 9:d98e4a80a866 20 * OTHER DEALINGS IN THE SOFTWARE.
phonemacro 9:d98e4a80a866 21 *
phonemacro 9:d98e4a80a866 22 * Except as contained in this notice, the name of Maxim Integrated
phonemacro 9:d98e4a80a866 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
phonemacro 9:d98e4a80a866 24 * Products, Inc. Branding Policy.
phonemacro 9:d98e4a80a866 25 *
phonemacro 9:d98e4a80a866 26 * The mere transfer of this software does not imply any licenses
phonemacro 9:d98e4a80a866 27 * of trade secrets, proprietary technology, copyrights, patents,
phonemacro 9:d98e4a80a866 28 * trademarks, maskwork rights, or any other form of intellectual
phonemacro 9:d98e4a80a866 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
phonemacro 9:d98e4a80a866 30 * ownership rights.
phonemacro 9:d98e4a80a866 31 *******************************************************************************
phonemacro 9:d98e4a80a866 32 * @file max30205_cpp.h
phonemacro 9:d98e4a80a866 33 *******************************************************************************
phonemacro 9:d98e4a80a866 34 */
phonemacro 9:d98e4a80a866 35 #ifndef MAX30205_CPP_H
phonemacro 9:d98e4a80a866 36 #define MAX30205_CPP_H
phonemacro 9:d98e4a80a866 37 #include "mbed.h"
phonemacro 9:d98e4a80a866 38
phonemacro 9:d98e4a80a866 39
phonemacro 9:d98e4a80a866 40 /**
phonemacro 9:d98e4a80a866 41 * @brief Digital thermometer, thermostat, temperature sensor.
phonemacro 9:d98e4a80a866 42 * @version 1.0001.0000
phonemacro 9:d98e4a80a866 43 *
phonemacro 9:d98e4a80a866 44 * @details The MAX30205, MAX31726 temperature sensors
phonemacro 9:d98e4a80a866 45 * provides accurate temperature measurements.
phonemacro 9:d98e4a80a866 46 * Extended format allows for high temperature readings up to 150°C.
phonemacro 9:d98e4a80a866 47 * The MAX30205 can operate in a low powered mode by utilizing
phonemacro 9:d98e4a80a866 48 * the shutdown and one-shot mode.
phonemacro 9:d98e4a80a866 49 * 8-pin TQDFN 3x3 mm package
phonemacro 9:d98e4a80a866 50 * Accuracy is +-0.5°C from -40°C to +105°C (-40°F to +221°).
phonemacro 9:d98e4a80a866 51 * Operating temperature: -55°C to +150°C (-67°F to +302°).
phonemacro 9:d98e4a80a866 52 * VDD: 2.5V to 3.7V.
phonemacro 9:d98e4a80a866 53 *
phonemacro 9:d98e4a80a866 54 * @code
phonemacro 9:d98e4a80a866 55 * #include "mbed.h"
phonemacro 9:d98e4a80a866 56 * #include "max32630fthr.h"
phonemacro 9:d98e4a80a866 57 * #include "max30205.h"
phonemacro 9:d98e4a80a866 58 * #include "USBSerial.h"
phonemacro 9:d98e4a80a866 59 * MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3);
phonemacro 9:d98e4a80a866 60 * I2C i2cBus(P3_4, P3_5);
phonemacro 9:d98e4a80a866 61 * int main()
phonemacro 9:d98e4a80a866 62 * {
phonemacro 9:d98e4a80a866 63 * float temperature;
phonemacro 9:d98e4a80a866 64 * DigitalOut rLED(LED1, LED_OFF);
phonemacro 9:d98e4a80a866 65 * DigitalOut gLED(LED2, LED_OFF);
phonemacro 9:d98e4a80a866 66 * DigitalOut bLED(LED3, LED_OFF);
phonemacro 9:d98e4a80a866 67 * gLED = LED_ON;
phonemacro 9:d98e4a80a866 68 * MAX30205 temp_sensor(i2cBus, MAX30205_I2C_SLAVE_ADR_00);
phonemacro 9:d98e4a80a866 69 * i2cBus.frequency(400000);
phonemacro 9:d98e4a80a866 70 * temperature =
phonemacro 9:d98e4a80a866 71 * temp_sensor.read_reg_as_temperature(MAX30205_REG_TEMPERATURE);
phonemacro 9:d98e4a80a866 72 * printf("Temperature = %3.4f Celsius, %3.4f Fahrenheit\r\n",
phonemacro 9:d98e4a80a866 73 * temperature, temp_sensor.celsius_to_fahrenheit(temperature));
phonemacro 9:d98e4a80a866 74 * }
phonemacro 9:d98e4a80a866 75 * @endcode
phonemacro 9:d98e4a80a866 76 */
phonemacro 9:d98e4a80a866 77
phonemacro 9:d98e4a80a866 78 class MAX30205
phonemacro 9:d98e4a80a866 79 {
phonemacro 9:d98e4a80a866 80 public:
phonemacro 9:d98e4a80a866 81
phonemacro 9:d98e4a80a866 82 /**********************************************************//**
phonemacro 9:d98e4a80a866 83 * @brief Constructor for MAX30205 Class.
phonemacro 9:d98e4a80a866 84 *
phonemacro 9:d98e4a80a866 85 * @details Allows user to use existing I2C object
phonemacro 9:d98e4a80a866 86 *
phonemacro 9:d98e4a80a866 87 * On Entry:
phonemacro 9:d98e4a80a866 88 * @param[in] i2c_bus - pointer to existing I2C object
phonemacro 9:d98e4a80a866 89 * @param[in] i2c_adrs - 7-bit slave address of MAX30205
phonemacro 9:d98e4a80a866 90 *
phonemacro 9:d98e4a80a866 91 * On Exit:
phonemacro 9:d98e4a80a866 92 *
phonemacro 9:d98e4a80a866 93 * @return None
phonemacro 9:d98e4a80a866 94 **************************************************************/
phonemacro 9:d98e4a80a866 95 MAX30205(I2C &i2c_bus, uint8_t slave_address);
phonemacro 9:d98e4a80a866 96
phonemacro 9:d98e4a80a866 97 /**********************************************************//**
phonemacro 9:d98e4a80a866 98 * @brief Default destructor for MAX30205 Class.
phonemacro 9:d98e4a80a866 99 *
phonemacro 9:d98e4a80a866 100 * @details Destroys I2C object if owner
phonemacro 9:d98e4a80a866 101 *
phonemacro 9:d98e4a80a866 102 * On Entry:
phonemacro 9:d98e4a80a866 103 *
phonemacro 9:d98e4a80a866 104 * On Exit:
phonemacro 9:d98e4a80a866 105 *
phonemacro 9:d98e4a80a866 106 * @return None
phonemacro 9:d98e4a80a866 107 **************************************************************/
phonemacro 9:d98e4a80a866 108 ~MAX30205();
phonemacro 9:d98e4a80a866 109
phonemacro 9:d98e4a80a866 110 /**
phonemacro 9:d98e4a80a866 111 * @brief Read register of device at slave address
phonemacro 9:d98e4a80a866 112 * @param[out] value - Read data on success
phonemacro 9:d98e4a80a866 113 * @return 0 on success, negative number on failure
phonemacro 9:d98e4a80a866 114 */
phonemacro 9:d98e4a80a866 115 int read_cfg_reg(uint8_t *value);
phonemacro 9:d98e4a80a866 116
phonemacro 9:d98e4a80a866 117 /**
phonemacro 9:d98e4a80a866 118 * @brief Read register of device at slave address
phonemacro 9:d98e4a80a866 119 * @param[out] value - Read data on success
phonemacro 9:d98e4a80a866 120 * @param reg - Register address
phonemacro 9:d98e4a80a866 121 * @return 0 on success, negative number on failure
phonemacro 9:d98e4a80a866 122 */
phonemacro 9:d98e4a80a866 123 int read_reg16(int16_t *value, char reg);
phonemacro 9:d98e4a80a866 124
phonemacro 9:d98e4a80a866 125 /**
phonemacro 9:d98e4a80a866 126 * @brief Reads the temperature registers
phonemacro 9:d98e4a80a866 127 * @param reg - the address of the temperature register
phonemacro 9:d98e4a80a866 128 * @return temperature in degrees Celsius
phonemacro 9:d98e4a80a866 129 */
phonemacro 9:d98e4a80a866 130 float read_reg_as_temperature(uint8_t reg);
phonemacro 9:d98e4a80a866 131
phonemacro 9:d98e4a80a866 132 /**
phonemacro 9:d98e4a80a866 133 * @brief Writes to the configuration register
phonemacro 9:d98e4a80a866 134 * @param cfg - configurate word
phonemacro 9:d98e4a80a866 135 * @return 0 on success, negative number on failure
phonemacro 9:d98e4a80a866 136 */
phonemacro 9:d98e4a80a866 137 int write_cfg_reg(uint8_t cfg);
phonemacro 9:d98e4a80a866 138
phonemacro 9:d98e4a80a866 139 /**
phonemacro 9:d98e4a80a866 140 * @brief Writes to the THYST register
phonemacro 9:d98e4a80a866 141 * @param temperature - the temperature in Celsius degrees
phonemacro 9:d98e4a80a866 142 * @return 0 on success, negative number on failure
phonemacro 9:d98e4a80a866 143 */
phonemacro 9:d98e4a80a866 144 int write_trip_low_thyst(float temperature);
phonemacro 9:d98e4a80a866 145
phonemacro 9:d98e4a80a866 146 /**
phonemacro 9:d98e4a80a866 147 * @brief Writes to the TOS register
phonemacro 9:d98e4a80a866 148 * @param temperature - the temperature in Celsius degrees
phonemacro 9:d98e4a80a866 149 * @return 0 on success, negative number on failure
phonemacro 9:d98e4a80a866 150 */
phonemacro 9:d98e4a80a866 151 int write_trip_high_tos(float temperature);
phonemacro 9:d98e4a80a866 152
phonemacro 9:d98e4a80a866 153 /**
phonemacro 9:d98e4a80a866 154 * @brief Converts Celsius degrees to Fahrenheit
phonemacro 9:d98e4a80a866 155 * @param temp_c - the temperature in Celsius degrees
phonemacro 9:d98e4a80a866 156 * @return temperature in Celsius degrees
phonemacro 9:d98e4a80a866 157 */
phonemacro 9:d98e4a80a866 158 float celsius_to_fahrenheit(float temp_c);
phonemacro 9:d98e4a80a866 159
phonemacro 9:d98e4a80a866 160 protected:
phonemacro 9:d98e4a80a866 161 /**
phonemacro 9:d98e4a80a866 162 * @brief Write a value to a register
phonemacro 9:d98e4a80a866 163 * @param value - value to write to the register
phonemacro 9:d98e4a80a866 164 * @param reg - register address
phonemacro 9:d98e4a80a866 165 * @return 0 on success, negative number on failure
phonemacro 9:d98e4a80a866 166 */
phonemacro 9:d98e4a80a866 167 int write_reg16(int16_t value, char reg);
phonemacro 9:d98e4a80a866 168
phonemacro 9:d98e4a80a866 169 private:
phonemacro 9:d98e4a80a866 170 /** @var m_i2c
phonemacro 9:d98e4a80a866 171 * @brief I2C object
phonemacro 9:d98e4a80a866 172 */
phonemacro 9:d98e4a80a866 173 I2C &m_i2c;
phonemacro 9:d98e4a80a866 174 /** @var m_write_address, m_read_address
phonemacro 9:d98e4a80a866 175 * @brief I2C address
phonemacro 9:d98e4a80a866 176 */
phonemacro 9:d98e4a80a866 177 uint8_t m_write_address, m_read_address;
phonemacro 9:d98e4a80a866 178 /** @var m_extended_format
phonemacro 9:d98e4a80a866 179 * @brief Extended format, add 64°C to the temperature reading
phonemacro 9:d98e4a80a866 180 */
phonemacro 9:d98e4a80a866 181 uint32_t max30205_extended_format;
phonemacro 9:d98e4a80a866 182
phonemacro 9:d98e4a80a866 183 };
phonemacro 9:d98e4a80a866 184
phonemacro 9:d98e4a80a866 185 #endif/* DS1775_CPP_H */