Maxim Integrated / DS1775_Digitial_Thermometer_Thermostat

C code and C++ library, driver software for Maxim Integrated DS1775, DS75 thermometer and thermostat temperature sensor. Code supports continuous or shut-down/standby, hysteresis, alarm limits, comparator or interrupt mode, fault filtering, and active low/high. Compact 5-pin SOT23 packaging

Dependents:   DS1775_Digital_Thermostat_Temperature

ds1775_cpp.cpp@8:b2d4c71268aa, 2019-04-07 (annotated)

Committer:
phonemacro
Date:
Sun Apr 07 07:43:11 2019 +0000
Revision:
8:b2d4c71268aa
Child:
9:315236fb3c6a
update

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phonemacro 8:b2d4c71268aa 1 /*******************************************************************************
phonemacro 8:b2d4c71268aa 2 * Copyright (C) 2019 Maxim Integrated Products, Inc., All Rights Reserved.
phonemacro 8:b2d4c71268aa 3 *
phonemacro 8:b2d4c71268aa 4 * Permission is hereby granted, free of charge, to any person obtaining a
phonemacro 8:b2d4c71268aa 5 * copy of this software and associated documentation files (the "Software"),
phonemacro 8:b2d4c71268aa 6 * to deal in the Software without restriction, including without limitation
phonemacro 8:b2d4c71268aa 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
phonemacro 8:b2d4c71268aa 8 * and/or sell copies of the Software, and to permit persons to whom the
phonemacro 8:b2d4c71268aa 9 * Software is furnished to do so, subject to the following conditions:
phonemacro 8:b2d4c71268aa 10 *
phonemacro 8:b2d4c71268aa 11 * The above copyright notice and this permission notice shall be included
phonemacro 8:b2d4c71268aa 12 * in all copies or substantial portions of the Software.
phonemacro 8:b2d4c71268aa 13 *
phonemacro 8:b2d4c71268aa 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
phonemacro 8:b2d4c71268aa 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
phonemacro 8:b2d4c71268aa 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
phonemacro 8:b2d4c71268aa 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
phonemacro 8:b2d4c71268aa 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
phonemacro 8:b2d4c71268aa 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
phonemacro 8:b2d4c71268aa 20 * OTHER DEALINGS IN THE SOFTWARE.
phonemacro 8:b2d4c71268aa 21 *
phonemacro 8:b2d4c71268aa 22 * Except as contained in this notice, the name of Maxim Integrated
phonemacro 8:b2d4c71268aa 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
phonemacro 8:b2d4c71268aa 24 * Products, Inc. Branding Policy.
phonemacro 8:b2d4c71268aa 25 *
phonemacro 8:b2d4c71268aa 26 * The mere transfer of this software does not imply any licenses
phonemacro 8:b2d4c71268aa 27 * of trade secrets, proprietary technology, copyrights, patents,
phonemacro 8:b2d4c71268aa 28 * trademarks, maskwork rights, or any other form of intellectual
phonemacro 8:b2d4c71268aa 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
phonemacro 8:b2d4c71268aa 30 * ownership rights.
phonemacro 8:b2d4c71268aa 31 *******************************************************************************
phonemacro 8:b2d4c71268aa 32 */
phonemacro 8:b2d4c71268aa 33 #include "ds1775.h"
phonemacro 8:b2d4c71268aa 34 #include "ds1775_cpp.h"
phonemacro 8:b2d4c71268aa 35 #include "mbed.h"
phonemacro 8:b2d4c71268aa 36 // #include "USBSerial.h"
phonemacro 8:b2d4c71268aa 37
phonemacro 8:b2d4c71268aa 38 /******************************************************************************
phonemacro 8:b2d4c71268aa 39 * C++ version for DS1775 driver *
phonemacro 8:b2d4c71268aa 40 ******************************************************************************
phonemacro 8:b2d4c71268aa 41 */
phonemacro 8:b2d4c71268aa 42
phonemacro 8:b2d4c71268aa 43 /******************************************************************************/
phonemacro 8:b2d4c71268aa 44 DS1775::DS1775(I2C &i2c_bus, uint8_t slave_address):
phonemacro 8:b2d4c71268aa 45 m_i2c(i2c_bus),
phonemacro 8:b2d4c71268aa 46 m_write_address(slave_address <<1),
phonemacro 8:b2d4c71268aa 47 m_read_address ((slave_address << 1) | 1)
phonemacro 8:b2d4c71268aa 48 {
phonemacro 8:b2d4c71268aa 49 m_extended_format = 0;
phonemacro 8:b2d4c71268aa 50 }
phonemacro 8:b2d4c71268aa 51
phonemacro 8:b2d4c71268aa 52 /******************************************************************************/
phonemacro 8:b2d4c71268aa 53 DS1775::~DS1775(void)
phonemacro 8:b2d4c71268aa 54 {
phonemacro 8:b2d4c71268aa 55 /** empty block */
phonemacro 8:b2d4c71268aa 56 }
phonemacro 8:b2d4c71268aa 57
phonemacro 8:b2d4c71268aa 58 /******************************************************************************/
phonemacro 8:b2d4c71268aa 59 int DS1775::read_reg(uint16_t *value, char reg)
phonemacro 8:b2d4c71268aa 60 {
phonemacro 8:b2d4c71268aa 61 int32_t ret;
phonemacro 8:b2d4c71268aa 62 char data[2] = {0, 0};
phonemacro 8:b2d4c71268aa 63 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 64
phonemacro 8:b2d4c71268aa 65 if (reg <= DS1775_REG_MAX) {
phonemacro 8:b2d4c71268aa 66 /* write to the Register Select */
phonemacro 8:b2d4c71268aa 67 ret = m_i2c.write(m_write_address, &reg, 1, true);
phonemacro 8:b2d4c71268aa 68 /* read the two bytes of data */
phonemacro 8:b2d4c71268aa 69 if (ret == 0) {
phonemacro 8:b2d4c71268aa 70 ret = m_i2c.read(m_read_address, data, 2, false);
phonemacro 8:b2d4c71268aa 71 if (ret == 0) {
phonemacro 8:b2d4c71268aa 72 tmp.msb = data[0];
phonemacro 8:b2d4c71268aa 73 tmp.lsb = data[1];
phonemacro 8:b2d4c71268aa 74 *value = tmp.uwrd;
phonemacro 8:b2d4c71268aa 75 return DS1775_NO_ERROR;
phonemacro 8:b2d4c71268aa 76 } else {
phonemacro 8:b2d4c71268aa 77 printf(
phonemacro 8:b2d4c71268aa 78 "%s: failed to read data: ret: %d\r\n", __func__, ret);
phonemacro 8:b2d4c71268aa 79 }
phonemacro 8:b2d4c71268aa 80 } else {
phonemacro 8:b2d4c71268aa 81 printf("%s: failed to write to Register Select: ret: %d\r\n",
phonemacro 8:b2d4c71268aa 82 __func__, ret);
phonemacro 8:b2d4c71268aa 83 }
phonemacro 8:b2d4c71268aa 84 } else {
phonemacro 8:b2d4c71268aa 85 printf("%s: register address is not correct: register: %d\r\n",
phonemacro 8:b2d4c71268aa 86 __func__, reg);
phonemacro 8:b2d4c71268aa 87 }
phonemacro 8:b2d4c71268aa 88 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 89 }
phonemacro 8:b2d4c71268aa 90
phonemacro 8:b2d4c71268aa 91 /******************************************************************************/
phonemacro 8:b2d4c71268aa 92 float DS1775::read_reg_as_temperature(uint8_t reg)
phonemacro 8:b2d4c71268aa 93 {
phonemacro 8:b2d4c71268aa 94 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 95 float temperature;
phonemacro 8:b2d4c71268aa 96 if (reg == DS1775_REG_TEMPERATURE ||
phonemacro 8:b2d4c71268aa 97 reg == DS1775_REG_THYST_LOW_TRIP || reg == DS1775_REG_TOS_HIGH_TRIP) {
phonemacro 8:b2d4c71268aa 98 read_reg(&tmp.uwrd, reg);
phonemacro 8:b2d4c71268aa 99 temperature = (float)tmp.magnitude_bits;
phonemacro 8:b2d4c71268aa 100 if (m_extended_format)
phonemacro 8:b2d4c71268aa 101 temperature *= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 102 else
phonemacro 8:b2d4c71268aa 103 temperature *= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 104 if (tmp.sign_bit)
phonemacro 8:b2d4c71268aa 105 temperature = -temperature;
phonemacro 8:b2d4c71268aa 106 return temperature;
phonemacro 8:b2d4c71268aa 107
phonemacro 8:b2d4c71268aa 108 } else {
phonemacro 8:b2d4c71268aa 109 printf("%s: register is invalid, %d r\n", __func__, reg);
phonemacro 8:b2d4c71268aa 110 return 0;
phonemacro 8:b2d4c71268aa 111 }
phonemacro 8:b2d4c71268aa 112 }
phonemacro 8:b2d4c71268aa 113
phonemacro 8:b2d4c71268aa 114 /******************************************************************************/
phonemacro 8:b2d4c71268aa 115 int DS1775::write_reg(uint16_t value, char reg)
phonemacro 8:b2d4c71268aa 116 {
phonemacro 8:b2d4c71268aa 117 int32_t ret;
phonemacro 8:b2d4c71268aa 118 char cmd[3];
phonemacro 8:b2d4c71268aa 119 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 120
phonemacro 8:b2d4c71268aa 121 if (reg >= DS1775_REG_CONFIGURATION && reg <= DS1775_REG_MAX) {
phonemacro 8:b2d4c71268aa 122 cmd[0] = reg;
phonemacro 8:b2d4c71268aa 123 tmp.uwrd = value;
phonemacro 8:b2d4c71268aa 124 cmd[1] = tmp.msb;
phonemacro 8:b2d4c71268aa 125 cmd[2] = tmp.lsb;
phonemacro 8:b2d4c71268aa 126 ret = m_i2c.write(m_write_address, cmd, 3, false);
phonemacro 8:b2d4c71268aa 127 if (ret == 0) {
phonemacro 8:b2d4c71268aa 128 if (DS1775_REG_CONFIGURATION == reg) {
phonemacro 8:b2d4c71268aa 129 m_extended_format = 0;
phonemacro 8:b2d4c71268aa 130 if (tmp.uwrd & DS1775_CFG_EXTENDED_FORMAT)
phonemacro 8:b2d4c71268aa 131 m_extended_format = 1;
phonemacro 8:b2d4c71268aa 132 }
phonemacro 8:b2d4c71268aa 133 return DS1775_NO_ERROR;
phonemacro 8:b2d4c71268aa 134 } else {
phonemacro 8:b2d4c71268aa 135 printf("%s: I2C write error %d\r\n",__func__, ret);
phonemacro 8:b2d4c71268aa 136 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 137 }
phonemacro 8:b2d4c71268aa 138 } else {
phonemacro 8:b2d4c71268aa 139 printf("%s: register value invalid %x\r\n",__func__, reg);
phonemacro 8:b2d4c71268aa 140 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 141 }
phonemacro 8:b2d4c71268aa 142 }
phonemacro 8:b2d4c71268aa 143
phonemacro 8:b2d4c71268aa 144 /******************************************************************************/
phonemacro 8:b2d4c71268aa 145 int DS1775::write_cfg(uint16_t cfg)
phonemacro 8:b2d4c71268aa 146 {
phonemacro 8:b2d4c71268aa 147 return write_reg(cfg, DS1775_REG_CONFIGURATION);
phonemacro 8:b2d4c71268aa 148 }
phonemacro 8:b2d4c71268aa 149
phonemacro 8:b2d4c71268aa 150 /******************************************************************************/
phonemacro 8:b2d4c71268aa 151 int DS1775::write_trip_low(float temperature)
phonemacro 8:b2d4c71268aa 152 {
phonemacro 8:b2d4c71268aa 153 ds1775_raw_data raw;
phonemacro 8:b2d4c71268aa 154 raw.uwrd = 0;
phonemacro 8:b2d4c71268aa 155 if (temperature < 0) {
phonemacro 8:b2d4c71268aa 156 raw.sign_bit = 1;
phonemacro 8:b2d4c71268aa 157 temperature = -temperature;
phonemacro 8:b2d4c71268aa 158 }
phonemacro 8:b2d4c71268aa 159 if (m_extended_format)
phonemacro 8:b2d4c71268aa 160 temperature /= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 161 else
phonemacro 8:b2d4c71268aa 162 temperature /= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 163 raw.magnitude_bits = uint16_t(temperature);
phonemacro 8:b2d4c71268aa 164 return write_reg(raw.uwrd, DS1775_REG_THYST_LOW_TRIP);
phonemacro 8:b2d4c71268aa 165 }
phonemacro 8:b2d4c71268aa 166
phonemacro 8:b2d4c71268aa 167 /******************************************************************************/
phonemacro 8:b2d4c71268aa 168 int DS1775::write_trip_high(float temperature)
phonemacro 8:b2d4c71268aa 169 {
phonemacro 8:b2d4c71268aa 170 ds1775_raw_data raw;
phonemacro 8:b2d4c71268aa 171 raw.uwrd = 0;
phonemacro 8:b2d4c71268aa 172 if (temperature < 0) {
phonemacro 8:b2d4c71268aa 173 raw.sign_bit = 1;
phonemacro 8:b2d4c71268aa 174 temperature = -temperature;
phonemacro 8:b2d4c71268aa 175 }
phonemacro 8:b2d4c71268aa 176 if (m_extended_format)
phonemacro 8:b2d4c71268aa 177 temperature /= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 178 else
phonemacro 8:b2d4c71268aa 179 temperature /= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 180 raw.magnitude_bits = uint16_t(temperature);
phonemacro 8:b2d4c71268aa 181 return write_reg(raw.uwrd, DS1775_REG_TOS_HIGH_TRIP);
phonemacro 8:b2d4c71268aa 182 }
phonemacro 8:b2d4c71268aa 183
phonemacro 8:b2d4c71268aa 184 /******************************************************************************/
phonemacro 8:b2d4c71268aa 185 float DS1775::celsius_to_fahrenheit(float temp_c)
phonemacro 8:b2d4c71268aa 186 {
phonemacro 8:b2d4c71268aa 187 float temp_f;
phonemacro 8:b2d4c71268aa 188 temp_f = ((temp_c * 9)/5) + 32;
phonemacro 8:b2d4c71268aa 189 return temp_f;
phonemacro 8:b2d4c71268aa 190 }