Diff: MAX30205.h

Revision:

7:f005887f21e7

Parent:

6:b5ab5204d944

Child:

8:2aeb45dd2bb9

diff -r b5ab5204d944 -r f005887f21e7 MAX30205.h
--- a/MAX30205.h	Tue Apr 11 22:07:28 2017 +0000
+++ b/MAX30205.h	Thu May 18 20:50:39 2017 +0000
@@ -36,7 +36,13 @@
 #include "mbed.h"
 
 /**
- * Driver for the MAX30205
+ * @brief Library for the MAX30205\n
+ * The MAX30205 temperature sensor accurately measures temperature and provide 
+ * an overtemperature alarm/interrupt/shutdown output. This device converts the 
+ * temperature measurements to digital form using a high-resolution, 
+ * sigma-delta, analog-to-digital converter (ADC). Accuracy meets clinical 
+ * thermometry specification of the ASTM E1112 when soldered on the final PCB. 
+ * Communication is through an I2C-compatible 2-wire serial interface.
  *
  * @code
  * #include "mbed.h"
@@ -46,7 +52,7 @@
  * MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3);
  *
  * //Get I2C instance
- * I2C i2cBus(P3_4, P3_5);
+ * I2C i2cBus(I2C1_SDA, I2C1_SCL);
  *
  * //Get temp sensor instance
  * MAX30205 bodyTempSensor(i2cBus, 0x4D); //Constructor takes 7-bit slave adrs
@@ -65,10 +71,10 @@
     /// MAX30205 Register Addresses
     enum Registers_e 
     {
-        Temperature = 0x00,
+        Temperature   = 0x00,
         Configuration = 0x01,
-        THYST = 0x02,
-        TOS = 0x03
+        THYST         = 0x02,
+        TOS           = 0x03
     };
     
     ///MAX30205 Configuration register bitfields