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_c.cpp@9:315236fb3c6a, 2019-04-07 (annotated)

Committer:
phonemacro
Date:
Sun Apr 07 08:59:48 2019 +0000
Revision:
9:315236fb3c6a
Parent:
8:b2d4c71268aa
Child:
10:03645de9c017
updated

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_c.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 /******************************************************************************/
phonemacro 8:b2d4c71268aa 40 /* C version for DS1775 driver */
phonemacro 8:b2d4c71268aa 41 /******************************************************************************/
phonemacro 8:b2d4c71268aa 42
phonemacro 8:b2d4c71268aa 43 /* @var ds1775_write_address, ds1775_read_address
phonemacro 8:b2d4c71268aa 44 * @brief I2C address
phonemacro 8:b2d4c71268aa 45 */
phonemacro 8:b2d4c71268aa 46 uint8_t ds1775_write_address, ds1775_read_address;
phonemacro 8:b2d4c71268aa 47 /* @var ds1775_write_address, ds1775_read_address
phonemacro 8:b2d4c71268aa 48 * @brief ds1775_extended_format
phonemacro 8:b2d4c71268aa 49 */
phonemacro 8:b2d4c71268aa 50 uint32_t ds1775_extended_format;
phonemacro 8:b2d4c71268aa 51
phonemacro 8:b2d4c71268aa 52 int ds1775_init(uint8_t slave_address)
phonemacro 8:b2d4c71268aa 53 {
phonemacro 8:b2d4c71268aa 54 ds1775_write_address = (slave_address <<1);
phonemacro 8:b2d4c71268aa 55 ds1775_read_address = ((slave_address << 1) | 1);
phonemacro 8:b2d4c71268aa 56 ds1775_extended_format = 0;
phonemacro 8:b2d4c71268aa 57 return DS1775_NO_ERROR;
phonemacro 8:b2d4c71268aa 58 }
phonemacro 8:b2d4c71268aa 59
phonemacro 9:315236fb3c6a 60 /******************************************************************************/
phonemacro 9:315236fb3c6a 61 int ds1775_read_cfg_reg(uint8_t *value, I2C &i2c_bus)
phonemacro 9:315236fb3c6a 62 {
phonemacro 9:315236fb3c6a 63 int32_t ret;
phonemacro 9:315236fb3c6a 64 char data[1] = {0};
phonemacro 9:315236fb3c6a 65 char reg = DS1775_REG_CONFIGURATION;
phonemacro 9:315236fb3c6a 66
phonemacro 9:315236fb3c6a 67 /* write to the Register Select, true is for repeated start */
phonemacro 9:315236fb3c6a 68 ret = i2c_bus.write(ds1775_write_address, &reg, 1, true);
phonemacro 9:315236fb3c6a 69 if (ret == 0) {
phonemacro 9:315236fb3c6a 70 ret = i2c_bus.read(ds1775_read_address, data, 1, false);
phonemacro 9:315236fb3c6a 71 if (ret == 0) {
phonemacro 9:315236fb3c6a 72 *value = data[0];
phonemacro 9:315236fb3c6a 73 printf("%s: cfg %x\r\n", __func__, *value);
phonemacro 9:315236fb3c6a 74 return DS1775_NO_ERROR;
phonemacro 9:315236fb3c6a 75 } else {
phonemacro 9:315236fb3c6a 76 printf("%s: failed to read data: ret: %d\r\n", __func__, ret);
phonemacro 9:315236fb3c6a 77 }
phonemacro 9:315236fb3c6a 78 } else {
phonemacro 9:315236fb3c6a 79 printf("%s: failed to write to Register Select: ret: %d\r\n",
phonemacro 9:315236fb3c6a 80 __func__, ret);
phonemacro 9:315236fb3c6a 81 }
phonemacro 9:315236fb3c6a 82 return DS1775_ERROR;
phonemacro 9:315236fb3c6a 83 }
phonemacro 9:315236fb3c6a 84
phonemacro 8:b2d4c71268aa 85
phonemacro 8:b2d4c71268aa 86 /******************************************************************************/
phonemacro 8:b2d4c71268aa 87 int ds1775_read_reg(uint16_t *value, char reg, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 88 {
phonemacro 8:b2d4c71268aa 89 int32_t ret;
phonemacro 8:b2d4c71268aa 90 char data[2] = {0, 0};
phonemacro 8:b2d4c71268aa 91 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 92
phonemacro 8:b2d4c71268aa 93 if (reg <= DS1775_REG_MAX) {
phonemacro 9:315236fb3c6a 94 /* write to the Register Select, true is for repeated start */
phonemacro 8:b2d4c71268aa 95 ret = i2c_bus.write(ds1775_write_address, &reg, 1, true);
phonemacro 8:b2d4c71268aa 96 /* read the two bytes of data */
phonemacro 8:b2d4c71268aa 97 if (ret == 0) {
phonemacro 8:b2d4c71268aa 98 ret = i2c_bus.read(ds1775_read_address, data, 2, false);
phonemacro 8:b2d4c71268aa 99 printf(
phonemacro 8:b2d4c71268aa 100 "%s: msb lsb %x %x \r\n", __func__, tmp.msb, tmp.lsb);
phonemacro 8:b2d4c71268aa 101 if (ret == 0) {
phonemacro 8:b2d4c71268aa 102 tmp.msb = data[0];
phonemacro 8:b2d4c71268aa 103 tmp.lsb = data[1];
phonemacro 8:b2d4c71268aa 104 *value = tmp.uwrd;
phonemacro 8:b2d4c71268aa 105 return DS1775_NO_ERROR;
phonemacro 8:b2d4c71268aa 106 } else {
phonemacro 8:b2d4c71268aa 107 printf(
phonemacro 8:b2d4c71268aa 108 "%s: failed to read data: ret: %d\r\n", __func__, ret);
phonemacro 8:b2d4c71268aa 109 }
phonemacro 8:b2d4c71268aa 110 } else {
phonemacro 8:b2d4c71268aa 111 printf("%s: failed to write to Register Select: ret: %d\r\n",
phonemacro 8:b2d4c71268aa 112 __func__, ret);
phonemacro 8:b2d4c71268aa 113 }
phonemacro 8:b2d4c71268aa 114 } else {
phonemacro 8:b2d4c71268aa 115 printf("%s: register address is not correct: register: %d\r\n",
phonemacro 8:b2d4c71268aa 116 __func__, reg);
phonemacro 8:b2d4c71268aa 117 }
phonemacro 8:b2d4c71268aa 118 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 119 }
phonemacro 8:b2d4c71268aa 120
phonemacro 8:b2d4c71268aa 121 float ds1775_read_reg_as_temperature(uint8_t reg, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 122 {
phonemacro 8:b2d4c71268aa 123 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 124 float temperature;
phonemacro 8:b2d4c71268aa 125 if (reg == DS1775_REG_TEMPERATURE ||
phonemacro 8:b2d4c71268aa 126 reg == DS1775_REG_THYST_LOW_TRIP || reg == DS1775_REG_TOS_HIGH_TRIP) {
phonemacro 8:b2d4c71268aa 127 ds1775_read_reg(&tmp.uwrd, reg, i2c_bus);
phonemacro 8:b2d4c71268aa 128 temperature = (float)tmp.magnitude_bits;
phonemacro 8:b2d4c71268aa 129 if (ds1775_extended_format)
phonemacro 8:b2d4c71268aa 130 temperature *= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 131 else
phonemacro 8:b2d4c71268aa 132 temperature *= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 133 if (tmp.sign_bit)
phonemacro 8:b2d4c71268aa 134 temperature = -temperature;
phonemacro 8:b2d4c71268aa 135 return temperature;
phonemacro 8:b2d4c71268aa 136
phonemacro 8:b2d4c71268aa 137 return temperature;
phonemacro 8:b2d4c71268aa 138 } else {
phonemacro 8:b2d4c71268aa 139 printf("%s: register is invalid, %d r\n", __func__, reg);
phonemacro 8:b2d4c71268aa 140 return 0;
phonemacro 8:b2d4c71268aa 141 }
phonemacro 8:b2d4c71268aa 142 }
phonemacro 8:b2d4c71268aa 143
phonemacro 8:b2d4c71268aa 144
phonemacro 8:b2d4c71268aa 145 /******************************************************************************/
phonemacro 8:b2d4c71268aa 146 int ds1775_write_reg(uint16_t value, char reg, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 147 {
phonemacro 8:b2d4c71268aa 148 int32_t ret;
phonemacro 8:b2d4c71268aa 149 char cmd[3];
phonemacro 8:b2d4c71268aa 150 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 151
phonemacro 8:b2d4c71268aa 152 if (reg >= DS1775_REG_CONFIGURATION && reg <= DS1775_REG_MAX) {
phonemacro 8:b2d4c71268aa 153 cmd[0] = reg;
phonemacro 8:b2d4c71268aa 154 tmp.uwrd = value;
phonemacro 8:b2d4c71268aa 155 cmd[1] = tmp.msb;
phonemacro 8:b2d4c71268aa 156 cmd[2] = tmp.lsb;
phonemacro 8:b2d4c71268aa 157 ret = i2c_bus.write(ds1775_write_address, cmd, 3, false);
phonemacro 8:b2d4c71268aa 158 if (ret == 0) {
phonemacro 8:b2d4c71268aa 159 return DS1775_NO_ERROR;
phonemacro 8:b2d4c71268aa 160 } else {
phonemacro 8:b2d4c71268aa 161 printf("%s: I2C write error %d\r\n",__func__, ret);
phonemacro 8:b2d4c71268aa 162 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 163 }
phonemacro 8:b2d4c71268aa 164 } else {
phonemacro 8:b2d4c71268aa 165 printf("%s: register value invalid %x\r\n",__func__, reg);
phonemacro 8:b2d4c71268aa 166 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 167 }
phonemacro 8:b2d4c71268aa 168 }
phonemacro 8:b2d4c71268aa 169
phonemacro 9:315236fb3c6a 170 /******************************************************************************/
phonemacro 9:315236fb3c6a 171 int ds1775_write_reg_one_byte(uint8_t value, char reg, I2C &i2c_bus)
phonemacro 9:315236fb3c6a 172 {
phonemacro 9:315236fb3c6a 173 int32_t ret;
phonemacro 9:315236fb3c6a 174 char cmd[2];
phonemacro 8:b2d4c71268aa 175
phonemacro 9:315236fb3c6a 176 if (reg == DS1775_REG_CONFIGURATION) {
phonemacro 9:315236fb3c6a 177 cmd[0] = reg;
phonemacro 9:315236fb3c6a 178 cmd[1] = value;
phonemacro 9:315236fb3c6a 179 ret = i2c_bus.write(ds1775_write_address, cmd, 2, false);
phonemacro 9:315236fb3c6a 180 if (ret == 0) {
phonemacro 9:315236fb3c6a 181 return DS1775_NO_ERROR;
phonemacro 9:315236fb3c6a 182 } else {
phonemacro 9:315236fb3c6a 183 printf("%s: I2C write error %d\r\n",__func__, ret);
phonemacro 9:315236fb3c6a 184 return DS1775_ERROR;
phonemacro 9:315236fb3c6a 185 }
phonemacro 9:315236fb3c6a 186 } else {
phonemacro 9:315236fb3c6a 187 printf("%s: register value invalid %x\r\n",__func__, reg);
phonemacro 9:315236fb3c6a 188 return DS1775_ERROR;
phonemacro 9:315236fb3c6a 189 }
phonemacro 9:315236fb3c6a 190 }
phonemacro 9:315236fb3c6a 191
phonemacro 9:315236fb3c6a 192 int ds1775_write_cfg(uint8_t cfg, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 193 {
phonemacro 8:b2d4c71268aa 194 return ds1775_write_reg(cfg, DS1775_REG_CONFIGURATION, i2c_bus);
phonemacro 8:b2d4c71268aa 195 }
phonemacro 8:b2d4c71268aa 196
phonemacro 8:b2d4c71268aa 197
phonemacro 8:b2d4c71268aa 198 int ds1775_write_trip_low(float temperature, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 199 {
phonemacro 8:b2d4c71268aa 200 ds1775_raw_data raw;
phonemacro 8:b2d4c71268aa 201 raw.uwrd = 0;
phonemacro 8:b2d4c71268aa 202 if (temperature < 0) {
phonemacro 8:b2d4c71268aa 203 raw.sign_bit = 1;
phonemacro 8:b2d4c71268aa 204 temperature = -temperature;
phonemacro 8:b2d4c71268aa 205 }
phonemacro 8:b2d4c71268aa 206 if (ds1775_extended_format)
phonemacro 8:b2d4c71268aa 207 temperature /= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 208 else
phonemacro 8:b2d4c71268aa 209 temperature /= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 210 raw.magnitude_bits = uint16_t(temperature);
phonemacro 8:b2d4c71268aa 211 return ds1775_write_reg(raw.uwrd, DS1775_REG_THYST_LOW_TRIP, i2c_bus);
phonemacro 8:b2d4c71268aa 212 }
phonemacro 8:b2d4c71268aa 213
phonemacro 8:b2d4c71268aa 214
phonemacro 8:b2d4c71268aa 215 int ds1775_write_trip_high(float temperature, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 216 {
phonemacro 8:b2d4c71268aa 217 ds1775_raw_data raw;
phonemacro 8:b2d4c71268aa 218 raw.uwrd = 0;
phonemacro 8:b2d4c71268aa 219 if (temperature < 0) {
phonemacro 8:b2d4c71268aa 220 raw.sign_bit = 1;
phonemacro 8:b2d4c71268aa 221 temperature = -temperature;
phonemacro 8:b2d4c71268aa 222 }
phonemacro 8:b2d4c71268aa 223 if (ds1775_extended_format)
phonemacro 8:b2d4c71268aa 224 temperature /= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 225 else
phonemacro 8:b2d4c71268aa 226 temperature /= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 227 raw.magnitude_bits = uint16_t(temperature);
phonemacro 8:b2d4c71268aa 228 return ds1775_write_reg(raw.uwrd, DS1775_REG_TOS_HIGH_TRIP, i2c_bus);
phonemacro 8:b2d4c71268aa 229 }
phonemacro 8:b2d4c71268aa 230
phonemacro 8:b2d4c71268aa 231
phonemacro 8:b2d4c71268aa 232 float ds1775_celsius_to_fahrenheit(float temp_c)
phonemacro 8:b2d4c71268aa 233 {
phonemacro 8:b2d4c71268aa 234 float temp_f;
phonemacro 8:b2d4c71268aa 235 temp_f = ((temp_c * 9)/5) + 32;
phonemacro 8:b2d4c71268aa 236 return temp_f;
phonemacro 8:b2d4c71268aa 237 }