David Jung / 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@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_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 8:b2d4c71268aa 60
phonemacro 8:b2d4c71268aa 61 /******************************************************************************/
phonemacro 8:b2d4c71268aa 62 int ds1775_read_reg(uint16_t *value, char reg, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 63 {
phonemacro 8:b2d4c71268aa 64 int32_t ret;
phonemacro 8:b2d4c71268aa 65 char data[2] = {0, 0};
phonemacro 8:b2d4c71268aa 66 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 67
phonemacro 8:b2d4c71268aa 68 if (reg <= DS1775_REG_MAX) {
phonemacro 8:b2d4c71268aa 69 /* write to the Register Select */
phonemacro 8:b2d4c71268aa 70 ret = i2c_bus.write(ds1775_write_address, &reg, 1, true);
phonemacro 8:b2d4c71268aa 71 /* read the two bytes of data */
phonemacro 8:b2d4c71268aa 72 if (ret == 0) {
phonemacro 8:b2d4c71268aa 73 ret = i2c_bus.read(ds1775_read_address, data, 2, false);
phonemacro 8:b2d4c71268aa 74 printf(
phonemacro 8:b2d4c71268aa 75 "%s: msb lsb %x %x \r\n", __func__, tmp.msb, tmp.lsb);
phonemacro 8:b2d4c71268aa 76 if (ret == 0) {
phonemacro 8:b2d4c71268aa 77 tmp.msb = data[0];
phonemacro 8:b2d4c71268aa 78 tmp.lsb = data[1];
phonemacro 8:b2d4c71268aa 79 *value = tmp.uwrd;
phonemacro 8:b2d4c71268aa 80 return DS1775_NO_ERROR;
phonemacro 8:b2d4c71268aa 81 } else {
phonemacro 8:b2d4c71268aa 82 printf(
phonemacro 8:b2d4c71268aa 83 "%s: failed to read data: ret: %d\r\n", __func__, ret);
phonemacro 8:b2d4c71268aa 84 }
phonemacro 8:b2d4c71268aa 85 } else {
phonemacro 8:b2d4c71268aa 86 printf("%s: failed to write to Register Select: ret: %d\r\n",
phonemacro 8:b2d4c71268aa 87 __func__, ret);
phonemacro 8:b2d4c71268aa 88 }
phonemacro 8:b2d4c71268aa 89 } else {
phonemacro 8:b2d4c71268aa 90 printf("%s: register address is not correct: register: %d\r\n",
phonemacro 8:b2d4c71268aa 91 __func__, reg);
phonemacro 8:b2d4c71268aa 92 }
phonemacro 8:b2d4c71268aa 93 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 94 }
phonemacro 8:b2d4c71268aa 95
phonemacro 8:b2d4c71268aa 96 float ds1775_read_reg_as_temperature(uint8_t reg, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 97 {
phonemacro 8:b2d4c71268aa 98 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 99 float temperature;
phonemacro 8:b2d4c71268aa 100 if (reg == DS1775_REG_TEMPERATURE ||
phonemacro 8:b2d4c71268aa 101 reg == DS1775_REG_THYST_LOW_TRIP || reg == DS1775_REG_TOS_HIGH_TRIP) {
phonemacro 8:b2d4c71268aa 102 ds1775_read_reg(&tmp.uwrd, reg, i2c_bus);
phonemacro 8:b2d4c71268aa 103 temperature = (float)tmp.magnitude_bits;
phonemacro 8:b2d4c71268aa 104 if (ds1775_extended_format)
phonemacro 8:b2d4c71268aa 105 temperature *= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 106 else
phonemacro 8:b2d4c71268aa 107 temperature *= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 108 if (tmp.sign_bit)
phonemacro 8:b2d4c71268aa 109 temperature = -temperature;
phonemacro 8:b2d4c71268aa 110 return temperature;
phonemacro 8:b2d4c71268aa 111
phonemacro 8:b2d4c71268aa 112 return temperature;
phonemacro 8:b2d4c71268aa 113 } else {
phonemacro 8:b2d4c71268aa 114 printf("%s: register is invalid, %d r\n", __func__, reg);
phonemacro 8:b2d4c71268aa 115 return 0;
phonemacro 8:b2d4c71268aa 116 }
phonemacro 8:b2d4c71268aa 117 }
phonemacro 8:b2d4c71268aa 118
phonemacro 8:b2d4c71268aa 119
phonemacro 8:b2d4c71268aa 120 /******************************************************************************/
phonemacro 8:b2d4c71268aa 121 int ds1775_write_reg(uint16_t value, char reg, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 122 {
phonemacro 8:b2d4c71268aa 123 int32_t ret;
phonemacro 8:b2d4c71268aa 124 char cmd[3];
phonemacro 8:b2d4c71268aa 125 ds1775_raw_data tmp;
phonemacro 8:b2d4c71268aa 126
phonemacro 8:b2d4c71268aa 127 if (reg >= DS1775_REG_CONFIGURATION && reg <= DS1775_REG_MAX) {
phonemacro 8:b2d4c71268aa 128 cmd[0] = reg;
phonemacro 8:b2d4c71268aa 129 tmp.uwrd = value;
phonemacro 8:b2d4c71268aa 130 cmd[1] = tmp.msb;
phonemacro 8:b2d4c71268aa 131 cmd[2] = tmp.lsb;
phonemacro 8:b2d4c71268aa 132 ret = i2c_bus.write(ds1775_write_address, cmd, 3, false);
phonemacro 8:b2d4c71268aa 133 if (ret == 0) {
phonemacro 8:b2d4c71268aa 134 if (DS1775_REG_CONFIGURATION == reg) {
phonemacro 8:b2d4c71268aa 135 ds1775_extended_format = 0;
phonemacro 8:b2d4c71268aa 136 if (tmp.uwrd & DS1775_CFG_EXTENDED_FORMAT)
phonemacro 8:b2d4c71268aa 137 ds1775_extended_format = 1;
phonemacro 8:b2d4c71268aa 138 }
phonemacro 8:b2d4c71268aa 139 return DS1775_NO_ERROR;
phonemacro 8:b2d4c71268aa 140 } else {
phonemacro 8:b2d4c71268aa 141 printf("%s: I2C write error %d\r\n",__func__, ret);
phonemacro 8:b2d4c71268aa 142 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 143 }
phonemacro 8:b2d4c71268aa 144 } else {
phonemacro 8:b2d4c71268aa 145 printf("%s: register value invalid %x\r\n",__func__, reg);
phonemacro 8:b2d4c71268aa 146 return DS1775_ERROR;
phonemacro 8:b2d4c71268aa 147 }
phonemacro 8:b2d4c71268aa 148 }
phonemacro 8:b2d4c71268aa 149
phonemacro 8:b2d4c71268aa 150
phonemacro 8:b2d4c71268aa 151 int ds1775_write_cfg(uint16_t cfg, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 152 {
phonemacro 8:b2d4c71268aa 153 return ds1775_write_reg(cfg, DS1775_REG_CONFIGURATION, i2c_bus);
phonemacro 8:b2d4c71268aa 154 }
phonemacro 8:b2d4c71268aa 155
phonemacro 8:b2d4c71268aa 156
phonemacro 8:b2d4c71268aa 157 int ds1775_write_trip_low(float temperature, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 158 {
phonemacro 8:b2d4c71268aa 159 ds1775_raw_data raw;
phonemacro 8:b2d4c71268aa 160 raw.uwrd = 0;
phonemacro 8:b2d4c71268aa 161 if (temperature < 0) {
phonemacro 8:b2d4c71268aa 162 raw.sign_bit = 1;
phonemacro 8:b2d4c71268aa 163 temperature = -temperature;
phonemacro 8:b2d4c71268aa 164 }
phonemacro 8:b2d4c71268aa 165 if (ds1775_extended_format)
phonemacro 8:b2d4c71268aa 166 temperature /= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 167 else
phonemacro 8:b2d4c71268aa 168 temperature /= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 169 raw.magnitude_bits = uint16_t(temperature);
phonemacro 8:b2d4c71268aa 170 return ds1775_write_reg(raw.uwrd, DS1775_REG_THYST_LOW_TRIP, i2c_bus);
phonemacro 8:b2d4c71268aa 171 }
phonemacro 8:b2d4c71268aa 172
phonemacro 8:b2d4c71268aa 173
phonemacro 8:b2d4c71268aa 174 int ds1775_write_trip_high(float temperature, I2C &i2c_bus)
phonemacro 8:b2d4c71268aa 175 {
phonemacro 8:b2d4c71268aa 176 ds1775_raw_data raw;
phonemacro 8:b2d4c71268aa 177 raw.uwrd = 0;
phonemacro 8:b2d4c71268aa 178 if (temperature < 0) {
phonemacro 8:b2d4c71268aa 179 raw.sign_bit = 1;
phonemacro 8:b2d4c71268aa 180 temperature = -temperature;
phonemacro 8:b2d4c71268aa 181 }
phonemacro 8:b2d4c71268aa 182 if (ds1775_extended_format)
phonemacro 8:b2d4c71268aa 183 temperature /= DS1775_CF_EXTENDED_FORMAT;
phonemacro 8:b2d4c71268aa 184 else
phonemacro 8:b2d4c71268aa 185 temperature /= DS1775_CF_NORMAL_FORMAT;
phonemacro 8:b2d4c71268aa 186 raw.magnitude_bits = uint16_t(temperature);
phonemacro 8:b2d4c71268aa 187 return ds1775_write_reg(raw.uwrd, DS1775_REG_TOS_HIGH_TRIP, i2c_bus);
phonemacro 8:b2d4c71268aa 188 }
phonemacro 8:b2d4c71268aa 189
phonemacro 8:b2d4c71268aa 190
phonemacro 8:b2d4c71268aa 191 float ds1775_celsius_to_fahrenheit(float temp_c)
phonemacro 8:b2d4c71268aa 192 {
phonemacro 8:b2d4c71268aa 193 float temp_f;
phonemacro 8:b2d4c71268aa 194 temp_f = ((temp_c * 9)/5) + 32;
phonemacro 8:b2d4c71268aa 195 return temp_f;
phonemacro 8:b2d4c71268aa 196 }