Revision 2:93ed4e2fe7fd, committed 2016-07-07

Comitter:

Rhyme

Date:

Thu Jul 07 03:57:36 2016 +0000

Parent:

1:e3d11ab4c524

Commit message:

Some document descriptions added about registers

Changed in this revision

diff -r e3d11ab4c524 -r 93ed4e2fe7fd MAX44000.h
--- a/MAX44000.h	Thu Jul 07 01:06:25 2016 +0000
+++ b/MAX44000.h	Thu Jul 07 03:57:36 2016 +0000
@@ -1,6 +1,4 @@
-/**
- * MAX44000
- * Ambient and Infrared Proximity Sensor
+/** MAX44000 Ambient and Infrared Proximity Sensor
  * I2C 7bit address: 0x4A
  *
  */
@@ -10,32 +8,34 @@
 
 #include "mbed.h"
 
-
-
-class MAX44000 
-{
-public:
- /**
- *  constructor
+/** @code 
+ * Registers
+ * addr : R/W : Rst  : Register
+ * 0x00 : R   : 0x04 : Interrupt Status 
+ * 0x01 : R/W : 0x24 : Main Configuration 
+ * 0x02 : R/W : 0x00 : Receive Configuration 
+ * 0x03 : R/W : 0x00 : Transmit Configuration 
+ * 0x04 : R   : 0x00 : ADC High Byte (ALS) 
+ * 0x05 : R   : 0x00 : ADC Low Byte (ALS) 
+ * 0x16 : R   : 0x00 : ADC Byte (PROX) 
+ * 0x06 : R/W : 0x00 : ALS Upper Threshold (High Byte) 
+ * 0x07 : R/W : 0x00 : ALS Upper Threshold (Low Byte) 
+ * 0x08 : R/W : 0x00 : ALS Lower Threshold (High Byte) 
+ * 0x09 : R/W : 0x00 : ALS Lower Threshold (Low Byte) 
+ * 0x0A : R/W : 0x00 : Threshold Persist Timer 
+ * 0x0B : R/W : 0x00 : PROX Threshold Indicator 
+ * 0x0C : R/W : 0x00 : PROX Threshold 
+ * 0x0F : R/W : 0x80 : Digital Gain Trim of Green Channel 
+ * 0x10 : R/W : 0x80 : Digital Gain Trim of Infrared Channel 
+ * 
+ * 0x00 : R   : 0x04 : Interrupt Status 
+ * Bit[7:3] : (reserved)
+ * Bit[2]   : PWRON : if set, indicates that a power-on-reset (POR) condition has occurred,
+ *                    and any user-programmed thresholds cannot be valid anymore.
+ * Bit[1]   : PRXINTS : indicates that an ambient light nterrupt condition occurred.
+ * BIt[0]   : ALSINTS : indicates that a proximity receive interrupt condition occurred.
  *
- * @param sda SDA pin
- * @param scl SCL pin
- * @param addr address of the I2C peripheral
- */
- MAX44000(PinName sda, PinName scl, int addr) ;
- 
- ~MAX44000() ;
-
- /*
-  * some member functions here (yet to be written)
-  */
-
-void getIntStatus(uint8_t *data) ;
-/**
- * Get Main Configuration
- *
- * @param *conf uint8_t pointer to receive the 8bit register value.
- *
+ * 0x01 : R/W : 0x24 : Main Configuration 
  * Bit[7:6] : (reserved)
  * Bit[5]   : TRIM 
  *   0: Use bytes written to TRIM_GAIN_GREEN[7:0] and TRIM_GAIN_IR[7:0] registers
@@ -52,23 +52,102 @@
  *   101: PROX Only : PROX only continuously. ALS channel operation and updates are disabled.
  *   110: (reserved)
  *   111: (reserved)
- * Bit[1]   : PRXINTE
+ * Bit[1]   : PRXINTE : 
+ *   0 : The PRXINTS bit remains unasserted, and proximity channel readings 
+ *       are not compared with interrupt thresholds.
+ *   1 : Detection of a proxmity interrupt event triggers a hardware interrupt (/INT pin is pulled low)
+ *       and sets the PRXINTS bit (register 0x00, B1). Proximity channel readings are compared with
+ *       proximity interrupt threshold settings and proximity persist timer.
  * Bit[0]   : ALSINTE
+ *   0 : The ALSINTS bit reamins unasserted, and ALS channel readings are not compared with interrupt thresholds.
+ *   1 : Detection of an ambient light interrupt event triggers a hardware interrupt (/INT pin is pullued low)
+ *       and sets the ALSINTS bit (register 0x00, B0). ALS channel readings are compared with ALS interrupt 
+ *       threshold settings and ALS persist timer.
+ *
+ * 0x02 : R/W : 0x00 : Receive Configuration 
+ * Bit[7:4] : (reserved)
+ * Bit[3:2] : ALSTIM : Ambient ADC Conversion Time
+ *       | Intergration Time (ms) | Full-Scale ADC counts | Bit Resolution | Relative LSB Size |
+ *    00 |        100             |        16,384         |        14      |           1x      | 
+ *    01 |         25             |         4,096         |        12      |           4x      |
+ *    10 |          6.25          |         1,024         |        10      |          16x      |
+ *    11 |          1.5625        |           256         |         8      |          64x      |
+ * Bit[1:0] : ALSPGA : Ambient Light Measurement Gain
+ *       |        LUX/LSB         |   Relative LSB Size   |
+ *    00 |        0.03125         |          1x           |
+ *    01 |        0.125           |          4x           |
+ *    10 |        0.5             |         16x           |
+ *    11 |        4               |        128x           |
+ *
+ * 0x03 | R/W | 0x00 | Transmit Configuration 
+ * 0x04 | R   | 0x00 | ADC High Byte (ALS) 
+ * 0x05 | R   | 0x00 | ADC Low Byte (ALS) 
+ * 0x16 | R   | 0x00 | ADC Byte (PROX) 
+@endcode
+*/
+ 
+
+
+class MAX44000 
+{
+public:
+ /**
+ *  constructor
+ *
+ * @param sda SDA pin
+ * @param scl SCL pin
+ * @param addr address of the I2C peripheral
+ */
+ MAX44000(PinName sda, PinName scl, int addr) ;
+ 
+ /**
+  * destructor
+  */
+ ~MAX44000() ;
+
+ /*
+  * some member functions here (yet to be written)
+  */
+
+/**
+ * Get Interrupt Status
+ * @param uint8_t *data pointer to receive the 8bit register value.
+ */
+void getIntStatus(uint8_t *data) ;
+/**
+ * Get Main Configuration
+ * @param uint8_t *conf pointer to receive the 8bit register value.
  */
 void getMainConfig(uint8_t *conf) ;
 /**
  * Set Mein Configuration
- *
  * @param conf uint8_t to specify the 8bit register value.
- * For the meanings of each bits, please refer to setMainConfig() description.
  */
 void setMainConfig(uint8_t newConf) ;
 void getRxConfig(uint8_t *conf) ;
 void setRxConfig(uint8_t newConf) ;
 void getTxConfig(uint8_t *conf) ;
 void setTxConfig(uint8_t newConf) ;
+/**
+ * Get ALS
+ *
+ * @param uint8_t *ofl overflow indicator
+ * @param uint16_t *value ALS value
+ */
 void getALS(uint8_t *ofl, uint16_t *value) ;
+/**
+ * Get PROX
+ *
+ * @param uint8_t *value PROX value
+ */
 void getProx(uint8_t *value) ;
+/**
+ * Get ADC value(s)
+ *
+ * @param uint8_t *ofl overfolow indicator
+ * @param uint16_t *als ALS data
+ * @param uint8_t *prox PROX data
+ */
 void getADC(uint8_t *ofl, uint16_t *als, uint8_t *prox) ;
 void getUPTHR(uint16_t *thr) ;
 void setUPTHR(uint16_t newThr) ;