X-NUCLEO-6180XA1 Proximity and Ambient Light Sensor Expansion Board Firmware Package

Revision 50:18e064bfb156, committed 2016-09-09

Comitter:

mapellil

Date:

Fri Sep 09 09:50:12 2016 +0000

Parent:

49:f0dd44dd59c5

Child:

51:229ea522cff8

Commit message:

Added the GetDistance and GetLux API doing respectively a synchronous range_single_shot_polling and als_single_shot_polling measure in blocking mode

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Components/Interfaces/ComponentObject.h	Fri Sep 09 09:50:12 2016 +0000
@@ -0,0 +1,77 @@
+/**
+ ******************************************************************************
+ * @file    ComponentObject.h
+ * @author  AST
+ * @version V1.0.0
+ * @date    April 13th, 2015
+ * @brief   This file contains the abstract class describing the interface of a
+ *          generic component object, from which all the other components
+ *          should inherit.
+ ******************************************************************************
+ * @attention
+ *
+ * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright notice,
+ *      this list of conditions and the following disclaimer in the documentation
+ *      and/or other materials provided with the distribution.
+ *   3. Neither the name of STMicroelectronics nor the names of its contributors
+ *      may be used to endorse or promote products derived from this software
+ *      without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ ******************************************************************************
+ */
+ 
+ 
+/* Define to prevent recursive inclusion -------------------------------------*/
+ 
+#ifndef __COMPONENT_OBJECT_H
+#define __COMPONENT_OBJECT_H
+ 
+ 
+/* Includes ------------------------------------------------------------------*/
+ 
+#include <stdint.h>
+ 
+ 
+/* Classes  ------------------------------------------------------------------*/
+ 
+/** An abstract class for Generic components.
+ */
+class ComponentObject
+{
+public:
+    /**
+     * @brief     Initializing the component.
+     * @param[in] init pointer to device specific initalization structure.
+     * @retval    "0" in case of success, an error code otherwise.
+     */
+    virtual int Init(void *init) = 0;
+ 
+    /**
+     * @brief      Getting the ID of the component.
+     * @param[out] id pointer to an allocated variable to store the ID into.
+     * @retval     "0" in case of success, an error code otherwise.
+     */
+    virtual int ReadID(uint8_t *id) = 0;
+};
+ 
+#endif /* __COMPONENT_OBJECT_H */
+ 
+/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
+ 
\ No newline at end of file

--- a/Components/Interfaces/Component_class.h	Wed Jun 15 11:55:18 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,75 +0,0 @@
-/**
- ******************************************************************************
- * @file    Component_class.h
- * @author  Davide Aliprandi, STMicrolectronics
- * @version V1.0.0
- * @date    April 13th, 2015
- * @brief   This file contains the abstract class describing the interface of a
- *          generic component.
- ******************************************************************************
- * @attention
- *
- * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *   1. Redistributions of source code must retain the above copyright notice,
- *      this list of conditions and the following disclaimer.
- *   2. Redistributions in binary form must reproduce the above copyright notice,
- *      this list of conditions and the following disclaimer in the documentation
- *      and/or other materials provided with the distribution.
- *   3. Neither the name of STMicroelectronics nor the names of its contributors
- *      may be used to endorse or promote products derived from this software
- *      without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- ******************************************************************************
- */
-
-
-/* Define to prevent from recursive inclusion --------------------------------*/
-
-#ifndef __COMPONENT_CLASS_H
-#define __COMPONENT_CLASS_H
-
-
-/* Includes ------------------------------------------------------------------*/
-
-#include <stdint.h>
-
-
-/* Classes  ------------------------------------------------------------------*/
-
-/** An abstract class for Generic components.
- */
-class Component
-{
-public:
-    /**
-     * @brief  Initializing the component.
-     * @param  init Pointer to device specific initalization structure.
-     * @retval "0" in case of success, an error code otherwise.
-     */
-    virtual int Init(void *init) = 0;
-
-    /**
-     * @brief  Getting the ID of the component.
-     * @param  id Pointer to an allocated variable to store the ID into.
-     * @retval "0" in case of success, an error code otherwise.
-     */
-    virtual int ReadID(uint8_t *id) = 0;
-};
-
-#endif /* __COMPONENT_CLASS_H */
-
-/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Components/Interfaces/DistanceSensor.h	Fri Sep 09 09:50:12 2016 +0000
@@ -0,0 +1,60 @@
+/**
+ ******************************************************************************
+ * @file    DistanceSensor.h
+ * @author  AST / EST
+ * @version V0.0.1
+ * @date    08-September-2016
+ * @brief   This file contains the abstract class describing in general
+ *          the interfaces of a distance sensor
+ ******************************************************************************
+ * @attention
+ *
+ * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright notice,
+ *      this list of conditions and the following disclaimer in the documentation
+ *      and/or other materials provided with the distribution.
+ *   3. Neither the name of STMicroelectronics nor the names of its contributors
+ *      may be used to endorse or promote products derived from this software
+ *      without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ ******************************************************************************
+ */
+
+/* Define to prevent from recursive inclusion --------------------------------*/
+#ifndef __DISTANCE_SENSOR_CLASS_H
+#define __DISTANCE_SENSOR_CLASS_H
+
+/* Includes ------------------------------------------------------------------*/
+#include "ComponentObject.h"
+
+/* Classes  ------------------------------------------------------------------*/
+/** An abstract class for distance sensors
+ */
+class DistanceSensor : public ComponentObject
+{
+ public:
+    /**
+     * @brief       Get current distance [mm]
+     * @param[out]  piData Pointer to where to store distance to
+     * @return      0 in case of success, an error code otherwise
+     */
+    virtual int GetDistance(uint32_t *piData) = 0;
+};
+
+#endif /* __DISTANCE_SENSOR_CLASS_H */

--- a/Components/Interfaces/LightSensor.h	Wed Jun 15 11:55:18 2016 +0000
+++ b/Components/Interfaces/LightSensor.h	Fri Sep 09 09:50:12 2016 +0000
@@ -41,12 +41,12 @@
 #define __LIGHT_SENSOR_CLASS_H
 
 /* Includes ------------------------------------------------------------------*/
-#include "Component_class.h"
+#include "ComponentObject.h"
 
 /* Classes  ------------------------------------------------------------------*/
 /** An abstract class for ambient light sensors
  */
-class LightSensor : public Component
+class LightSensor : public ComponentObject
 {
  public:
     /**
@@ -54,7 +54,7 @@
      * @param[out]  piData Pointer to where to store light to
      * @return      0 in case of success, an error code otherwise
      */
-    virtual int GetLight(uint32_t *piData) = 0;
+    virtual int GetLux(uint32_t *piData) = 0;
 };
 
 #endif /* __LIGHT_SENSOR_CLASS_H */

--- a/Components/Interfaces/RangeSensor.h	Wed Jun 15 11:55:18 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,60 +0,0 @@
-/**
- ******************************************************************************
- * @file    RangeSensor.h
- * @author  AST / EST
- * @version V0.0.1
- * @date    13-April-2015
- * @brief   This file contains the abstract class describing in general
- *          the interfaces of a range sensor
- ******************************************************************************
- * @attention
- *
- * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *   1. Redistributions of source code must retain the above copyright notice,
- *      this list of conditions and the following disclaimer.
- *   2. Redistributions in binary form must reproduce the above copyright notice,
- *      this list of conditions and the following disclaimer in the documentation
- *      and/or other materials provided with the distribution.
- *   3. Neither the name of STMicroelectronics nor the names of its contributors
- *      may be used to endorse or promote products derived from this software
- *      without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- ******************************************************************************
- */
-
-/* Define to prevent from recursive inclusion --------------------------------*/
-#ifndef __RANGE_SENSOR_CLASS_H
-#define __RANGE_SENSOR_CLASS_H
-
-/* Includes ------------------------------------------------------------------*/
-#include "Component_class.h"
-
-/* Classes  ------------------------------------------------------------------*/
-/** An abstract class for range sensors
- */
-class RangeSensor : public Component
-{
- public:
-    /**
-     * @brief       Get current range [mm]
-     * @param[out]  piData Pointer to where to store range to
-     * @return      0 in case of success, an error code otherwise
-     */
-    virtual int GetRange(int32_t *piData) = 0;
-};
-
-#endif /* __RANGE_SENSOR_CLASS_H */

--- a/Components/VL6180X/vl6180x_class.h	Wed Jun 15 11:55:18 2016 +0000
+++ b/Components/VL6180X/vl6180x_class.h	Fri Sep 09 09:50:12 2016 +0000
@@ -39,7 +39,7 @@
 #define __VL6180X_CLASS_H
 
 /* Includes ------------------------------------------------------------------*/
-#include "RangeSensor.h"
+#include "DistanceSensor.h"
 #include "LightSensor.h"
 #include "DevI2C.h" 
 //#include "vl6180x_api.h"
@@ -93,7 +93,7 @@
 /* Classes -------------------------------------------------------------------*/
 /** Class representing a VL6180X sensor component
  */
-class VL6180X : public RangeSensor, public LightSensor
+class VL6180X : public DistanceSensor, public LightSensor
 {
  public:
     /** Constructor 1 (DigitalOut)
@@ -102,7 +102,7 @@
      * @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)
+    VL6180X(DevI2C &i2c, DigitalOut &pin, PinName pin_gpio1, uint8_t DevAddr=DEFAULT_DEVICE_ADDRESS) : DistanceSensor(), LightSensor(), dev_i2c(i2c), gpio0(&pin)
     {
        MyDevice.I2cAddr=DevAddr;		 
        MyDevice.Present=0;
@@ -118,7 +118,7 @@
      * @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)
+    VL6180X(DevI2C &i2c, STMPE1600DigiOut &pin, PinName pin_gpio1, uint8_t DevAddr=DEFAULT_DEVICE_ADDRESS) : DistanceSensor(), LightSensor(), dev_i2c(i2c), expgpio0(&pin)
     {
        MyDevice.I2cAddr=DevAddr;		 
        MyDevice.Present=0;
@@ -471,18 +471,48 @@
  * @par Function Description
  * Unlike @a VL6180x_RangeGetMeasurement() this function only retrieves the range in millimeter \n
  * It does any required up-scale translation\n
- * It can be called after success status polling or in interrupt mode \n
+ * It can be called after having started a measure and after a succes \n
+ * measure is finisched either in polling mode or in interrupt mode \n
  * @warning these function is not doing wrap around filtering \n
  * This function doesn't perform any data ready check!
  *
  * @param pRange_mm  Pointer to range distance
  * @return           0 on success
  */		
-    virtual int GetRange(int32_t *piData)
+    int GetRange(int32_t *piData)
     {
        return VL6180x_RangeGetResult(Device, piData);
     }
-		
+
+/**
+ * @brief Get a single distance measure result
+ *
+ * @par Function Description
+ * It can be called after having initialized a component. It start a single 
+ * distance measure in polling mode and wait until the measure is finisched. 
+ * The function block until the measure is finished, it can blocks indefinitely 
+ * in case the measure never ends for any reason \n
+ *
+ * @param piData  Pointer to distance
+ * @return           0 on success
+ */		
+    virtual int GetDistance(uint32_t *piData)
+    {
+       int status=0; 
+       LOG_FUNCTION_START("");
+       status=StartMeasurement(range_single_shot_polling, NULL, NULL, NULL);
+       if (!status) {
+		  RangeWaitDeviceReady(2000);				 
+          for (status=1; 
+               status!=0; 
+               status=GetRange((int32_t *)piData));
+       }
+       StopMeasurement(range_single_shot_polling);
+       RangeWaitDeviceReady(2000);
+       LOG_FUNCTION_END(status);       
+       return status;
+    }
+			
 /**
  * @brief Configure ranging interrupt reported to application
  *
@@ -1079,12 +1109,38 @@
  * @param *piData The pointer to variable to write in the measure in Lux
  * @return  0       On success
  */				
-    virtual int GetLight(uint32_t *piData)
+    int GetLight(uint32_t *piData)
     {
        return VL6180x_AlsGetLux(Device, piData);
     }
 
 /**
+ * @brief Get a single light (in Lux) measure result
+ *
+ * @par Function Description
+ * It can be called after having initialized a component. It start a single 
+ * light measure in polling mode and wait until the measure is finisched. 
+ * The function block until the measure is finished, it can blocks indefinitely 
+ * in case the measure never ends for any reason \n
+ */				
+    virtual int GetLux(uint32_t *piData)
+    {
+       int status=0; 
+       LOG_FUNCTION_START("");
+       status=StartMeasurement(als_single_shot_polling, NULL, NULL, NULL);
+       if (!status) {
+          AlsWaitDeviceReady(2000);				 
+          for (status=1; 
+               status!=0; 
+               status=GetLight(piData));
+       }
+       StopMeasurement(als_single_shot_polling);
+	   AlsWaitDeviceReady(2000);				 			 
+       LOG_FUNCTION_END(status);       
+       return status;
+    }
+
+/**
  * @brief Start the ALS (light) measure in continous mode
  *
  * @par Function Description