Kenji Arai / 6180XA1_simple

use VL6180XA1 chip wothout X-NUCLEO-6180XA1 Board. Simple way to use the chip.

Dependents:   Check_VL6180XA1_ToF

Fork of X_NUCLEO_6180XA1 by ST

Files at this revision

API Documentation at this revision

Revision 30:75bf50276881, committed 2015-11-09

Comitter:
mapellil
Date:
Mon Nov 09 09:38:34 2015 +0000
Parent:
29:6d6b67e2e212
Child:
31:f99c53a51917
Commit message:
fixed some doxygen comments

Changed in this revision

Components/VL6180X/vl6180x_class.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Components/VL6180X/vl6180x_class.h	Fri Nov 06 08:39:27 2015 +0100
+++ b/Components/VL6180X/vl6180x_class.h	Mon Nov 09 09:38:34 2015 +0000
@@ -3,7 +3,7 @@
  * @file    vl6180x_class.h
  * @author  AST / EST
  * @version V0.0.1
- * @date    14-April-2015
+ * @date    9-November-2015
  * @brief   Header file for component VL6180X
  ******************************************************************************
  * @attention
@@ -96,11 +96,11 @@
 class VL6180X : public RangeSensor, public LightSensor 
 {
  public:
-    /** Constructor
-     * @param[in] i2c device I2C to be used for communication
-     * @param[in] digital out pin/STMPE1600DigiOut pin to be used for GPIO expander communication
-     * @param[in] gpio1 pin
-     * @param[in] device address, 0x29 by default  
+    /** Constructor 1
+     * @param[in] &i2c device I2C to be used for communication
+     * @param[in] &pin Mbed DigitalOut pin to be used as component GPIO_0 CE
+     * @param[in] pin_gpio1 pin Mbed InterruptIn PinName to be used as component GPIO_1 INT
+     * @param[in] DevAddr device address, 0x29 by default  
      */
     VL6180X(DevI2C &i2c, DigitalOut &pin, PinName pin_gpio1, uint8_t DevAddr=DEFAULT_DEVICE_ADDRESS) : RangeSensor(), LightSensor(), dev_i2c(i2c), gpio0(&pin), interrupt_measure(pin_gpio1)
     {
@@ -110,7 +110,12 @@
        Device=&MyDevice;;
        expgpio0=NULL;
     }  
-		
+    /** Constructor 2
+     * @param[in] i2c device I2C to be used for communication
+     * @param[in] &pin Gpio Expander STMPE1600DigiOut pin to be used as component GPIO_0 CE
+     * @param[in] pin_gpio1 pin Mbed InterruptIn PinName to be used as component GPIO_1 INT
+     * @param[in] device address, 0x29 by default  
+     */		
     VL6180X(DevI2C &i2c, STMPE1600DigiOut &pin, PinName pin_gpio1, uint8_t DevAddr=DEFAULT_DEVICE_ADDRESS) : RangeSensor(), LightSensor(), dev_i2c(i2c), expgpio0(&pin), interrupt_measure(pin_gpio1)
     {
        MyDevice.I2cAddr=DevAddr;		 
@@ -122,7 +127,7 @@
     
    /** Destructor
     */
-    //virtual ~VL6180X(){} 
+    virtual ~VL6180X(){} 
     /* warning: VL6180X class inherits from GenericSensor, RangeSensor and LightSensor, that haven`t a destructor.
        The warning should request to introduce a virtual destructor to make sure to delete the object */