Diff: DS7505.hpp

Revision:

32:0a09505a656d

Parent:

24:434330962308

diff -r 7b10bcb3e0fc -r 0a09505a656d DS7505.hpp
--- a/DS7505.hpp	Tue Apr 04 14:10:48 2017 -0500
+++ b/DS7505.hpp	Mon Nov 06 17:34:13 2017 -0600
@@ -28,110 +28,101 @@
 * trademarks, maskwork rights, or any other form of intellectual
 * property whatsoever. Maxim Integrated Products, Inc. retains all
 * ownership rights.
-*******************************************************************************
-*/
+*******************************************************************************/
 
 #ifndef DS7505_HPP
 #define DS7505_HPP
 
 #include <stdint.h>
 
-namespace mbed
-{
-  class I2C;
-}
+namespace mbed { class I2C; }
 
 /// Interface to the DS7505 temperature sensor.
-class DS7505
-{
+class DS7505 {
 public:
-  enum Result
-  {
-    Success,
-    Hardware_Failure,
-    Out_of_Range
-  };
-  
+  enum Result { Success, Hardware_Failure, Out_of_Range };
+
   /// @param I2C_interface A configured I2C interface to use for communication.
   /// @param I2C_address Device bus address in mbed format.
   DS7505(mbed::I2C & I2C_interface, uint8_t I2C_address);
-  
+
   /// Set the resolution for temperature conversions.
   /// @param resolution Number of decimal bit from 1 to 4.
   Result set_resolution(uint8_t resolution);
-  
+
   /// Reads the current temperature with an exponent of 10^-2.
-  /// @note Compatible with Bluetooth characteristic: org.bluetooth.characteristic.temperature.
+  /// @note Compatible with Bluetooth characteristic:
+  /// org.bluetooth.characteristic.temperature.
   Result read_current_temp(int16_t & temperature) const;
-  
+
   /// Reads the current temperature as a floating point value.
   Result read_current_temp(double & temperature) const;
-  
+
   /// Reads the current temperature as an integer value.
   Result read_current_temp(int8_t & temperature) const;
-  
+
 private:
   /// Bit resolution of temperature conversions.
-  enum Config_Resolution
-  {
+  enum Config_Resolution {
     Config_9b_Res = 0x00,
     Config_10b_Res = 0x20,
     Config_11b_Res = 0x40,
     Config_12b_Res = 0x60
   };
-  
+
   /// DS7505 Register addresses.
-  enum Register
-  {
+  enum Register {
     Temperature_Reg = 0x00,
     Configuration_Reg = 0x01,
     Thyst_Reg = 0x02,
     Tos_Reg = 0x03
   };
-  
+
   /// Represents a DS7505 configuration.
-  struct Config
-  {
+  struct Config {
     Config_Resolution resolution;
     bool enable_shutdown_mode;
-    
+
     Config(Config_Resolution resolution, bool enable_shutdown_mode)
-      : resolution(resolution), enable_shutdown_mode(enable_shutdown_mode) { }
+        : resolution(resolution), enable_shutdown_mode(enable_shutdown_mode) {}
   };
-  
+
   /// @note Mark as mutable to allow manipulation by read_temp_sensor().
   mutable Config m_current_config;
-  
+
   mbed::I2C & m_I2C_interface;
   uint8_t m_I2C_address;
-  
-  /// Returns the maximum time needed in ms for a sample at the specified resolution.
+
+  /// Returns the maximum time needed in milliseconds for a sample at the
+  /// specified resolution.
   static uint8_t get_measure_delay_ms(Config_Resolution resolution);
-  
-  /// Reads the current temperature via I2C.
-  /// Assumes that the I2C register pointer is already set to the temperature register.
-  /// @param sensor_data Output for raw data from DS7505 with upper and lower bytes combined.
+
+  /// Reads the current temperature via I2C. Assumes that the I2C register
+  /// pointer is already set to the temperature register.
+  /// @param sensor_data
+  /// Output for raw data from DS7505 with upper and lower bytes combined.
   /// @returns True on success.
   bool read_temp_sensor_data(uint16_t & sensor_data) const;
-  
+
   /// Reads the current temperature with support for shutdown mode.
-  /// @param sensor_data Output for raw data from DS7505 with upper and lower bytes combined.
+  /// @param sensor_data Output for raw data from DS7505 with upper and lower
+  /// bytes combined.
   /// @returns Success or Hardware_Failure.
   Result read_temp_sensor(uint16_t & sensor_data) const;
-  
+
   /// Sets the I2C register pointer for the next operation.
   /// @param pointer_reg Desired register to set.
   /// @returns True on success.
   /// @note Allow marking const since not public.
   bool set_register_pointer(Register pointer_reg) const;
-  
+
   /// Writes to a device register via I2C.
   /// @param write_reg Register to write to.
   /// @param write_val Value to write to the register.
   /// @returns True on success.
   /// @note Allow marking const since not public
   bool write_register(Register write_reg, uint8_t write_val) const;
-  
+
   /// Writes the current configuration via I2C.
   /// @returns True on success.
   /// @note Allow marking const since not public