Maxim Integrated / MAX31875_Temperature_Sensor_Low_Power

C code and C++ library, driver software for the low-power small WLP package MAX31875 temperature sensor. Code supports one-shot, shut-down/standby, hysteresis, alarm limits.

Dependents:   MAX31875_Temperature_Sensor_Small_WLP Click-Sensor-MAX31875 NuMaker-mbed-Sensor-MAX31875

max31875.h@4:a27a0ee318bd, 2019-02-13 (annotated)

Committer:
phonemacro
Date:
Wed Feb 13 05:01:35 2019 +0000
Revision:
4:a27a0ee318bd
Parent:
3:3528e660168c 
Correct logic for extended and normal format. Correct negative value logic.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phonemacro 0:f51465145906 1 /*******************************************************************************
phonemacro 0:f51465145906 2 * Copyright (C) 2019 Maxim Integrated Products, Inc., All Rights Reserved.
phonemacro 0:f51465145906 3 *
phonemacro 0:f51465145906 4 * Permission is hereby granted, free of charge, to any person obtaining a
phonemacro 0:f51465145906 5 * copy of this software and associated documentation files (the "Software"),
phonemacro 0:f51465145906 6 * to deal in the Software without restriction, including without limitation
phonemacro 0:f51465145906 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
phonemacro 0:f51465145906 8 * and/or sell copies of the Software, and to permit persons to whom the
phonemacro 0:f51465145906 9 * Software is furnished to do so, subject to the following conditions:
phonemacro 0:f51465145906 10 *
phonemacro 0:f51465145906 11 * The above copyright notice and this permission notice shall be included
phonemacro 0:f51465145906 12 * in all copies or substantial portions of the Software.
phonemacro 0:f51465145906 13 *
phonemacro 0:f51465145906 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
phonemacro 0:f51465145906 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
phonemacro 0:f51465145906 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
phonemacro 0:f51465145906 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
phonemacro 0:f51465145906 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
phonemacro 0:f51465145906 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
phonemacro 0:f51465145906 20 * OTHER DEALINGS IN THE SOFTWARE.
phonemacro 0:f51465145906 21 *
phonemacro 0:f51465145906 22 * Except as contained in this notice, the name of Maxim Integrated
phonemacro 0:f51465145906 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
phonemacro 0:f51465145906 24 * Products, Inc. Branding Policy.
phonemacro 0:f51465145906 25 *
phonemacro 0:f51465145906 26 * The mere transfer of this software does not imply any licenses
phonemacro 0:f51465145906 27 * of trade secrets, proprietary technology, copyrights, patents,
phonemacro 0:f51465145906 28 * trademarks, maskwork rights, or any other form of intellectual
phonemacro 0:f51465145906 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
phonemacro 0:f51465145906 30 * ownership rights.
phonemacro 0:f51465145906 31 *******************************************************************************
phonemacro 0:f51465145906 32 * @file MAX31875.h
phonemacro 0:f51465145906 33 *******************************************************************************
phonemacro 0:f51465145906 34 */
phonemacro 0:f51465145906 35 #ifndef MAX31875_H
phonemacro 0:f51465145906 36 #define MAX31875_H
phonemacro 0:f51465145906 37 #include "mbed.h"
phonemacro 0:f51465145906 38
phonemacro 0:f51465145906 39 #define MAX31875_NO_ERROR 0
phonemacro 0:f51465145906 40 #define MAX31875_ERROR -1
phonemacro 0:f51465145906 41
phonemacro 4:a27a0ee318bd 42 #define MAX31875_REG_TEMPERATURE 0X00
phonemacro 4:a27a0ee318bd 43 #define MAX31875_REG_CONFIGURATION 0X01
phonemacro 4:a27a0ee318bd 44 #define MAX31875_REG_THYST_LOW_TRIP 0X02
phonemacro 4:a27a0ee318bd 45 #define MAX31875_REG_TOS_HIGH_TRIP 0X03
phonemacro 4:a27a0ee318bd 46 #define MAX31875_REG_MAX 0X03
phonemacro 0:f51465145906 47
phonemacro 0:f51465145906 48 #define MAX31875_CFG_ONE_SHOT_START (1) /* Start one-shot measurement */
phonemacro 0:f51465145906 49
phonemacro 0:f51465145906 50 #define MAX31875_CFG_CONV_RATE_0_25 (0x00 << 1) /* 0.25 conversions/sec */
phonemacro 0:f51465145906 51 #define MAX31875_CFG_CONV_RATE_1 (0x01 << 1) /* 1.0 conversions/sec */
phonemacro 0:f51465145906 52 #define MAX31875_CFG_CONV_RATE_4 (0x02 << 1) /* 4.0 conversions/sec */
phonemacro 0:f51465145906 53 #define MAX31875_CFG_CONV_RATE_8 (0x03 << 1) /* 8.0 conversions/sec */
phonemacro 4:a27a0ee318bd 54 #define MAX31875_WAIT_CONV_RATE_0_25 (4.002)
phonemacro 0:f51465145906 55 #define MAX31875_WAIT_CONV_RATE_1 (1.0)
phonemacro 0:f51465145906 56 #define MAX31875_WAIT_CONV_RATE_4 (0.25)
phonemacro 0:f51465145906 57 #define MAX31875_WAIT_CONV_RATE_8 (0.125)
phonemacro 0:f51465145906 58
phonemacro 0:f51465145906 59 #define MAX31875_CFG_RESOLUTION_9BIT (0x00 << 5)
phonemacro 0:f51465145906 60 #define MAX31875_CFG_RESOLUTION_10BIT (0x01 << 5)
phonemacro 0:f51465145906 61 #define MAX31875_CFG_RESOLUTION_11BIT (0x02 << 5)
phonemacro 0:f51465145906 62 #define MAX31875_CFG_RESOLUTION_12BIT (0x03 << 5)
phonemacro 0:f51465145906 63
phonemacro 0:f51465145906 64 #define MAX31875_CFG_NORMAL_FORMAT (0X00 << 7)
phonemacro 0:f51465145906 65 #define MAX31875_CFG_EXTENDED_FORMAT (0X01 << 7)
phonemacro 0:f51465145906 66
phonemacro 0:f51465145906 67 #define MAX31875_CFG_CONTINUOUS (0X00 << 8)
phonemacro 0:f51465145906 68 #define MAX31875_CFG_SHUTDOWN (0X01 << 8)
phonemacro 0:f51465145906 69
phonemacro 0:f51465145906 70 #define MAX31875_CFG_COMPARATOR_MODE (0X00 << 9)
phonemacro 0:f51465145906 71 #define MAX31875_CFG_INTERRUPT_MODE (0X01 << 9)
phonemacro 0:f51465145906 72
phonemacro 0:f51465145906 73
phonemacro 0:f51465145906 74 #define MAX31875_CFG_FAULT_FILTER_1 (0x00 << 11)
phonemacro 0:f51465145906 75 #define MAX31875_CFG_FAULT_FILTER_2 (0x01 << 11)
phonemacro 0:f51465145906 76 #define MAX31875_CFG_FAULT_FILTER_4 (0x02 << 11)
phonemacro 0:f51465145906 77 #define MAX31875_CFG_FAULT_FILTER_6 (0x03 << 11)
phonemacro 0:f51465145906 78
phonemacro 0:f51465145906 79 #define MAX31875_CFG_OVER_TEMP_MASK (0x80)
phonemacro 0:f51465145906 80
phonemacro 0:f51465145906 81
phonemacro 0:f51465145906 82 #define MAX31875_I2C_SLAVE_ADR_R0 (0x90 >> 1) // code uses the 7 bit address
phonemacro 0:f51465145906 83 #define MAX31875_I2C_SLAVE_ADR_R1 (0x92 >> 1)
phonemacro 0:f51465145906 84 #define MAX31875_I2C_SLAVE_ADR_R2 (0x94 >> 1)
phonemacro 0:f51465145906 85 #define MAX31875_I2C_SLAVE_ADR_R3 (0x96 >> 1)
phonemacro 0:f51465145906 86 #define MAX31875_I2C_SLAVE_ADR_R4 (0x98 >> 1)
phonemacro 0:f51465145906 87 #define MAX31875_I2C_SLAVE_ADR_R5 (0x9A >> 1)
phonemacro 0:f51465145906 88 #define MAX31875_I2C_SLAVE_ADR_R6 (0x9C >> 1)
phonemacro 0:f51465145906 89 #define MAX31875_I2C_SLAVE_ADR_R7 (0x9E >> 1)
phonemacro 0:f51465145906 90
phonemacro 0:f51465145906 91 #define MAX31875_CF_NORMAL_FORMAT (0.00390625F)
phonemacro 0:f51465145906 92 #define MAX31875_CF_EXTENDED_FORMAT (0.0078125F)
phonemacro 0:f51465145906 93
phonemacro 3:3528e660168c 94 /** @union max31875_raw_data
phonemacro 3:3528e660168c 95 * @brief union data structure for byte word manipulations
phonemacro 0:f51465145906 96 */
phonemacro 3:3528e660168c 97 union max31875_raw_data {
phonemacro 3:3528e660168c 98 struct {
phonemacro 3:3528e660168c 99 uint8_t lsb;
phonemacro 3:3528e660168c 100 uint8_t msb;
phonemacro 3:3528e660168c 101 };
phonemacro 4:a27a0ee318bd 102 struct {
phonemacro 4:a27a0ee318bd 103 uint16_t magnitude_bits:15;
phonemacro 4:a27a0ee318bd 104 uint16_t sign_bit:1;
phonemacro 4:a27a0ee318bd 105 };
phonemacro 3:3528e660168c 106 uint16_t uwrd;
phonemacro 3:3528e660168c 107 int16_t swrd;
phonemacro 3:3528e660168c 108 };
phonemacro 4:a27a0ee318bd 109 #define MAX31875_U16_MAX ((uint16_t)~0U)
phonemacro 4:a27a0ee318bd 110 #define MAX31875_S16_MAX ((int16_t)(MAX31875_U16_MAX>>1))
phonemacro 4:a27a0ee318bd 111 #define MAX31875_S16_MIN ((int16_t)(-MAX31875_S16_MAX - 1))
phonemacro 0:f51465145906 112
phonemacro 0:f51465145906 113 #endif/* MAX31875_H */