Diff: VEML7700.h

Revision:

2:63196ef2a2ed

Parent:

0:6dabb0ddf3d9

Child:

3:67634e08150f

--- a/VEML7700.h	Fri Apr 28 06:59:31 2017 +0000
+++ b/VEML7700.h	Fri May 19 06:09:32 2017 +0000
@@ -24,13 +24,67 @@
   * VEML7700 destructor
   */
   ~VEML7700();
-  
+
+/**
+ * set ALS Configure register
+ * @param uint16_t conf value to set
+ * @returns none
+ * @note bit[5:4] ALS_PERS ALS persistence protect number setting
+ * @note 00=1, 01=2, 10= 4, 11=8
+ * @note -
+ * @note bit[1] ALS_INT_EN ALS interrupt enable setting
+ * @note 0:ALS INT disable, 1:ALS INT enable
+ * @note -
+ * @note bit[0] ALS_SD ALS shutdown setting
+ * @note 0=ALS power on, 1=ALS shutdown
+ */
 void setALSConf(uint16_t conf) ;
+
+/**
+ * set ALS high threshold window setting
+ * @param uint16_t wh value to set
+ * @returns none
+ */
 void setALS_WH(uint16_t wh) ;
+
+/**
+ * set ALS low threshold window setting
+ * @param uint16_t wl value to set
+ * @returns none
+ */
 void setALS_WL(uint16_t wl) ;
+
+/**
+ * set Power Saving setting
+ * @param uint16_t ps
+ * @returns none
+ * @note bit[2:1] PSM Power Saving Mode
+ * @note bit[0] PSM_EN Power Saving Mode enable setting
+ */
 void setPowerSaving(uint16_t ps) ;
+
+/**
+ * get ALS 
+ * @param none
+ * @returns uint16_t ALS (Ambient Light Sensed(?))
+ */
 uint16_t getALS(void) ;
+
+/**
+ * get White channel reading
+ * @param none
+ * @returns uint16_t White channel sensed
+ */
 uint16_t getWHITE(void) ;
+
+/**
+ * get ALS INT trigger event
+ * @param none
+ * @returns uint16_t ALS_INT
+ * @note bit[15] ALS_IF_L ALS crossing low threshold INT trigger event
+ * @note bit[14] ALS_IF_H ALS crossing high threshold INT trigger event
+ * @note bit[13:0] (reserved)
+ */
 uint16_t getALS_INT(void) ;
   
 private: