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.h
- Committer:
- phonemacro
- Date:
- 2019-04-07
- Revision:
- 14:c74a5b4d6715
- Parent:
- 12:3ca79cd71289
- Child:
- 15:449134e4b43f
File content as of revision 14:c74a5b4d6715:
/******************************************************************************* * Copyright (C) 2019 Maxim Integrated Products, Inc., All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * Except as contained in this notice, the name of Maxim Integrated * Products, Inc. shall not be used except as stated in the Maxim Integrated * Products, Inc. Branding Policy. * * The mere transfer of this software does not imply any licenses * of trade secrets, proprietary technology, copyrights, patents, * trademarks, maskwork rights, or any other form of intellectual * property whatsoever. Maxim Integrated Products, Inc. retains all * ownership rights. ******************************************************************************* * @file ds1775_cpp.h ******************************************************************************* */ #ifndef DS1775_CPP_H #define DS1775_CPP_H #include "mbed.h" /** * @brief Digital thermometer, thermostat, temperature sensor. * @version 1.0000.0000 * * @details The DS1775 reports the device's temperature * over the I2C bus. * It supports high, low triggers stored in EEPROM for hystersis * or limit alarms using comparator or interrupt mode. * The DS1775 can operate in shutdown and one-shot mode for * extremely low power applications. * The software is compatible with the DS75. * Five pin SOT23 package * Accuracy is +-2.0°C from -55°C to +125°C (-67°F to +257°), * * @code * #include "mbed.h" * #include "max32630fthr.h" * #include "ds1775.h" * #include "USBSerial.h" * MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3); * I2C i2cBus(P3_4, P3_5); * int main() * { * float temperature; * DigitalOut rLED(LED1, LED_OFF); * DigitalOut gLED(LED2, LED_OFF); * DigitalOut bLED(LED3, LED_OFF); * gLED = LED_ON; * DS1775 temp_sensor(i2cBus, DS1775_I2C_SLAVE_ADR_R0); * i2cBus.frequency(400000); * temperature = * temp_sensor.read_reg_as_temperature(DS1775_REG_TEMPERATURE); * printf("Temperature = %3.4f Celsius, %3.4f Fahrenheit\r\n", * temperature, temp_sensor.celsius_to_fahrenheit(temperature)); * } * @endcode */ class DS1775 { public: /**********************************************************//** * @brief Constructor for DS1775 Class. * * @details Allows user to use existing I2C object * * On Entry: * @param[in] i2c_bus - pointer to existing I2C object * @param[in] i2c_adrs - 7-bit slave address of DS1775 * * On Exit: * * @return None **************************************************************/ DS1775(I2C &i2c_bus, uint8_t slave_address); /**********************************************************//** * @brief Default destructor for DS1775 Class. * * @details Destroys I2C object if owner * * On Entry: * * On Exit: * * @return None **************************************************************/ ~DS1775(); /** * @brief Read register of device at slave address * @param[out] value - Read data on success * @return 0 on success, negative number on failure */ int read_cfg_reg(uint8_t *value); /** * @brief Read register of device at slave address * @param[out] value - Read data on success * @param reg - Register address * @return 0 on success, negative number on failure */ int read_reg(int16_t *value, char reg); /** * @brief Reads the temperature registers * @param reg - the address of the temperature register * @return temperature in degrees Celsius */ float read_reg_as_temperature(uint8_t reg); /** * @brief Writes to the configuration register * @param cfg - configurate word * @return 0 on success, negative number on failure */ int write_cfg(uint16_t cfg); /** * @brief Writes to the THYST register * @param temperature - the temperature in Celsius degrees * @return 0 on success, negative number on failure */ int write_trip_low(float temperature); /** * @brief Writes to the TOS register * @param temperature - the temperature in Celsius degrees * @return 0 on success, negative number on failure */ int write_trip_high(float temperature); /** * @brief Converts Celsius degrees to Fahrenheit * @param temp_c - the temperature in Celsius degrees * @return temperature in Celsius degrees */ float celsius_to_fahrenheit(float temp_c); protected: /** * @brief Write a value to a register * @param value - value to write to the register * @param reg - register address * @return 0 on success, negative number on failure */ int write_reg(int16_t value, char reg); /** * @brief Write a value to a register * @param value - value to write to the register * @param reg - register address * @return 0 on success, negative number on failure */ int write_reg_one_byte(uint8_t value, char reg); private: /** @var m_i2c * @brief I2C object */ I2C &m_i2c; /** @var m_write_address, m_read_address * @brief I2C address */ uint8_t m_write_address, m_read_address; }; #endif/* DS1775_CPP_H */