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

Diff: max31875.h

Revision:
2:048eff228fd8
Parent:
1:98499c3dace6
Child:
3:3528e660168c
--- a/max31875.h	Mon Feb 04 05:16:52 2019 +0000
+++ b/max31875.h	Mon Feb 04 05:32:58 2019 +0000
@@ -209,7 +209,9 @@
      float celsius_to_fahrenheit(float temp_c);
 
 protected: 
-    /** union data structure for byte word manipulations */
+    /** @union max31875_raw_data
+     * @brief union data structure for byte word manipulations
+     */
     union max31875_raw_data {
         struct {
             uint8_t lsb;
@@ -228,11 +230,17 @@
     int write_reg(uint16_t value, char reg);
 
 private:
-    /** I2C object */
+    /** @var m_i2c
+     * @brief I2C object
+     */
     I2C &m_i2c;
-    /** Device slave addresses */
+    /** @var m_writeAddress, m_readAddress
+     * @brief I2C address
+     */
     uint8_t m_writeAddress, m_readAddress;
-    /** Extended Data Format flag. */
+    /** @var m_writeAddress, m_readAddress
+     * @brief m_extended_format
+     */
     uint32_t m_extended_format;
 };