Librairie adaptée au laboratoire 2
Dependencies: ST_INTERFACES X_NUCLEO_COMMON
Fork of X_NUCLEO_6180XA1 by
Revision 1:1de1ea2994d9, committed 2015-09-09
- Comitter:
- gallonm
- Date:
- Wed Sep 09 16:00:39 2015 +0000
- Parent:
- 0:1fb1f010ac84
- Child:
- 2:7684e0b4e40e
- Commit message:
- Added some files
Changed in this revision
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/Interfaces/GenericSensor.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,67 @@ +/** + ****************************************************************************** + * @file GenericSensor.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 generic sensor + ****************************************************************************** + * @attention + * + * <h2><center>© 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 __GENERIC_SENSOR_CLASS_H +#define __GENERIC_SENSOR_CLASS_H + +/* Includes ------------------------------------------------------------------*/ +#include <stdint.h> + +/* Classes ------------------------------------------------------------------*/ +/** An abstract class for Generic sensors + */ +class GenericSensor +{ + public: + /** + * @brief Initialization of sensor + * @param[out] ptr Pointer to device specific initalization structure + * @return 0 in case of success, an error code otherwise + */ + virtual int Init(void *ptr) = 0; + + /** + * @brief Get ID of sensor + * @param[out] id Pointer to where to store the ID to + * @return 0 in case of success, an error code otherwise + */ + virtual int ReadID(uint8_t *id) = 0; +}; + +#endif /* __GENERIC_SENSOR_CLASS_H */ \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/Interfaces/LightSensor.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,60 @@ +/** + ****************************************************************************** + * @file LightSensor.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 an ambient light sensor (ALS) + ****************************************************************************** + * @attention + * + * <h2><center>© 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 __LIGHT_SENSOR_CLASS_H +#define __LIGHT_SENSOR_CLASS_H + +/* Includes ------------------------------------------------------------------*/ +#include <GenericSensor.h> + +/* Classes ------------------------------------------------------------------*/ +/** An abstract class for Humidity sensors + */ +class LightSensor : public GenericSensor +{ + public: + /** + * @brief Get current light [lux] + * @param[out] pfData Pointer to where to store light to + * @return 0 in case of success, an error code otherwise + */ + virtual int GetLight(int *piData) = 0; +}; + +#endif /* __LIGHT_SENSOR_CLASS_H */ \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/Interfaces/RangeSensor.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,60 @@ +/** + ****************************************************************************** + * @file HumiditySensor.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 an ambient light sensor (ALS) + ****************************************************************************** + * @attention + * + * <h2><center>© 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 __LIGHT_SENSOR_CLASS_H +#define __LIGHT_SENSOR_CLASS_H + +/* Includes ------------------------------------------------------------------*/ +#include <GenericSensor.h> + +/* Classes ------------------------------------------------------------------*/ +/** An abstract class for Humidity sensors + */ +class LightSensor : public GenericSensor +{ + public: + /** + * @brief Get current light [lux] + * @param[out] pfData Pointer to where to store light to + * @return 0 in case of success, an error code otherwise + */ + virtual int GetLight(int *piData) = 0; +}; + +#endif /* __LIGHT_SENSOR_CLASS_H */ \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_api.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,982 @@ +/******************************************************************************* +Copyright © 2014, STMicroelectronics International N.V. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * 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. + * 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, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED. +IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. 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. +********************************************************************************/ +/* + * @file VL6180x_api.h + * $Date: 2015-03-24 14:15:14 +0100 (Tue, 24 Mar 2015) $ + * $Revision: 2213 $ + */ + + + +#ifndef VL6180x_API_H_ +#define VL6180x_API_H_ + +#include "vl6180x_def.h" +#include "vl6180x_platform.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** @defgroup api_ll API Low Level Functions + * @brief API Low level functions + */ + +/** @defgroup api_hl API High Level Functions + * @brief API High level functions + */ + + +/* + * Check and set default platform dependent configuration + */ +#ifndef VL6180x_SINGLE_DEVICE_DRIVER +#error "VL6180x_SINGLE_DEVICE_DRIVER not defined" +/* TODO you may remove or comment these #error but it is best you update your vl6180x_platform.h file to define it*/ +#endif + + +#ifndef VL6180x_RANGE_STATUS_ERRSTRING +#warning "VL6180x_RANGE_STATUS_ERRSTRING not defined ?" +/* TODO you may remove or comment these #warning and keep the default below to keep compatibility + or update your vl6180x_platform.h file */ +/** + * force VL6180x_RANGE_STATUS_ERRSTRING to not supported when not part of any cfg file + */ +#define VL6180x_RANGE_STATUS_ERRSTRING 0 +#endif + +#ifndef VL6180X_SAFE_POLLING_ENTER +#warning "VL6180X_SAFE_POLLING_ENTER not defined, likely old vl6180x_cfg.h file ?" +/* TODO you may remove or comment these #warning and keep the default below to keep compatibility + or update your vl6180x_platform.h file */ +/** + * force VL6180X_SAFE_POLLING_ENTER to off when not in cfg file + */ +#define VL6180X_SAFE_POLLING_ENTER 0 /* off by default as in api 2.0 */ +#endif + +#ifndef VL6180X_LOG_ENABLE +/** + * Force VL6180X_LOG_ENABLE to none as default + */ +#define VL6180X_LOG_ENABLE 0 +#endif + +#if VL6180x_RANGE_STATUS_ERRSTRING +/**@def VL6180x_HAVE_RANGE_STATUS_ERRSTRING + * @brief is defined when @a #VL6180x_RANGE_STATUS_ERRSTRING is enable + */ +#define VL6180x_HAVE_RANGE_STATUS_ERRSTRING +#endif + + +/** @brief Get API version as "hex integer" 0xMMnnss + */ +#define VL6180x_ApiRevInt ((VL6180x_API_REV_MAJOR<<24)+(VL6180x_API_REV_MINOR<<16)+VL6180x_API_REV_SUB) + +/** Get API version as string for exe "2.1.12" " + */ +#define VL6180x_ApiRevStr VL6180X_STR(VL6180x_API_REV_MAJOR) "." VL6180X_STR(VL6180x_API_REV_MINOR) "." VL6180X_STR(VL6180x_API_REV_SUB) + +/** @defgroup api_init Init functions + * @brief API init functions + * @ingroup api_hl + * @{ + */ +/** + * @brief Wait for device booted after chip enable (hardware standby) + * @par Function Description + * After Chip enable Application you can also simply wait at least 1ms to ensure device is ready + * @warning After device chip enable (gpio0) de-asserted user must wait gpio1 to get asserted (hardware standby). + * or wait at least 400usec prior to do any low level access or api call . + * + * This function implements polling for standby but you must ensure 400usec from chip enable passed\n + * @warning if device get prepared @a VL6180x_Prepare() re-using these function can hold indefinitely\n + * + * @param dev The device + * @return 0 on success + */ +int VL6180x_WaitDeviceBooted(VL6180xDev_t dev); + +/** + * + * @brief One time device initialization + * + * To be called once and only once after device is brought out of reset (Chip enable) and booted see @a VL6180x_WaitDeviceBooted() + * + * @par Function Description + * When not used after a fresh device "power up" or reset, it may return @a #CALIBRATION_WARNING + * meaning wrong calibration data may have been fetched from device that can result in ranging offset error\n + * If application cannot execute device reset or need to run VL6180x_InitData multiple time + * then it must ensure proper offset calibration saving and restore on its own + * by using @a VL6180x_GetOffsetCalibrationData() on first power up and then @a VL6180x_SetOffsetCalibrationData() all all subsequent init + * + * @param dev The device + * @return 0 on success, @a #CALIBRATION_WARNING if failed + */ +int VL6180x_InitData(VL6180xDev_t dev ); + +/** + * @brief Configure GPIO1 function and set polarity. + * @par Function Description + * To be used prior to arm single shot measure or start continuous mode. + * + * The function uses @a VL6180x_SetupGPIOx() for setting gpio 1. + * @warning changing polarity can generate a spurious interrupt on pins. + * It sets an interrupt flags condition that must be cleared to avoid polling hangs. \n + * It is safe to run VL6180x_ClearAllInterrupt() just after. + * + * @param dev The device + * @param IntFunction The interrupt functionality to use one of :\n + * @a #GPIOx_SELECT_OFF \n + * @a #GPIOx_SELECT_GPIO_INTERRUPT_OUTPUT + * @param ActiveHigh The interrupt line polarity see ::IntrPol_e + * use @a #INTR_POL_LOW (falling edge) or @a #INTR_POL_HIGH (rising edge) + * @return 0 on success + */ +int VL6180x_SetupGPIO1(VL6180xDev_t dev, uint8_t IntFunction, int ActiveHigh); + + /** + * @brief Prepare device for operation + * @par Function Description + * Does static initialization and reprogram common default settings \n + * Device is prepared for new measure, ready single shot ranging or ALS typical polling operation\n + * After prepare user can : \n + * @li Call other API function to set other settings\n + * @li Configure the interrupt pins, etc... \n + * @li Then start ranging or ALS operations in single shot or continuous mode + * + * @param dev The device + * @return 0 on success + */ + int VL6180x_Prepare(VL6180xDev_t dev); + + /** @} */ + + +/** @defgroup api_hl_range Ranging functions + * @brief Ranging functions + * @ingroup api_hl + * @{ + */ + + /** + * @brief Start continuous ranging mode + * + * @details End user should ensure device is in idle state and not already running + */ +int VL6180x_RangeStartContinuousMode(VL6180xDev_t dev); + +/** + * @brief Start single shot ranging measure + * + * @details End user should ensure device is in idle state and not already running + */ +int VL6180x_RangeStartSingleShot(VL6180xDev_t dev); + +/** + * @brief Set maximum convergence time + * + * @par Function Description + * Setting a low convergence time can impact maximal detectable distance. + * Refer to VL6180x Datasheet Table 7 : Typical range convergence time. + * A typical value for up to x3 scaling is 50 ms + * + * @param dev + * @param MaxConTime_msec + * @return 0 on success. <0 on error. >0 for calibration warning status + */ +int VL6180x_RangeSetMaxConvergenceTime(VL6180xDev_t dev, uint8_t MaxConTime_msec); + +/** + * @brief Single shot Range measurement in polling mode. + * + * @par Function Description + * Kick off a new single shot range then wait for ready to retrieve it by polling interrupt status \n + * Ranging must be prepared by a first call to @a VL6180x_Prepare() and it is safer to clear very first poll call \n + * This function reference VL6180x_PollDelay(dev) porting macro/call on each polling loop, + * but PollDelay(dev) may never be called if measure in ready on first poll loop \n + * Should not be use in continuous mode operation as it will stop it and cause stop/start misbehaviour \n + * \n This function clears Range Interrupt status , but not error one. For that uses @a VL6180x_ClearErrorInterrupt() \n + * This range error is not related VL6180x_RangeData_t::errorStatus that refer measure status \n + * + * @param dev The device + * @param pRangeData Will be populated with the result ranging data @a VL6180x_RangeData_t + * @return 0 on success , @a #RANGE_ERROR if device reports an error case in it status (not cleared) use + * + * \sa ::VL6180x_RangeData_t + */ +int VL6180x_RangePollMeasurement(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData); + +/** + * @brief Check for measure readiness and get it if ready + * + * @par Function Description + * Using this function is an alternative to @a VL6180x_RangePollMeasurement() to avoid polling operation. This is suitable for applications + * where host CPU is triggered on a interrupt (not from VL6180X) to perform ranging operation. In this scenario, we assume that the very first ranging + * operation is triggered by a call to @a VL6180x_RangeStartSingleShot(). Then, host CPU regularly calls @a VL6180x_RangeGetMeasurementIfReady() to + * get a distance measure if ready. In case the distance is not ready, host may get it at the next call.\n + * + * @warning + * This function does not re-start a new measurement : this is up to the host CPU to do it.\n + * This function clears Range Interrupt for measure ready , but not error interrupts. For that, uses @a VL6180x_ClearErrorInterrupt() \n + * + * @param dev The device + * @param pRangeData Will be populated with the result ranging data if available + * @return 0 when measure is ready pRange data is updated (untouched when not ready), >0 for warning and @a #NOT_READY if measurement not yet ready, <0 for error @a #RANGE_ERROR if device report an error, + */ +int VL6180x_RangeGetMeasurementIfReady(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData); + +/** + * @brief Retrieve range measurements set from device + * + * @par Function Description + * The measurement is made of range_mm status and error code @a VL6180x_RangeData_t \n + * Based on configuration selected extra measures are included. + * + * @warning should not be used in continuous if wrap around filter is active \n + * Does not perform any wait nor check for result availability or validity. + *\sa VL6180x_RangeGetResult for "range only" measurement + * + * @param dev The device + * @param pRangeData Pointer to the data structure to fill up + * @return 0 on success + */ +int VL6180x_RangeGetMeasurement(VL6180xDev_t dev, VL6180x_RangeData_t *pRangeData); + +/** + * @brief Get ranging result and only that + * + * @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 + * @warning these function is not doing wrap around filtering \n + * This function doesn't perform any data ready check! + * + * @param dev The device + * @param pRange_mm Pointer to range distance + * @return 0 on success + */ +int VL6180x_RangeGetResult(VL6180xDev_t dev, int32_t *pRange_mm); + +/** + * @brief Configure ranging interrupt reported to application + * + * @param dev The device + * @param ConfigGpioInt Select ranging report\n select one (and only one) of:\n + * @a #CONFIG_GPIO_INTERRUPT_DISABLED \n + * @a #CONFIG_GPIO_INTERRUPT_LEVEL_LOW \n + * @a #CONFIG_GPIO_INTERRUPT_LEVEL_HIGH \n + * @a #CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW \n + * @a #CONFIG_GPIO_INTERRUPT_NEW_SAMPLE_READY + * @return 0 on success + */ +int VL6180x_RangeConfigInterrupt(VL6180xDev_t dev, uint8_t ConfigGpioInt); + + +/** + * @brief Clear range interrupt + * + * @param dev The device + * @return 0 On success + */ +#define VL6180x_RangeClearInterrupt(dev) VL6180x_ClearInterrupt(dev, INTERRUPT_CLEAR_RANGING) + +/** + * @brief Return ranging error interrupt status + * + * @par Function Description + * Appropriate Interrupt report must have been selected first by @a VL6180x_RangeConfigInterrupt() or @a VL6180x_Prepare() \n + * + * Can be used in polling loop to wait for a given ranging event or in interrupt to read the trigger \n + * Events triggers are : \n + * @a #RES_INT_STAT_GPIO_LOW_LEVEL_THRESHOLD \n + * @a #RES_INT_STAT_GPIO_HIGH_LEVEL_THRESHOLD \n + * @a #RES_INT_STAT_GPIO_OUT_OF_WINDOW \n (RES_INT_STAT_GPIO_LOW_LEVEL_THRESHOLD|RES_INT_STAT_GPIO_HIGH_LEVEL_THRESHOLD) + * @a #RES_INT_STAT_GPIO_NEW_SAMPLE_READY \n + * + * @sa IntrStatus_t + * @param dev The device + * @param pIntStatus Pointer to status variable to update + * @return 0 on success + */ +int VL6180x_RangeGetInterruptStatus(VL6180xDev_t dev, uint8_t *pIntStatus); + +#if VL6180x_RANGE_STATUS_ERRSTRING + +extern const char * ROMABLE_DATA VL6180x_RangeStatusErrString[]; +/** + * @brief Human readable error string for range error status + * + * @param RangeErrCode The error code as stored on @a VL6180x_RangeData_t::errorStatus + * @return error string , NULL for invalid RangeErrCode + * @sa ::RangeError_u + */ +const char * VL6180x_RangeGetStatusErrString(uint8_t RangeErrCode); +#else +#define VL6180x_RangeGetStatusErrString(...) NULL +#endif + +/** @} */ + +#if VL6180x_ALS_SUPPORT + +/** @defgroup api_hl_als ALS functions + * @brief ALS functions + * @ingroup api_hl + * @{ + */ + +/** + * @brief Run a single ALS measurement in single shot polling mode + * + * @par Function Description + * Kick off a new single shot ALS then wait new measurement ready to retrieve it ( polling system interrupt status register for als) \n + * ALS must be prepared by a first call to @a VL6180x_Prepare() \n + * \n Should not be used in continuous or interrupt mode it will break it and create hazard in start/stop \n + * + * @param dev The device + * @param pAlsData Als data structure to fill up @a VL6180x_AlsData_t + * @return 0 on success + */ +int VL6180x_AlsPollMeasurement(VL6180xDev_t dev, VL6180x_AlsData_t *pAlsData); + + +/** + * @brief Get actual ALS measurement + * + * @par Function Description + * Can be called after success status polling or in interrupt mode to retrieve ALS measurement from device \n + * This function doesn't perform any data ready check ! + * + * @param dev The device + * @param pAlsData Pointer to measurement struct @a VL6180x_AlsData_t + * @return 0 on success + */ +int VL6180x_AlsGetMeasurement(VL6180xDev_t dev, VL6180x_AlsData_t *pAlsData); + +/** + * @brief Configure ALS interrupts provide to application + * + * @param dev The Device + * @param ConfigGpioInt Select one (and only one) of : \n + * @a #CONFIG_GPIO_INTERRUPT_DISABLED \n + * @a #CONFIG_GPIO_INTERRUPT_LEVEL_LOW \n + * @a #CONFIG_GPIO_INTERRUPT_LEVEL_HIGH \n + * @a #CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW \n + * @a #CONFIG_GPIO_INTERRUPT_NEW_SAMPLE_READY + * @return 0 on success may return #INVALID_PARAMS for invalid mode + */ +int VL6180x_AlsConfigInterrupt(VL6180xDev_t dev, uint8_t ConfigGpioInt); + + +/** + * @brief Set ALS integration period + * + * @param dev The device + * @param period_ms Integration period in msec. Value in between 50 to 100 msec is recommended\n + * @return 0 on success + */ +int VL6180x_AlsSetIntegrationPeriod(VL6180xDev_t dev, uint16_t period_ms); + +/** + * @brief Set ALS "inter-measurement period" + * + * @par Function Description + * The so call data-sheet "inter measurement period" is actually an extra inter-measurement delay + * + * @param dev The device + * @param intermeasurement_period_ms Inter measurement time in milli second\n + * @warning applied value is clipped to 2550 ms\n + * @return 0 on success if value is + */ +int VL6180x_AlsSetInterMeasurementPeriod(VL6180xDev_t dev, uint16_t intermeasurement_period_ms); + +/** + * @brief Set ALS analog gain code + * + * @par Function Description + * ALS gain code value programmed in @a SYSALS_ANALOGUE_GAIN . + * @param dev The device + * @param gain Gain code see datasheet or AlsGainLookUp for real value. Value is clipped to 7. + * @return 0 on success + */ + +int VL6180x_AlsSetAnalogueGain(VL6180xDev_t dev, uint8_t gain); +/** + * @brief Set thresholds for ALS continuous mode + * @warning Threshold are raw device value not lux! + * + * @par Function Description + * Basically value programmed in @a SYSALS_THRESH_LOW and @a SYSALS_THRESH_HIGH registers + * @param dev The device + * @param low ALS low raw threshold for @a SYSALS_THRESH_LOW + * @param high ALS high raw threshold for @a SYSALS_THRESH_HIGH + * @return 0 on success + */ +int VL6180x_AlsSetThresholds(VL6180xDev_t dev, uint8_t low, uint8_t high); + +/** + * @brief Clear ALS interrupt + * + * @param dev The device + * @return 0 On success + */ + #define VL6180x_AlsClearInterrupt(dev) VL6180x_ClearInterrupt(dev, INTERRUPT_CLEAR_ALS) + +/** + * Read ALS interrupt status + * @param dev Device + * @param pIntStatus Pointer to status + * @return 0 on success + */ +int VL6180x_AlsGetInterruptStatus(VL6180xDev_t dev, uint8_t *pIntStatus); + +/** @} */ +#endif + +/** @defgroup api_ll_init Init functions + * @brief Init functions + * @ingroup api_ll + * @{ + */ + +/** + * @brief Low level ranging and ALS register static settings (you should call @a VL6180x_Prepare() function instead) + * + * @param dev + * @return 0 on success + */ +int VL6180x_StaticInit(VL6180xDev_t dev); + + /** @} */ + +/** @defgroup api_ll_range Ranging functions + * @brief Ranging Low Level functions + * @ingroup api_ll + * @{ + */ + +/** + * @brief Wait for device to be ready (before a new ranging command can be issued by application) + * @param dev The device + * @param MaxLoop Max Number of i2c polling loop see @a #msec_2_i2cloop + * @return 0 on success. <0 when fail \n + * @ref VL6180x_ErrCode_t::TIME_OUT for time out \n + * @ref VL6180x_ErrCode_t::INVALID_PARAMS if MaxLop<1 + */ +int VL6180x_RangeWaitDeviceReady(VL6180xDev_t dev, int MaxLoop ); + +/** + * @brief Program Inter measurement period (used only in continuous mode) + * + * @par Function Description + * When trying to set too long time, it returns #INVALID_PARAMS + * + * @param dev The device + * @param InterMeasTime_msec Requires inter-measurement time in msec + * @return 0 on success + */ +int VL6180x_RangeSetInterMeasPeriod(VL6180xDev_t dev, uint32_t InterMeasTime_msec); + + +/** + * @brief Set device ranging scaling factor + * + * @par Function Description + * The ranging scaling factor is applied on the raw distance measured by the device to increase operating ranging at the price of the precision. + * Changing the scaling factor when device is not in f/w standby state (free running) is not safe. + * It can be source of spurious interrupt, wrongly scaled range etc ... + * @warning __This function doesns't update high/low threshold and other programmed settings linked to scaling factor__. + * To ensure proper operation, threshold and scaling changes should be done following this procedure: \n + * @li Set Group hold : @a VL6180x_SetGroupParamHold() \n + * @li Get Threshold @a VL6180x_RangeGetThresholds() \n + * @li Change scaling : @a VL6180x_UpscaleSetScaling() \n + * @li Set Threshold : @a VL6180x_RangeSetThresholds() \n + * @li Unset Group Hold : @a VL6180x_SetGroupParamHold() + * + * @param dev The device + * @param scaling Scaling factor to apply (1,2 or 3) + * @return 0 on success when up-scale support is not configured it fail for any + * scaling than the one statically configured. + */ +int VL6180x_UpscaleSetScaling(VL6180xDev_t dev, uint8_t scaling); + +/** + * @brief Get current ranging scaling factor + * + * @param dev The device + * @return The current scaling factor + */ +int VL6180x_UpscaleGetScaling(VL6180xDev_t dev); + + +/** + * @brief Give filtered state (wrap-around filter) of a range measurement + * @param pRangeData Range measurement data + * @return 0 means measure was not filtered, when not 0 range from device got filtered by filter post processing + */ +#define VL6180x_RangeIsFilteredMeasurement(pRangeData) ((pRangeData)->errorStatus == RangingFiltered) + +/** + * @brief Get the maximal distance for actual scaling + * @par Function Description + * Do not use prior to @a VL6180x_Prepare() or at least @a VL6180x_InitData() + * + * Any range value more than the value returned by this function is to be considered as "no target detected" + * or "no target in detectable range" \n + * @warning The maximal distance depends on the scaling + * + * @param dev The device + * @return The maximal range limit for actual mode and scaling + */ +uint16_t VL6180x_GetUpperLimit(VL6180xDev_t dev); + +/** + * @brief Apply low and high ranging thresholds that are considered only in continuous mode + * + * @par Function Description + * This function programs low and high ranging thresholds that are considered in continuous mode : + * interrupt will be raised only when an object is detected at a distance inside this [low:high] range. + * The function takes care of applying current scaling factor if any.\n + * To be safe, in continuous operation, thresholds must be changed under "group parameter hold" cover. + * Group hold can be activated/deactivated directly in the function or externally (then set 0) + * using /a VL6180x_SetGroupParamHold() function. + * + * @param dev The device + * @param low Low threshold in mm + * @param high High threshold in mm + * @param SafeHold Use of group parameters hold to surround threshold programming. + * @return 0 On success + */ +int VL6180x_RangeSetThresholds(VL6180xDev_t dev, uint16_t low, uint16_t high, int SafeHold); + +/** + * @brief Get scaled high and low threshold from device + * + * @par Function Description + * Due to scaling factor, the returned value may be different from what has been programmed first (precision lost). + * For instance VL6180x_RangeSetThresholds(dev,11,22) with scale 3 + * will read back 9 ((11/3)x3) and 21 ((22/3)x3). + + * @param dev The device + * @param low scaled low Threshold ptr can be NULL if not needed + * @param high scaled High Threshold ptr can be NULL if not needed + * @return 0 on success, return value is undefined if both low and high are NULL + * @warning return value is undefined if both low and high are NULL + */ +int VL6180x_RangeGetThresholds(VL6180xDev_t dev, uint16_t *low, uint16_t *high); + +/** + * @brief Set ranging raw thresholds (scaling not considered so not recommended to use it) + * + * @param dev The device + * @param low raw low threshold set to raw register + * @param high raw high threshold set to raw register + * @return 0 on success + */ +int VL6180x_RangeSetRawThresholds(VL6180xDev_t dev, uint8_t low, uint8_t high); + +/** + * @brief Set Early Convergence Estimate ratio + * @par Function Description + * For more information on ECE check datasheet + * @warning May return a calibration warning in some use cases + * + * @param dev The device + * @param FactorM ECE factor M in M/D + * @param FactorD ECE factor D in M/D + * @return 0 on success. <0 on error. >0 on warning + */ +int VL6180x_RangeSetEceFactor(VL6180xDev_t dev, uint16_t FactorM, uint16_t FactorD); + +/** + * @brief Set Early Convergence Estimate state (See #SYSRANGE_RANGE_CHECK_ENABLES register) + * @param dev The device + * @param enable State to be set 0=disabled, otherwise enabled + * @return 0 on success + */ +int VL6180x_RangeSetEceState(VL6180xDev_t dev, int enable ); + +/** + * @brief Set activation state of the wrap around filter + * @param dev The device + * @param state New activation state (0=off, otherwise on) + * @return 0 on success + */ +int VL6180x_FilterSetState(VL6180xDev_t dev, int state); + +/** + * Get activation state of the wrap around filter + * @param dev The device + * @return Filter enabled or not, when filter is not supported it always returns 0S + */ +int VL6180x_FilterGetState(VL6180xDev_t dev); + + +/** + * @brief Set activation state of DMax computation + * @param dev The device + * @param state New activation state (0=off, otherwise on) + * @return 0 on success + */ +int VL6180x_DMaxSetState(VL6180xDev_t dev, int state); + +/** + * Get activation state of DMax computation + * @param dev The device + * @return Filter enabled or not, when filter is not supported it always returns 0S + */ +int VL6180x_DMaxGetState(VL6180xDev_t dev); + + +/** + * @brief Set ranging mode and start/stop measure (use high level functions instead : @a VL6180x_RangeStartSingleShot() or @a VL6180x_RangeStartContinuousMode()) + * + * @par Function Description + * When used outside scope of known polling single shot stopped state, \n + * user must ensure the device state is "idle" before to issue a new command. + * + * @param dev The device + * @param mode A combination of working mode (#MODE_SINGLESHOT or #MODE_CONTINUOUS) and start/stop condition (#MODE_START_STOP) \n + * @return 0 on success + */ +int VL6180x_RangeSetSystemMode(VL6180xDev_t dev, uint8_t mode); + +/** @} */ + +/** @defgroup api_ll_range_calibration Ranging calibration functions + * @brief Ranging calibration functions + * @ingroup api_ll + * @{ + */ +/** + * @brief Get part to part calibration offset + * + * @par Function Description + * Should only be used after a successful call to @a VL6180x_InitData to backup device nvm value + * + * @param dev The device + * @return part to part calibration offset from device + */ +int8_t VL6180x_GetOffsetCalibrationData(VL6180xDev_t dev); + +/** + * Set or over-write part to part calibration offset + * \sa VL6180x_InitData(), VL6180x_GetOffsetCalibrationData() + * @param dev The device + * @param offset Offset + */ +void VL6180x_SetOffsetCalibrationData(VL6180xDev_t dev, int8_t offset); + +/** + * @brief Set Cross talk compensation rate + * + * @par Function Description + * It programs register @a #SYSRANGE_CROSSTALK_COMPENSATION_RATE + * + * @param dev The device + * @param Rate Compensation rate (9.7 fix point) see datasheet for details + * @return 0 on success + */ +int VL6180x_SetXTalkCompensationRate(VL6180xDev_t dev, FixPoint97_t Rate); + +/** @} */ + + + +#if VL6180x_ALS_SUPPORT +/** @defgroup api_ll_als ALS functions + * @brief ALS functions + * @ingroup api_ll + * @{ + */ + +/** + * @brief Wait for device to be ready for new als operation or max pollign loop (time out) + * @param dev The device + * @param MaxLoop Max Number of i2c polling loop see @a #msec_2_i2cloop + * @return 0 on success. <0 when @a VL6180x_ErrCode_t::TIME_OUT if timed out + */ +int VL6180x_AlsWaitDeviceReady(VL6180xDev_t dev, int MaxLoop ); + +/** + * @brief Set ALS system mode and start/stop measure + * + * @warning When used outside after single shot polling, \n + * User must ensure the device state is ready before issuing a new command (using @a VL6180x_AlsWaitDeviceReady()). \n + * Non respect of this, can cause loss of interrupt or device hanging. + * + * @param dev The device + * @param mode A combination of working mode (#MODE_SINGLESHOT or #MODE_CONTINUOUS) and start condition (#MODE_START_STOP) \n + * @return 0 on success + */ +int VL6180x_AlsSetSystemMode(VL6180xDev_t dev, uint8_t mode); + +/** @} */ +#endif + +/** @defgroup api_ll_misc Misc functions + * @brief Misc functions + * @ingroup api_ll + * @{ + */ + +/** + * Set Group parameter Hold state + * + * @par Function Description + * Group parameter holds @a #SYSTEM_GROUPED_PARAMETER_HOLD enable safe update (non atomic across multiple measure) by host + * \n The critical register group is composed of: \n + * #SYSTEM_INTERRUPT_CONFIG_GPIO \n + * #SYSRANGE_THRESH_HIGH \n + * #SYSRANGE_THRESH_LOW \n + * #SYSALS_INTEGRATION_PERIOD \n + * #SYSALS_ANALOGUE_GAIN \n + * #SYSALS_THRESH_HIGH \n + * #SYSALS_THRESH_LOW + * + * + * @param dev The device + * @param Hold Group parameter Hold state to be set (on/off) + * @return 0 on success + */ +int VL6180x_SetGroupParamHold(VL6180xDev_t dev, int Hold); + +/** + * @brief Set new device i2c address + * + * After completion the device will answer to the new address programmed. + * + * @sa AN4478: Using multiple VL6180X's in a single design + * @param dev The device + * @param NewAddr The new i2c address (7bit) + * @return 0 on success + */ +int VL6180x_SetI2CAddress(VL6180xDev_t dev, uint8_t NewAddr); + +/** + * @brief Fully configure gpio 0/1 pin : polarity and functionality + * + * @param dev The device + * @param pin gpio pin 0 or 1 + * @param IntFunction Pin functionality : either #GPIOx_SELECT_OFF or #GPIOx_SELECT_GPIO_INTERRUPT_OUTPUT (refer to #SYSTEM_MODE_GPIO1 register definition) + * @param ActiveHigh Set active high polarity, or active low see @a ::IntrPol_e + * @return 0 on success + */ +int VL6180x_SetupGPIOx(VL6180xDev_t dev, int pin, uint8_t IntFunction, int ActiveHigh); + + +/** + * @brief Set interrupt pin polarity for the given GPIO + * + * @param dev The device + * @param pin Pin 0 or 1 + * @param active_high select active high or low polarity using @ref IntrPol_e + * @return 0 on success + */ +int VL6180x_SetGPIOxPolarity(VL6180xDev_t dev, int pin, int active_high); + +/** + * Select interrupt functionality for the given GPIO + * + * @par Function Description + * Functionality refer to @a SYSTEM_MODE_GPIO0 + * + * @param dev The device + * @param pin Pin to configure 0 or 1 (gpio0 or gpio1)\nNote that gpio0 is chip enable at power up ! + * @param functionality Pin functionality : either #GPIOx_SELECT_OFF or #GPIOx_SELECT_GPIO_INTERRUPT_OUTPUT (refer to #SYSTEM_MODE_GPIO1 register definition) + * @return 0 on success + */ +int VL6180x_SetGPIOxFunctionality(VL6180xDev_t dev, int pin, uint8_t functionality); + +/** + * #brief Disable and turn to Hi-Z gpio output pin + * + * @param dev The device + * @param pin The pin number to disable 0 or 1 + * @return 0 on success + */ +int VL6180x_DisableGPIOxOut(VL6180xDev_t dev, int pin); + +/** + * @def msec_2_i2cloop + * @brief Number of I2C polling loop (an 8 bit register) to run for maximal wait time. + * + * @par Function Description + * When polling via I2C the overall time is mainly the I2C transaction time because it is a slow bus + * one 8 bit register poll on I2C bus timing is shown below: \n + * start + addr_w(a) + 2x8bit index(a) + stop + start + addr_rd(a) + 1x8bit data_rd(a) + stop \n + * 1 8 1 2*(8+1) 1 1 8 1 8 1 1 \n + * so 49 serial bits + * + * @param time_ms Time to wait in milli second 10 + * @param i2c_khz I2C bus frequencies in KHz for instance 400 + * @return The number of loops (at least 1) + */ +#define msec_2_i2cloop( time_ms, i2c_khz ) (((time_ms)*(i2c_khz)/49)+1) + +/** @} */ + + + +/** + * polarity use in @a VL6180x_SetupGPIOx() , @a VL6180x_SetupGPIO1() + */ +typedef enum { + INTR_POL_LOW =0, /*!< set active low polarity best setup for falling edge */ + INTR_POL_HIGH =1, /*!< set active high polarity best setup for rising edge */ +}IntrPol_e; + +/** @defgroup api_ll_intr Interrupts management functions + * @brief Interrupts management functions + * @ingroup api_ll + * @{ + */ + +/** + * @brief Get all interrupts cause + * + * @param dev The device + * @param status Ptr to interrupt status. You can use @a IntrStatus_t::val + * @return 0 on success + */ +int VL6180x_GetInterruptStatus(VL6180xDev_t dev, uint8_t *status); + +/** + * @brief Clear given system interrupt condition + * + * @par Function Description + * Clear given interrupt cause by writing into register #SYSTEM_INTERRUPT_CLEAR register. + * @param dev The device + * @param IntClear Which interrupt source to clear. Use any combinations of #INTERRUPT_CLEAR_RANGING , #INTERRUPT_CLEAR_ALS , #INTERRUPT_CLEAR_ERROR. + * @return 0 On success + */ +int VL6180x_ClearInterrupt(VL6180xDev_t dev, uint8_t IntClear ); + +/** + * @brief Clear error interrupt + * + * @param dev The device + * @return 0 On success + */ + #define VL6180x_ClearErrorInterrupt(dev) VL6180x_ClearInterrupt(dev, INTERRUPT_CLEAR_ERROR) + +/** + * @brief Clear All interrupt causes (als+range+error) + * + * @param dev The device + * @return 0 On success + */ +#define VL6180x_ClearAllInterrupt(dev) VL6180x_ClearInterrupt(dev, INTERRUPT_CLEAR_ERROR|INTERRUPT_CLEAR_RANGING|INTERRUPT_CLEAR_ALS) + +/** @} */ + + +/** @defgroup api_reg API Register access functions + * @brief Registers access functions called by API core functions + * @ingroup api_ll + * @{ + */ + +/** + * Write VL6180x single byte register + * @param dev The device + * @param index The register index + * @param data 8 bit register data + * @return success + */ +int VL6180x_WrByte(VL6180xDev_t dev, uint16_t index, uint8_t data); +/** + * Thread safe VL6180x Update (rd/modify/write) single byte register + * + * Final_reg = (Initial_reg & and_data) |or_data + * + * @param dev The device + * @param index The register index + * @param AndData 8 bit and data + * @param OrData 8 bit or data + * @return 0 on success + */ +int VL6180x_UpdateByte(VL6180xDev_t dev, uint16_t index, uint8_t AndData, uint8_t OrData); +/** + * Write VL6180x word register + * @param dev The device + * @param index The register index + * @param data 16 bit register data + * @return 0 on success + */ +int VL6180x_WrWord(VL6180xDev_t dev, uint16_t index, uint16_t data); +/** + * Write VL6180x double word (4 byte) register + * @param dev The device + * @param index The register index + * @param data 32 bit register data + * @return 0 on success + */ +int VL6180x_WrDWord(VL6180xDev_t dev, uint16_t index, uint32_t data); + +/** + * Read VL6180x single byte register + * @param dev The device + * @param index The register index + * @param data pointer to 8 bit data + * @return 0 on success + */ +int VL6180x_RdByte(VL6180xDev_t dev, uint16_t index, uint8_t *data); + +/** + * Read VL6180x word (2byte) register + * @param dev The device + * @param index The register index + * @param data pointer to 16 bit data + * @return 0 on success + */ +int VL6180x_RdWord(VL6180xDev_t dev, uint16_t index, uint16_t *data); + +/** + * Read VL6180x dword (4byte) register + * @param dev The device + * @param index The register index + * @param data pointer to 32 bit data + * @return 0 on success + */ +int VL6180x_RdDWord(VL6180xDev_t dev, uint16_t index, uint32_t *data); + +/** @} */ + + + + +#ifdef __cplusplus +} +#endif + +#endif /* VL6180x_API_H_ */
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_appcfg.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,92 @@ + +/******************************************************************************* +Copyright © 2014, STMicroelectronics International N.V. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * 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. + * 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, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED. +IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. 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. +********************************************************************************/ + + +/* + * vl6180x_appcfg.h + * + */ + +#ifndef VL6180X_APPCFG_H_ +#define VL6180X_APPCFG_H_ + + +/** + * @def VL6180x_SINGLE_DEVICE_DRIVER + * @brief enable lightweight single vl6180x device driver + * + * value 1 => single device capable + * Configure optimized APi for single device driver with static data and minimal use of ref pointer \n + * limited to single device driver or application in non multi thread/core environment \n + * + * value 0 => multiple device capable user must review "device" structure and type in porting files + * @ingroup Configuration + */ +#define VL6180x_SINGLE_DEVICE_DRIVER 1 + + +/** + * @def VL6180x_RANGE_STATUS_ERRSTRING + * @brief when define include range status Error string and related + * + * The string table lookup require some space in read only area + * @ingroup Configuration + */ +#define VL6180x_RANGE_STATUS_ERRSTRING 1 + +/** + * @def VL6180X_SAFE_POLLING_ENTER + * + * @brief Ensure safe polling method when set + * + * Polling for a condition can be hazardous and result in infinite looping if any previous interrupt status + * condition is not cleared. \n + * Setting these flags enforce error clearing on start of polling method to avoid it. + * the drawback are : \n + * @li extra use-less i2c bus usage and traffic + * @li potentially slower measure rate. + * If application ensure interrupt get clear on mode or interrupt configuration change + * then keep option disabled. \n + * To be safe set these option to 1 + * @ingroup Configuration + */ +#define VL6180X_SAFE_POLLING_ENTER 0 + + +/** + * @brief Enable function start/end logging + * + * requires porting @a #LOG_FUNCTION_START @a #LOG_FUNCTION_END @a #LOG_FUNCTION_END_FMT + * @ingroup Configuration + */ +#define VL6180X_LOG_ENABLE 0 + + + +#endif /* VL6180X_APPCFG_H_ */
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_cfg.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,119 @@ +/******************************************************************************* +Copyright © 2014, STMicroelectronics International N.V. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * 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. + * 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, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED. +IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. 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. +********************************************************************************/ +/* + * $Date: 2015-01-08 14:35:34 +0100 (Thu, 08 Jan 2015) $ + * $Revision: 2042 $ + */ + +/** + * @file VL6180x_cfg.h + * + * Proximity and ALS configuration + */ + +#ifndef VL6180x_CFG_H_ +#define VL6180x_CFG_H_ + +/** @defgroup api_config Configuration + * @brief API static configuration + */ + + + +/** @ingroup api_config + * @{*/ + + +/** + * @def VL6180x_UPSCALE_SUPPORT + * @brief Configure up-scale capabilities and default up-scale factor for ranging operations + * + * @li 1 : Fixed scaling by 1 (no up-scaling support) + * @li 2 : Fixed scaling by 2 + * @li 3 : Fixed scaling by 3 + * @li -1 -2 -3 : Run time programmable through @a VL6180x_UpscaleSetScaling(). Default scaling factore is -VL6180x_UPSCALE_SUPPORT \n + */ +#define VL6180x_UPSCALE_SUPPORT -1 + +/** + * @def VL6180x_ALS_SUPPORT + * @brief Enable ALS support + * + * Set to 0 if ALS is not used in application. This can help reducing code size if it is a concern. + */ +#define VL6180x_ALS_SUPPORT 1 + +/** + * @def VL6180x_HAVE_DMAX_RANGING + * @brief Enable DMax calculation for ranging applications. + * + * When set to 1, __Dmax__ is returned by API typically when @a VL6180x_RangePollMeasurement() high level + * function is called (this is returned in @a VL6180x_RangeData_t structure). + * __Dmax__ is an estimation of the maximum distance (in mm) the product can report a valid distance of a 17% target for + * the current ambient light conditions (__Dmax__ decreases when ambient light increases). __Dmax__ should be used only + * when the product is not able to return a valid distance (no object or object is too far from the ranging sensor). + * Typically, this is done by checking the __errorStatus__ field of the @a VL6180x_RangeData_t structure returned by + * the @a VL6180x_RangePollMeasurement() function. + * You may refer to ::RangeError_u to get full list of supported error codes. + * @warning Dmax is estimated for a 17% grey target. If the real target has a reflectance lower than 17%, report Dmax could be over-estimated + */ +#define VL6180x_HAVE_DMAX_RANGING 1 + +/** + * @def VL6180x_WRAP_AROUND_FILTER_SUPPORT + * @brief Enable wrap around filter (WAF) feature + * + * In specific conditions, when targeting a mirror or a very reflective metal, a __wrap around__ effect can occur internally to the + * ranging product which results in returning a wrong distance (under-estimated). Goal of the WAF is to detect this wrap arround effect + * and to filter it by returning a non-valid distance : __errorStatus__ set to 16 (see ::RangeError_u) + * @warning Wrap-around filter can not be used when device is running in continuous mode + * + * @li 0 : Filter is not supported, no filtering code is included in API + * @li 1 : Filter is supported and active by default + * @li -1 : Filter is supported but is not active by default @a VL6180x_FilterSetState() can turn it on and off at any time + */ +#define VL6180x_WRAP_AROUND_FILTER_SUPPORT 1 + +/** + * @def VL6180x_EXTENDED_RANGE + * @brief Enable extended ranging support + * + * Device that do not formally support extended ranging should only be used with a scaling factor of 1. + * Correct operation with scaling factor other than 1 (>200mm ) is not granted by ST. + */ +#define VL6180x_EXTENDED_RANGE 0 + + +#if (VL6180x_EXTENDED_RANGE) && (VL6180x_ALS_SUPPORT) +#warning "Als support should be OFF for extended range" +#endif + +#endif +/** @} */ // end of api_config + +/* VL6180x_CFG_H_ */
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_class.cpp Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,317 @@ +/** + ****************************************************************************** + * @file vl6180x_class.cpp + * @author AST / EST + * @version V0.0.1 + * @date 14-April-2015 + * @brief Implementation file for the HTS221 driver class + ****************************************************************************** + * @attention + * + * <h2><center>© 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. + * + ****************************************************************************** +*/ + +/* Includes ------------------------------------------------------------------*/ +#include "vl6180x_class.h" + + + +/** + * @brief Set HTS221 Initialization + * @param HTS221_Init the configuration setting for the HTS221 + * @retval HUM_TEMP_OK in case of success, an error code otherwise + */ +VL6180x_ErrCode_t VL6180X::VL6180X_Init(HUM_TEMP_InitTypeDef *HTS221_Init) +{ + uint8_t tmp = 0x00; + + /* Configure the low level interface ---------------------------------------*/ + if(HTS221_IO_Init() != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + if(HTS221_Power_On() != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + if(HTS221_Calibration() != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + if(HTS221_IO_Read(&tmp, HTS221_CTRL_REG1_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + /* Output Data Rate selection */ + tmp &= ~(HTS221_ODR_MASK); + tmp |= HTS221_Init->OutputDataRate; + + if(HTS221_IO_Write(&tmp, HTS221_CTRL_REG1_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + HTS221_IO_ITConfig(); + + return HUM_TEMP_OK; +} + +/** + * @brief Read ID address of HTS221 + * @param ht_id the pointer where the ID of the device is stored + * @retval HUM_TEMP_OK in case of success, an error code otherwise + */ +HUM_TEMP_StatusTypeDef HTS221::HTS221_ReadID(uint8_t *ht_id) +{ + if(!ht_id) + { + return HUM_TEMP_ERROR; + } + + return HTS221_IO_Read(ht_id, HTS221_WHO_AM_I_ADDR, 1); +} + +/** + * @brief Reboot memory content of HTS221 + * @retval HUM_TEMP_OK in case of success, an error code otherwise + */ +HUM_TEMP_StatusTypeDef HTS221::HTS221_RebootCmd(void) +{ + uint8_t tmpreg; + + /* Read CTRL_REG2 register */ + if(HTS221_IO_Read(&tmpreg, HTS221_CTRL_REG2_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + /* Enable or Disable the reboot memory */ + tmpreg |= HTS221_BOOT_REBOOTMEMORY; + + /* Write value to MEMS CTRL_REG2 regsister */ + if(HTS221_IO_Write(&tmpreg, HTS221_CTRL_REG2_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + return HUM_TEMP_OK; +} + + +/** + * @brief Read HTS221 output register, and calculate the humidity + * @param pfData the pointer to data output + * @retval HUM_TEMP_OK in case of success, an error code otherwise + */ +HUM_TEMP_StatusTypeDef HTS221::HTS221_GetHumidity(float* pfData) +{ + int16_t H_T_out, humidity_t; + uint8_t tempReg[2] = {0, 0}; + uint8_t tmp = 0x00; + float H_rh; + + if(HTS221_IO_Read(&tmp, HTS221_CTRL_REG1_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + /* Output Data Rate selection */ + tmp &= (HTS221_ODR_MASK); + + if(tmp == 0x00) + { + if(HTS221_IO_Read(&tmp, HTS221_CTRL_REG2_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + /* Serial Interface Mode selection */ + tmp &= ~(HTS221_ONE_SHOT_MASK); + tmp |= HTS221_ONE_SHOT_START; + + if(HTS221_IO_Write(&tmp, HTS221_CTRL_REG2_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + do + { + + if(HTS221_IO_Read(&tmp, HTS221_STATUS_REG_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + } + while(!(tmp & 0x02)); + } + + + if(HTS221_IO_Read(&tempReg[0], (HTS221_HUMIDITY_OUT_L_ADDR | HTS221_I2C_MULTIPLEBYTE_CMD), + 2) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + H_T_out = ((((int16_t)tempReg[1]) << 8) + (int16_t)tempReg[0]); + + H_rh = ( float )(((( H_T_out - H0_T0_out ) * ( H1_rh - H0_rh )) / ( H1_T0_out - H0_T0_out )) + H0_rh ); + + // Truncate to specific number of decimal digits + humidity_t = (uint16_t)(H_rh * pow(10.0f, HUM_DECIMAL_DIGITS)); + *pfData = ((float)humidity_t) / pow(10.0f, HUM_DECIMAL_DIGITS); + + // Prevent data going below 0% and above 100% due to linear interpolation + if ( *pfData < 0.0f ) *pfData = 0.0f; + if ( *pfData > 100.0f ) *pfData = 100.0f; + + return HUM_TEMP_OK; +} + +/** + * @brief Read HTS221 output register, and calculate the temperature + * @param pfData the pointer to data output + * @retval HUM_TEMP_OK in case of success, an error code otherwise + */ +HUM_TEMP_StatusTypeDef HTS221::HTS221_GetTemperature(float* pfData) +{ + int16_t T_out, temperature_t; + uint8_t tempReg[2] = {0, 0}; + uint8_t tmp = 0x00; + float T_degC; + + if(HTS221_IO_Read(&tmp, HTS221_CTRL_REG1_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + /* Output Data Rate selection */ + tmp &= (HTS221_ODR_MASK); + + if(tmp == 0x00) + { + if(HTS221_IO_Read(&tmp, HTS221_CTRL_REG2_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + /* Serial Interface Mode selection */ + tmp &= ~(HTS221_ONE_SHOT_MASK); + tmp |= HTS221_ONE_SHOT_START; + + if(HTS221_IO_Write(&tmp, HTS221_CTRL_REG2_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + do + { + + if(HTS221_IO_Read(&tmp, HTS221_STATUS_REG_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + } + while(!(tmp & 0x01)); + } + + if(HTS221_IO_Read(&tempReg[0], (HTS221_TEMP_OUT_L_ADDR | HTS221_I2C_MULTIPLEBYTE_CMD), + 2) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + T_out = ((((int16_t)tempReg[1]) << 8) + (int16_t)tempReg[0]); + + T_degC = ((float)(T_out - T0_out)) / (T1_out - T0_out) * (T1_degC - T0_degC) + T0_degC; + + temperature_t = (int16_t)(T_degC * pow(10.0f, TEMP_DECIMAL_DIGITS)); + + *pfData = ((float)temperature_t) / pow(10.0f, TEMP_DECIMAL_DIGITS); + + return HUM_TEMP_OK; +} + + +/** + * @brief Exit the shutdown mode for HTS221 + * @retval HUM_TEMP_OK in case of success, an error code otherwise + */ +HUM_TEMP_StatusTypeDef HTS221::HTS221_Power_On(void) +{ + uint8_t tmpReg; + + /* Read the register content */ + if(HTS221_IO_Read(&tmpReg, HTS221_CTRL_REG1_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + /* Set the power down bit */ + tmpReg |= HTS221_MODE_ACTIVE; + + /* Write register */ + if(HTS221_IO_Write(&tmpReg, HTS221_CTRL_REG1_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + return HUM_TEMP_OK; +} + +/** + * @brief Enter the shutdown mode for HTS221 + * @retval HUM_TEMP_OK in case of success, an error code otherwise + */ +HUM_TEMP_StatusTypeDef HTS221::HTS221_Power_OFF(void) +{ + uint8_t tmpReg; + + /* Read the register content */ + if(HTS221_IO_Read(&tmpReg, HTS221_CTRL_REG1_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + /* Reset the power down bit */ + tmpReg &= ~(HTS221_MODE_ACTIVE); + + /* Write register */ + if(HTS221_IO_Write(&tmpReg, HTS221_CTRL_REG1_ADDR, 1) != HUM_TEMP_OK) + { + return HUM_TEMP_ERROR; + } + + return HUM_TEMP_OK; +} + +/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_class.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,125 @@ +/** + ****************************************************************************** + * @file vl6180x_class.h + * @author AST / EST + * @version V0.0.1 + * @date 14-April-2015 + * @brief Header file for component VL6180X + ****************************************************************************** + * @attention + * + * <h2><center>© 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. + * + ****************************************************************************** +*/ + +#ifndef __VL6180X_CLASS_H +#define __VL6180X_CLASS_H + +/* Includes ------------------------------------------------------------------*/ +#include "RangeSensor.h" +#include "LightSensor.h" +#include "vl6180x_api.h" +#include "vl6180x_cfg.h" +#include "vl6180x_def.h" +#include "vl6180x_i2c.h" +#include "vl6180x_types.h" +#include "vl6180x_platform.h" +#include "vl6180x_appcfg.h" + +/* Classes -------------------------------------------------------------------*/ +/** Class representing a VL6180X sensor component + */ +class VL6180X : public RangeSensor, public LightSensor { + public: + /** Constructor + * @param[in] i2c device I2C to be used for communication + */ + VL6180X(DevI2C &i2c) : RangeSensor(), LightSensor(), dev_i2c(i2c) {} + + /** Destructor + */ + virtual ~VL6180X() {} + + /*** Interface Methods ***/ + virtual int Init(void *init_struct) { + return VL6180X_Init(); + } + + virtual int ReadID(uint8_t *ht_id) { + return VL6180X_ReadID(ht_id); + } + + /** + * @brief Reset sensor + * @return 0 in case of success, an error code otherwise + */ + virtual int Reset(void) { + return VL6180X_RebootCmd(); + } + + virtual int GetRange(float *pfData) { + return VL6180X_GetRange(pfData); + } + + virtual int GetLight(float *pfData) { + return VL6180X_GetLight(pfData); + } + + protected: + /*** Methods ***/ + RANGE_LIGHT_StatusTypeDef VL6180X_Init(RANGE_LIGHT_InitTypeDef *VL6180X_Init); + RANGE_LIGHT_StatusTypeDef VL6180X_ReadID(uint8_t *ht_id); + RANGE_LIGHT_StatusTypeDef VL6180X_SetID(uint8_t *ht_id); + RANGE_LIGHT_StatusTypeDef VL6180X_RebootCmd(void); + RANGE_LIGHT_StatusTypeDef VL6180X_GetRange(float* pfData); + RANGE_LIGHT_StatusTypeDef VL6180X_GetLight(float* pfData); + + /** + * @brief Configures VL6180X interrupt lines for NUCLEO boards + */ + void VL6180X_IO_ITConfig(void) + { + /* To be implemented */ + } + + /** + * @brief Configures VL6180X I2C interface + * @return RANGE_LIGHT_OK in case of success, an error code otherwise + */ + RANGE_LIGHT_StatusTypeDef VL6180X_IO_Init(void) + { + return RANGE_LIGHT_OK; /* done in constructor */ + } + + + /*** Instance Variables ***/ + /* IO Device */ + DevI2C &dev_i2c; + + +}; + +#endif // __VL6180X_CLASS_H \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_def.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,743 @@ +/******************************************************************************* +Copyright © 2014, STMicroelectronics International N.V. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * 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. + * 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, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED. +IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. 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. +********************************************************************************/ + +/* + * $Date: 2015-05-13 14:12:05 +0200 (Wed, 13 May 2015) $ + * $Revision: 2290 $ + */ + +/** + * @file VL6180x_def.h + * + * @brief Type definitions for vl6180x api. + * + */ + + +#ifndef _VL6180x_DEF +#define _VL6180x_DEF + +/** API major version */ +#define VL6180x_API_REV_MAJOR 3 +/** API minor version */ +#define VL6180x_API_REV_MINOR 0 +/** API sub version */ +#define VL6180x_API_REV_SUB 1 + +#define VL6180X_STR_HELPER(x) #x +#define VL6180X_STR(x) VL6180X_STR_HELPER(x) + +#include "vl6180x_cfg.h" +#include "vl6180x_types.h" + +/* + * check configuration macro raise error or warning and suggest a default value + */ + +#ifndef VL6180x_UPSCALE_SUPPORT +#error "VL6180x_UPSCALE_SUPPORT not defined" +/* TODO you must define value for upscale support in your vl6180x_cfg.h */ +#endif + +#ifndef VL6180x_ALS_SUPPORT +#error "VL6180x_ALS_SUPPORT not defined" +/* TODO you must define VL6180x_ALS_SUPPORT with a value in your vl6180x_cfg.h set to 0 do disable*/ +#endif + +#ifndef VL6180x_HAVE_DMAX_RANGING +#error "VL6180x_HAVE_DMAX_RANGING not defined" +/* TODO you may remove or comment these #error and keep the default below or update your vl6180x_cfg.h .h file */ +/** + * force VL6180x_HAVE_DMAX_RANGING to not supported when not part of cfg file + */ +#define VL6180x_HAVE_DMAX_RANGING 0 +#endif + +#ifndef VL6180x_EXTENDED_RANGE +#define VL6180x_EXTENDED_RANGE 0 +#endif + +#ifndef VL6180x_WRAP_AROUND_FILTER_SUPPORT +#error "VL6180x_WRAP_AROUND_FILTER_SUPPORT not defined ?" +/* TODO you may remove or comment these #error and keep the default below or update vl6180x_cfg.h file */ +/** + * force VL6180x_WRAP_AROUND_FILTER_SUPPORT to not supported when not part of cfg file + */ +#define VL6180x_WRAP_AROUND_FILTER_SUPPORT 0 +#endif + + + + +/**************************************** + * PRIVATE define do not edit + ****************************************/ + +/** Maximal buffer size ever use in i2c */ +#define VL6180x_MAX_I2C_XFER_SIZE 8 /* At present time it 6 byte max but that can change */ + +#if VL6180x_UPSCALE_SUPPORT < 0 +/** + * @def VL6180x_HAVE_UPSCALE_DATA + * @brief is defined if device data structure has data so when user configurable up-scale is active + */ +#define VL6180x_HAVE_UPSCALE_DATA /* have data only for user configurable up-scale config */ +#endif + +#if VL6180x_WRAP_AROUND_FILTER_SUPPORT +/** + * @def VL6180x_HAVE_WRAP_AROUND_DATA + * @brief is defined if device data structure has filter data so when active in cfg file + */ +#define VL6180x_HAVE_WRAP_AROUND_DATA +#endif + +#if VL6180x_ALS_SUPPORT != 0 +/** + * @def VL6180x_HAVE_ALS_DATA + * @brief is defined when als data are include in device data structure so when als suport if configured + */ +#define VL6180x_HAVE_ALS_DATA +#endif + + +#if VL6180x_WRAP_AROUND_FILTER_SUPPORT || VL6180x_HAVE_DMAX_RANGING + #define VL6180x_HAVE_RATE_DATA +#endif + +/** Error and warning code returned by API + * + * negative value are true error mostly fatal\n + * positive value are warning most of time it's ok to continue\n + */ +enum VL6180x_ErrCode_t{ + API_NO_ERROR = 0, + CALIBRATION_WARNING = 1, /*!< warning invalid calibration data may be in used \a VL6180x_InitData() \a VL6180x_GetOffsetCalibrationData \a VL6180x_SetOffsetCalibrationData*/ + MIN_CLIPED = 2, /*!< warning parameter passed was clipped to min before to be applied */ + NOT_GUARANTEED = 3, /*!< Correct operation is not guaranteed typically using extended ranging on vl6180x */ + NOT_READY = 4, /*!< the data is not ready retry */ + + API_ERROR = -1, /*!< Unqualified error */ + INVALID_PARAMS = -2, /*!< parameter passed is invalid or out of range */ + NOT_SUPPORTED = -3, /*!< function is not supported in current mode or configuration */ + RANGE_ERROR = -4, /*!< device report a ranging error interrupt status */ + TIME_OUT = -5, /*!< aborted due to time out */ +}; + +/** + * Filtered result data structure range data is to be used + */ +typedef struct RangeFilterResult_tag { + uint16_t range_mm; /*!< Filtered ranging value */ + uint16_t rawRange_mm; /*!< raw range value (scaled) */ +} RangeFilterResult_t; + +/** + * "small" unsigned data type used in filter + * + * if data space saving is not a concern it can be change to platform native unsigned int + */ +typedef uint8_t FilterType1_t; + +/** + * @def FILTER_NBOF_SAMPLES + * @brief sample history len used for wrap around filtering + */ +#define FILTER_NBOF_SAMPLES 10 +/** + * Wrap around filter internal data + */ +struct FilterData_t { + uint32_t MeasurementIndex; /*!< current measurement index */ + uint16_t LastTrueRange[FILTER_NBOF_SAMPLES]; /*!< filtered/corrected distance history */ + uint32_t LastReturnRates[FILTER_NBOF_SAMPLES]; /*!< Return rate history */ + uint16_t StdFilteredReads; /*!< internal use */ + FilterType1_t Default_ZeroVal; /*!< internal use */ + FilterType1_t Default_VAVGVal; /*!< internal use */ + FilterType1_t NoDelay_ZeroVal; /*!< internal use */ + FilterType1_t NoDelay_VAVGVal; /*!< internal use */ + FilterType1_t Previous_VAVGDiff; /*!< internal use */ +}; + +#if VL6180x_HAVE_DMAX_RANGING +typedef int32_t DMaxFix_t; +struct DMaxData_t { + uint32_t ambTuningWindowFactor_K; /*!< internal algo tuning (*1000) */ + + DMaxFix_t retSignalAt400mm; /*!< intermediate dmax computation value caching @a #SYSRANGE_CROSSTALK_COMPENSATION_RATE and private reg 0x02A */ + //int32_t RegB8; /*!< register 0xB8 cached to speed reduce i2c traffic for dmax computation */ + /* place all word data below to optimize struct packing */ + //int32_t minSignalNeeded; /*!< optimized computation intermediate base on register cached value */ + int32_t snrLimit_K; /*!< cached and optimized computation intermediate from @a #SYSRANGE_MAX_AMBIENT_LEVEL_MULT */ + uint16_t ClipSnrLimit; /*!< Max value for snr limit */ + /* place all byte data below to optimize packing */ + //uint8_t MaxConvTime; /*!< cached max convergence time @a #SYSRANGE_MAX_CONVERGENCE_TIME*/ +}; +#endif + +/** + * @struct VL6180xDevData_t + * + * @brief Per VL6180x device St private data structure \n + * End user should never access any of these field directly + * + * These must never access directly but only via VL6180xDev/SetData(dev, field) macro + */ +struct VL6180xDevData_t { + + uint32_t Part2PartAmbNVM; /*!< backed up NVM value */ + uint32_t XTalkCompRate_KCps; /*! Cached XTlak Compensation Rate */ + + uint16_t EceFactorM; /*!< Ece Factor M numerator */ + uint16_t EceFactorD; /*!< Ece Factor D denominator*/ + +#ifdef VL6180x_HAVE_ALS_DATA + uint16_t IntegrationPeriod; /*!< cached als Integration period avoid slow read from device at each measure */ + uint16_t AlsGainCode; /*!< cached Als gain avoid slow read from device at each measure */ + uint16_t AlsScaler; /*!< cached Als scaler avoid slow read from device at each measure */ +#endif + +#ifdef VL6180x_HAVE_UPSCALE_DATA + uint8_t UpscaleFactor; /*!< up-scaling factor*/ +#endif + +#ifdef VL6180x_HAVE_WRAP_AROUND_DATA + uint8_t WrapAroundFilterActive; /*!< Filter on/off */ + struct FilterData_t FilterData; /*!< Filter internal data state history ... */ +#endif + +#if VL6180x_HAVE_DMAX_RANGING + struct DMaxData_t DMaxData; + uint8_t DMaxEnable; +#endif + int8_t Part2PartOffsetNVM; /*!< backed up NVM value */ +}; + +#if VL6180x_SINGLE_DEVICE_DRIVER +extern struct VL6180xDevData_t SingleVL6180xDevData; +#define VL6180xDevDataGet(dev, field) (SingleVL6180xDevData.field) +/* is also used as direct accessor like VL6180xDevDataGet(dev, x)++*/ +#define VL6180xDevDataSet(dev, field, data) (SingleVL6180xDevData.field)=(data) +#endif + + +/** + * @struct VL6180x_RangeData_t + * @brief Range and any optional measurement data. + */ +typedef struct { + int32_t range_mm; /*!< range distance in mm. */ + int32_t signalRate_mcps; /*!< signal rate (MCPS)\n these is a 9.7 fix point value, which is effectively a measure of target reflectance.*/ + uint32_t errorStatus; /*!< Error status of the current measurement. \n + see @a ::RangeError_u @a VL6180x_GetRangeStatusErrString() */ + + +#ifdef VL6180x_HAVE_RATE_DATA + uint32_t rtnAmbRate; /*!< Return Ambient rate in KCount per sec related to \a RESULT_RANGE_RETURN_AMB_COUNT */ + uint32_t rtnRate; /*!< Return rate in KCount per sec related to \a RESULT_RANGE_RETURN_SIGNAL_COUNT */ + uint32_t rtnConvTime; /*!< Return Convergence time \a RESULT_RANGE_RETURN_CONV_TIME */ + uint32_t refConvTime; /*!< Reference convergence time \a RESULT_RANGE_REFERENCE_CONV_TIME */ +#endif + + +#if VL6180x_HAVE_DMAX_RANGING + uint32_t DMax; /*!< DMax when applicable */ +#endif + +#ifdef VL6180x_HAVE_WRAP_AROUND_DATA + RangeFilterResult_t FilteredData; /*!< Filter result main range_mm is updated */ +#endif +}VL6180x_RangeData_t; + + +/** use where fix point 9.7 bit values are expected + * + * given a floating point value f it's .7 bit point is (int)(f*(1<<7))*/ +typedef uint16_t FixPoint97_t; + +/** lux data type */ +typedef uint32_t lux_t; + +/** + * @brief This data type defines als measurement data. + */ +typedef struct VL6180x_AlsData_st{ + lux_t lux; /**< Light measurement (Lux) */ + uint32_t errorStatus; /**< Error status of the current measurement. \n + * No Error := 0. \n + * Refer to product sheets for other error codes. */ +}VL6180x_AlsData_t; + +/** + * @brief Range status Error code + * + * @a VL6180x_GetRangeStatusErrString() if configured ( @a #VL6180x_RANGE_STATUS_ERRSTRING ) + * related to register @a #RESULT_RANGE_STATUS and additional post processing + */ +typedef enum { + NoError_=0, /*!< 0 0b0000 NoError */ + VCSEL_Continuity_Test, /*!< 1 0b0001 VCSEL_Continuity_Test */ + VCSEL_Watchdog_Test, /*!< 2 0b0010 VCSEL_Watchdog_Test */ + VCSEL_Watchdog, /*!< 3 0b0011 VCSEL_Watchdog */ + PLL1_Lock, /*!< 4 0b0100 PLL1_Lock */ + PLL2_Lock, /*!< 5 0b0101 PLL2_Lock */ + Early_Convergence_Estimate,/*!< 6 0b0110 Early_Convergence_Estimate */ + Max_Convergence, /*!< 7 0b0111 Max_Convergence */ + No_Target_Ignore, /*!< 8 0b1000 No_Target_Ignore */ + Not_used_9, /*!< 9 0b1001 Not_used */ + Not_used_10, /*!< 10 0b1010 Not_used_ */ + Max_Signal_To_Noise_Ratio, /*!< 11 0b1011 Max_Signal_To_Noise_Ratio*/ + Raw_Ranging_Algo_Underflow,/*!< 12 0b1100 Raw_Ranging_Algo_Underflow*/ + Raw_Ranging_Algo_Overflow, /*!< 13 0b1101 Raw_Ranging_Algo_Overflow */ + Ranging_Algo_Underflow, /*!< 14 0b1110 Ranging_Algo_Underflow */ + Ranging_Algo_Overflow, /*!< 15 0b1111 Ranging_Algo_Overflow */ + + /* code below are addition for API/software side they are not hardware*/ + RangingFiltered =0x10, /*!< 16 0b10000 filtered by post processing*/ + +} RangeError_u; + + +/** @defgroup device_regdef Device registers & masks definitions + * @brief Device registers and masks definitions + */ + + +/** @ingroup device_regdef + * @{*/ + +/** + * The device model ID + */ +#define IDENTIFICATION_MODEL_ID 0x000 +/** + * Revision identifier of the Device for major change. + */ +#define IDENTIFICATION_MODULE_REV_MAJOR 0x003 +/** + * Revision identifier of the Device for minor change. + */ +#define IDENTIFICATION_MODULE_REV_MINOR 0x004 + + +/** + * @def SYSTEM_MODE_GPIO0 + * @brief Configures polarity and select which function gpio 0 serves. + * Gpio0 is chip enable at power up ! Be aware of all h/w implication of turning it to output. + * Same definition as #SYSTEM_MODE_GPIO1 + * @ingroup device_regdef + */ +#define SYSTEM_MODE_GPIO0 0x010 +/** + * @def SYSTEM_MODE_GPIO1 + * @brief Configures polarity and select what als or ranging functionality gpio pin serves. + * + * Function can be #GPIOx_SELECT_OFF #GPIOx_SELECT_GPIO_INTERRUPT_OUTPUT.\n + * Same definition apply to register GPIO0 that is used as chip enable at power up. + * @ingroup device_regdef + */ +#define SYSTEM_MODE_GPIO1 0x011 + /** gpio pad POLARITY mask in #SYSTEM_MODE_GPIO1 (and/or 0) write 1 to set active high polarity (positive edge) */ + #define GPIOx_POLARITY_SELECT_MASK 0x20 + /** gpio pad Function select shift in #SYSTEM_MODE_GPIO1 or 0 */ + #define GPIOx_FUNCTIONALITY_SELECT_SHIFT 1 + /** gpio pad Function select mask in #SYSTEM_MODE_GPIO1 or 0 */ + #define GPIOx_FUNCTIONALITY_SELECT_MASK (0xF<<GPIOx_FUNCTIONALITY_SELECT_SHIFT) + /** select no interrupt in #SYSTEM_MODE_GPIO1 pad is put in Hi-Z*/ + #define GPIOx_SELECT_OFF 0x00 + /** select gpiox as interrupt output in #SYSTEM_MODE_GPIO1 */ + #define GPIOx_SELECT_GPIO_INTERRUPT_OUTPUT 0x08 + /** select range as source for interrupt on in #SYSTEM_MODE_GPIO1 */ + #define GPIOx_MODE_SELECT_RANGING 0x00 + /** select als as source for interrupt on in #SYSTEM_MODE_GPIO1 */ + #define GPIOx_MODE_SELECT_ALS 0x01 + + +/** + * @def SYSTEM_INTERRUPT_CONFIG_GPIO + * + * @brief Configure Als and Ranging interrupt reporting + * + * Possible values for Range and ALS are\n + * + * #CONFIG_GPIO_INTERRUPT_DISABLED\n + * #CONFIG_GPIO_INTERRUPT_LEVEL_LOW\n + * #CONFIG_GPIO_INTERRUPT_LEVEL_HIGH\n + * #CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW\n + * #CONFIG_GPIO_INTERRUPT_NEW_SAMPLE_READY\n + * Apply respective rang/als shift and mask \n + * #CONFIG_GPIO_RANGE_SHIFT and full reg mask #CONFIG_GPIO_RANGE_MASK\n + * #CONFIG_GPIO_ALS_SHIFT and full reg mask #CONFIG_GPIO_ALS_MASK\n + * + * \sa GPIO use for interrupt #SYSTEM_MODE_GPIO0 or #SYSTEM_MODE_GPIO1\n + * @ingroup device_regdef + */ +#define SYSTEM_INTERRUPT_CONFIG_GPIO 0x014 + /** RANGE bits shift in #SYSTEM_INTERRUPT_CONFIG_GPIO */ + #define CONFIG_GPIO_RANGE_SHIFT 0 + /** RANGE bits mask in #SYSTEM_INTERRUPT_CONFIG_GPIO (unshifted)*/ + #define CONFIG_GPIO_RANGE_MASK (0x7<<CONFIG_GPIO_RANGE_SHIFT) + /** ALS bits shift in #SYSTEM_INTERRUPT_CONFIG_GPIO */ + #define CONFIG_GPIO_ALS_SHIFT 3 + /** ALS bits mask in #SYSTEM_INTERRUPT_CONFIG_GPIO (unshifted)*/ + #define CONFIG_GPIO_ALS_MASK (0x7<<CONFIG_GPIO_ALS_SHIFT) + /** interrupt is disabled */ + #define CONFIG_GPIO_INTERRUPT_DISABLED 0x00 + /** trigger when value < low threshold */ + #define CONFIG_GPIO_INTERRUPT_LEVEL_LOW 0x01 + /** trigger when value < low threshold */ + #define CONFIG_GPIO_INTERRUPT_LEVEL_HIGH 0x02 + /** trigger when outside range defined by high low threshold */ + #define CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW 0x03 + /** trigger when new sample are ready */ + #define CONFIG_GPIO_INTERRUPT_NEW_SAMPLE_READY 0x04 + +/** + * @def SYSTEM_INTERRUPT_CLEAR + * @brief Writing to this register will clear interrupt source + * + * Use or combination of any #INTERRUPT_CLEAR_RANGING , #INTERRUPT_CLEAR_ALS , #INTERRUPT_CLEAR_ERROR + * @ingroup device_regdef + */ +#define SYSTEM_INTERRUPT_CLEAR 0x015 + /** clear ranging interrupt in write to #SYSTEM_INTERRUPT_CLEAR */ + #define INTERRUPT_CLEAR_RANGING 0x01 + /** clear als interrupt in write to #SYSTEM_INTERRUPT_CLEAR */ + #define INTERRUPT_CLEAR_ALS 0x02 + /** clear error interrupt in write to #SYSTEM_INTERRUPT_CLEAR */ + #define INTERRUPT_CLEAR_ERROR 0x04 + +/** After power up or reset this register will start reading 1 when device is ready */ +#define SYSTEM_FRESH_OUT_OF_RESET 0x016 + +/** + * @def SYSTEM_GROUPED_PARAMETER_HOLD + * @brief Writing 1/0 activate/deactivate safe host update of multiple register in critical group \n + * rather use \a VL6180x_SetGroupParamHold() + * + * The critical register group is made of: \n + * #SYSTEM_INTERRUPT_CONFIG_GPIO \n + * #SYSRANGE_THRESH_HIGH \n + * #SYSRANGE_THRESH_LOW \n + * #SYSALS_INTEGRATION_PERIOD \n + * #SYSALS_ANALOGUE_GAIN \n + * #SYSALS_THRESH_HIGH \n + * #SYSALS_THRESH_LOW + * @ingroup device_regdef + */ +#define SYSTEM_GROUPED_PARAMETER_HOLD 0x017 + + +/** + * @def SYSRANGE_START + * @brief Start/stop and set operating range mode + * + * Write Combination of #MODE_START_STOP and #MODE_CONTINUOUS to select and start desired operation. + * + * @ingroup device_regdef + */ +#define SYSRANGE_START 0x018 + /** mask existing bit in #SYSRANGE_START*/ + #define MODE_MASK 0x03 + /** bit 0 in #SYSRANGE_START write 1 toggle state in continuous mode and arm next shot in single shot mode */ + #define MODE_START_STOP 0x01 + /** bit 1 write 1 in #SYSRANGE_START set continuous operation mode */ + #define MODE_CONTINUOUS 0x02 + /** bit 1 write 0 in #SYSRANGE_START set single shot mode */ + #define MODE_SINGLESHOT 0x00 + +/** + * @def SYSRANGE_THRESH_HIGH + * High level range threshold (must be scaled) + * @ingroup device_regdef + */ +#define SYSRANGE_THRESH_HIGH 0x019 + +/** + * @def SYSRANGE_THRESH_LOW + * Low level range threshold (must be scaled) + * @ingroup device_regdef + */ +#define SYSRANGE_THRESH_LOW 0x01A + +/** + * @def SYSRANGE_INTERMEASUREMENT_PERIOD + * @brief Continuous mode intermeasurement delay \a VL6180x_RangeSetInterMeasPeriod() + * + * Time delay between measurements in Ranging continuous mode.\n + * Range 0-254 (0 = 10ms).\n Step size = 10ms. + * + * @ingroup device_regdef + */ +#define SYSRANGE_INTERMEASUREMENT_PERIOD 0x01B + +/** + * @brief Maximum time to run measurement in Ranging modes. + * Range 1 - 63 ms (1 code = 1 ms); + * + * Measurement aborted when limit reached to aid power reduction.\ + * For example, 0x01 = 1ms, 0x0a = 10ms.\ + * Note: Effective max_convergence_time depends on readout_averaging_sample_period setting. + * + * @ingroup device_regdef + */ +#define SYSRANGE_MAX_CONVERGENCE_TIME 0x01C +/**@brief Cross talk compensation rate + * @warning never write register directly use @a VL6180x_SetXTalkCompensationRate() + * refer to manual for calibration procedure and computation + * @ingroup device_regdef + */ +#define SYSRANGE_CROSSTALK_COMPENSATION_RATE 0x01E +/** + * @brief Minimum range value in mm to qualify for crosstalk compensation + */ +#define SYSRANGE_CROSSTALK_VALID_HEIGHT 0x021 +#define SYSRANGE_EARLY_CONVERGENCE_ESTIMATE 0x022 +#define SYSRANGE_PART_TO_PART_RANGE_OFFSET 0x024 +#define SYSRANGE_RANGE_IGNORE_VALID_HEIGHT 0x025 +#define SYSRANGE_RANGE_IGNORE_THRESHOLD 0x026 +#define SYSRANGE_EMITTER_BLOCK_THRESHOLD 0x028 +#define SYSRANGE_MAX_AMBIENT_LEVEL_THRESH 0x02A +#define SYSRANGE_MAX_AMBIENT_LEVEL_MULT 0x02C +/** @brief various Enable check enabel register + * @a VL6180x_RangeSetEceState() + */ +#define SYSRANGE_RANGE_CHECK_ENABLES 0x02D + #define RANGE_CHECK_ECE_ENABLE_MASK 0x01 + #define RANGE_CHECK_RANGE_ENABLE_MASK 0x02 + #define RANGE_CHECK_SNR_ENABLKE 0x10 + +#define SYSRANGE_VHV_RECALIBRATE 0x02E +#define SYSRANGE_VHV_REPEAT_RATE 0x031 + +/** + * @def SYSALS_START + * @brief Start/stop and set operating als mode + * + * same bit definition as range \a #SYSRANGE_START \n + */ +#define SYSALS_START 0x038 + +/** ALS low Threshold high */ +#define SYSALS_THRESH_HIGH 0x03A +/** ALS low Threshold low */ +#define SYSALS_THRESH_LOW 0x03C +/** ALS intermeasurement period */ +#define SYSALS_INTERMEASUREMENT_PERIOD 0x03E +/** + * @warning or value with 0x40 when writing to these register*/ +#define SYSALS_ANALOGUE_GAIN 0x03F +/** ALS integration period */ +#define SYSALS_INTEGRATION_PERIOD 0x040 + +/** + * @brief Result range status + * + * Hold the various range interrupt flags and error Specific error codes + */ +#define RESULT_RANGE_STATUS 0x04D + /** Device ready for new command bit 0*/ + #define RANGE_DEVICE_READY_MASK 0x01 + /** mask for error status covers bits [7:4] in #RESULT_RANGE_STATUS @a ::RangeError_u */ + #define RANGE_ERROR_CODE_MASK 0xF0 /* */ + /** range error bit position in #RESULT_RANGE_STATUS */ + #define RANGE_ERROR_CODE_SHIFT 4 + +/** + * @def RESULT_ALS_STATUS + * @brief Result als status \n + * Hold the various als interrupt flags and Specific error codes + */ +#define RESULT_ALS_STATUS 0x4E + /** Device ready for new command bit 0*/ + #define ALS_DEVICE_READY_MASK 0x01 + +/** + * @def RESULT_ALS_VAL + * @brief 16 Bit ALS count output value. + * + * Lux value depends on Gain and integration settings and calibrated lux/count setting + * \a VL6180x_AlsGetLux() \a VL6180x_AlsGetMeasurement() + */ +#define RESULT_ALS_VAL 0x50 + +/** + * @def FW_ALS_RESULT_SCALER + * @brief Als scaler register Bits [3:0] analogue gain 1 to 16x + * these register content is cached by API in \a VL6180xDevData_t::AlsScaler + * for lux computation acceleration + */ +#define FW_ALS_RESULT_SCALER 0x120 + + +/** + * these union can be use as a generic bit field type for map #RESULT_INTERRUPT_STATUS_GPIO register + * @ingroup device_regdef + */ +typedef union IntrStatus_u{ + uint8_t val; /*!< raw 8 bit register value*/ + struct { + unsigned Range :3; /*!< Range status one of :\n \a #RES_INT_STAT_GPIO_LOW_LEVEL_THRESHOLD \n \a #RES_INT_STAT_GPIO_HIGH_LEVEL_THRESHOLD \n \a #RES_INT_STAT_GPIO_OUT_OF_WINDOW \n \a #RES_INT_STAT_GPIO_NEW_SAMPLE_READY */ + unsigned Als :3; /*!< Als status one of: \n \a #RES_INT_STAT_GPIO_LOW_LEVEL_THRESHOLD \n \a #RES_INT_STAT_GPIO_HIGH_LEVEL_THRESHOLD \n \a #RES_INT_STAT_GPIO_OUT_OF_WINDOW \n \a #RES_INT_STAT_GPIO_NEW_SAMPLE_READY */ + unsigned Error :2; /*!< Error status of: \n \a #RES_INT_ERROR_LASER_SAFETY \n \a #RES_INT_ERROR_PLL */ + } status; /*!< interrupt status as bit field */ +} IntrStatus_t; + +/** + * @def RESULT_INTERRUPT_STATUS_GPIO + * @brief System interrupt status report selected interrupt for als and ranging + * + * These register can be polled even if no gpio pins is active\n + * What reported is selected by \a #SYSTEM_INTERRUPT_CONFIG_GPIO \n + * Range mask with \a #RES_INT_RANGE_MASK and shit by \a #RES_INT_RANGE_SHIFT + * Als mask with \a #RES_INT_ALS_MASK and shit by \a #RES_INT_ALS_SHIFT + * Result value express condition (or combination?) + * \a #RES_INT_STAT_GPIO_LOW_LEVEL_THRESHOLD \n + * \a #RES_INT_STAT_GPIO_HIGH_LEVEL_THRESHOLD \n + * \a #RES_INT_STAT_GPIO_OUT_OF_WINDOW \n + * \a #RES_INT_STAT_GPIO_NEW_SAMPLE_READY + * + * @ingroup device_regdef + */ +#define RESULT_INTERRUPT_STATUS_GPIO 0x4F + /** ranging interrupt 1st bit position in #RESULT_INTERRUPT_STATUS_GPIO */ + #define RES_INT_RANGE_SHIFT 0 + /** ALS interrupt 1st bit position in #RESULT_INTERRUPT_STATUS_GPIO */ + #define RES_INT_ALS_SHIFT 3 + /** interrupt bit position in #RESULT_INTERRUPT_STATUS_GPIO */ + #define RES_INT_ERROR_SHIFT 6 + /** Ranging interrupt mask in #RESULT_INTERRUPT_STATUS_GPIO (prior to shift) \sa IntrStatus_t */ + #define RES_INT_RANGE_MASK (0x7<<RES_INT_RANGE_SHIFT) + /** als interrupt mask in #RESULT_INTERRUPT_STATUS_GPIO (prior to shift) \sa IntrStatus_t */ + #define RES_INT_ALS_MASK (0x7<<RES_INT_ALS_SHIFT) + + /** low threshold condition in #RESULT_INTERRUPT_STATUS_GPIO for */ + #define RES_INT_STAT_GPIO_LOW_LEVEL_THRESHOLD 0x01 + /** high threshold condition in #RESULT_INTERRUPT_STATUS_GPIO for ALs or Rage*/ + #define RES_INT_STAT_GPIO_HIGH_LEVEL_THRESHOLD 0x02 + /** out of window condition in #RESULT_INTERRUPT_STATUS_GPIO */ + #define RES_INT_STAT_GPIO_OUT_OF_WINDOW 0x03 + /** new sample ready in #RESULT_INTERRUPT_STATUS_GPIO */ + #define RES_INT_STAT_GPIO_NEW_SAMPLE_READY 0x04 + /** error in #RESULT_INTERRUPT_STATUS_GPIO */ + #define RES_INT_ERROR_MASK (0x3<<RES_INT_ERROR_SHIFT) + /** laser safety error on #RES_INT_ERROR_MASK of #RESULT_INTERRUPT_STATUS_GPIO */ + #define RES_INT_ERROR_LASER_SAFETY 1 + /** pll 1 or 2 error on #RES_INT_ERROR_MASK of #RESULT_INTERRUPT_STATUS_GPIO*/ + #define RES_INT_ERROR_PLL 2 + +/** + * Final range result value presented to the user for use. Unit is in mm. + */ +#define RESULT_RANGE_VAL 0x062 + +/** + * Raw Range result value with offset applied (no cross talk compensation applied). Unit is in mm. + */ +#define RESULT_RANGE_RAW 0x064 + +/** + * @brief Sensor count rate of signal returns correlated to IR emitter. + * + * Computed from RETURN_SIGNAL_COUNT / RETURN_CONV_TIME. Mcps 9.7 format + */ +#define RESULT_RANGE_SIGNAL_RATE 0x066 + +/** + * @brief Return signal count + * + * Sensor count output value attributed to signal correlated to IR emitter on the Return array. + */ +#define RESULT_RANGE_RETURN_SIGNAL_COUNT 0x06C + +/** + * @brief Reference signal count + * + * sensor count output value attributed to signal correlated to IR emitter on the Reference array. + */ +#define RESULT_RANGE_REFERENCE_SIGNAL_COUNT 0x070 + +/** + * @brief Return ambient count + * + * sensor count output value attributed to uncorrelated ambient signal on the Return array. + * Must be multiplied by 6 if used to calculate the ambient to signal threshold + */ +#define RESULT_RANGE_RETURN_AMB_COUNT 0x074 + +/** + * @brief Reference ambient count + * + * Sensor count output value attributed to uncorrelated ambient signal on the Reference array. + */ +#define RESULT_RANGE_REFERENCE_AMB_COUNT 0x078 + +/** + * sensor count output value attributed to signal on the Return array. + */ +#define RESULT_RANGE_RETURN_CONV_TIME 0x07C + +/** + * sensor count output value attributed to signal on the Reference array. + */ +#define RESULT_RANGE_REFERENCE_CONV_TIME 0x080 + + +/** + * @def RANGE_SCALER + * @brief RANGE scaling register + * + * Never should user write directly onto that register directly \a VL6180x_UpscaleSetScaling() + */ +#define RANGE_SCALER 0x096 + +/** + * @def READOUT_AVERAGING_SAMPLE_PERIOD + * @brief Readout averaging sample period register + * + * + * The internal readout averaging sample period can be adjusted from 0 to 255. + * Increasing the sampling period decreases noise but also reduces the effective + * max convergence time and increases power consumption + * Each unit sample period corresponds to around 64.5 μs additional processing time. + * The recommended setting is 48 which equates to around 4.3 ms. + * + * see datasheet for more detail + */ +#define READOUT_AVERAGING_SAMPLE_PERIOD 0x10A + +/** + * @def I2C_SLAVE_DEVICE_ADDRESS + * User programmable I2C address (7-bit). Device address can be re-designated after power-up. + * @warning What programmed in the register 7-0 are bit 8-1 of i2c address on bus (bit 0 is rd/wr) + * so what prohamd is commonly whar ergfer as adrerss /2 + * @sa VL6180x_SetI2CAddress() + */ +#define I2C_SLAVE_DEVICE_ADDRESS 0x212 + +#endif /* _VL6180x_DEF */
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_i2c.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,166 @@ +/* + * $Date: 2015-01-08 14:30:24 +0100 (Thu, 08 Jan 2015) $ + * $Revision: 2039 $ + */ + +/** + * @file vl6180x_i2c.h + * + * @brief CCI interface to "raw i2c" translation layer + */ + +#ifndef VL6180_I2C_H_ +#define VL6180_I2C_H_ + +#include "vl6180x_platform.h" + +/** + * @defgroup cci_i2c CCI to RAW I2C translation layer + * + * This optional tranlation layer is implemented in __platform/cci-i2c__ directory. If user uses this translation layer for his platform, only @a VL6180x_I2CRead() and + * @a VL6180x_I2CWrite() functions need to be implemented. Also, some code adaption (via macro) is required for multi-threading and for multiple device support. + * + * File vl6180x_i2c.c implements device register access via raw i2c access. If the targeted application and platform has no multi-thread, no multi-cpu and uses single + * device, then nothing else is required than the 2 mandatory function : @a VL6180x_I2CRead() and @a VL6180x_I2CWrite().\n + * In other cases, review and customize @a VL6180x_GetI2CAccess() and @a VL6180x_DoneI2CAccess() functions as well as @a #VL6180x_I2C_USER_VAR macro. This should be enough + * to conform to a wide range of platform OS and application requirements .\n + * + * If your configured i2c for per device buffer via @a #I2C_BUFFER_CONFIG == 2, you must implement @a VL6180x_GetI2cBuffer() + * + * __I2C Port sample__ \n + * A __linux kernel__ port need a "long flags" var for its spin_lock in all functions. the following code example declares a spin lock "lock" in the custom device structure. \n + * @code +struct MyVL6180Dev_t { + struct VL6180xDevData_t StData; + ... + spinlock_t i2c_lock; +}; +typedef struct MyVL6180Dev_t *VL6180xDev_t; + +#define VL6180x_I2C_USER_VAR unsigned long flags; +#define GetI2CAccess(dev) spin_lock_irqsave(dev->i2c_lock, flags) +#define DoneI2CAccess(dev) spin_unlock_irqrestore(dev->i2c_lock,flags) +@endcode + +* __POSIX pthread__ application porting could be as follows :\n +* @code +struct MyVL6180Dev_t { + struct VL6180xDevData_t StData; + ... + pthread_mutex_t *lock; +}; +typedef struct MyVL6180Dev_t *VL6180xDev_t; + +#define VL6180x_I2C_USER_VAR //no need +#define VL6180x_GetI2CAccess(dev) pthread_mutex_lock(dev->lock) +#define VL6180x_DoneI2CAcces(dev) pthread_mutex_unlock(dev->lock) + * @endcode + */ + +/** + * @def I2C_BUFFER_CONFIG + * + * @brief Configure device register I2C access + * + * @li 0 : one GLOBAL buffer \n + * Use one global buffer of MAX_I2C_XFER_SIZE byte in data space \n + * This solution is not multi-device compliant nor multi-thread cpu safe \n + * It can be the best option for small 8/16 bit MCU without stack and limited ram (STM8s, 80C51 ...) + * + * @li 1 : ON_STACK/local \n + * Use local variable (on stack) buffer \n + * This solution is multi-thread with use of i2c resource lock or mutex see @a VL6180x_GetI2CAccess() \n + * + * @li 2 : User defined \n + * Per device potentially dynamic allocated. Requires @a VL6180x_GetI2cBuffer() to be implemented. + * @ingroup Configuration + */ +#define I2C_BUFFER_CONFIG 1 + +/** + * @brief Write data buffer to VL6180x device via i2c + * @param dev The device to write to + * @param buff The data buffer + * @param len The length of the transaction in byte + * @return 0 on success + * @ingroup cci_i2c + */ +int VL6180x_I2CWrite(VL6180xDev_t dev, uint8_t *buff, uint8_t len); + +/** + * + * @brief Read data buffer from VL6180x device via i2c + * @param dev The device to read from + * @param buff The data buffer to fill + * @param len The length of the transaction in byte + * @return 0 on success + * @ingroup cci_i2c + */ +int VL6180x_I2CRead(VL6180xDev_t dev, uint8_t *buff, uint8_t len); + + +/** + * @brief Declare any required variables used by i2c lock (@a VL6180x_DoneI2CAccess() and @a VL6180x_GetI2CAccess()) + * and buffer access : @a VL6180x_GetI2cBuffer() + * + * @ingroup cci_i2c + */ +#define VL6180x_I2C_USER_VAR + +/** + * @brief Acquire lock or mutex for access to i2c data buffer and bus.\n + * Delete the default VL6180x_GetI2CAccess 'do-nothing' macro below if you decide to implement this function. + * + * This function is used to perform i2c bus level and multiple access locking required for multi thread/proccess system.\n + * Multiple access (read and update) will lock once and do multiple basic i2c rd/wr to complete the overall transfer.\n + * When no locking is needed this can be a void macro.\n + * + * @param dev the device + * @ingroup cci_i2c + */ +void VL6180x_GetI2CAccess(VL6180xDev_t dev); + +/** + * @def VL6180x_GetI2CAccess + * @brief Default 'do-nothing' macro for @a VL6180x_GetI2CAccess(). Delete if used. + * @ingroup cci_i2c + */ +#define VL6180x_GetI2CAccess(dev) (void)0 /* TODO delete if function used */ + +/** + * @brief Release acquired lock or mutex for i2c access.\n + * Delete default VL6180x_DoneI2CAccess 'do-nothing' macro below if implementing that function. + * + * This function is used to release the acquired lock. + * @param dev The device + * @ingroup cci_i2c + */ +void VL6180x_DoneI2CAccess(VL6180xDev_t dev); + +/** @def VL6180x_DoneI2CAcces + * @brief Default 'do-nothing' macro for @a VL6180x_DoneI2CAcces(). Delete if used. + * @ingroup cci_i2c + */ +#define VL6180x_DoneI2CAcces(dev) (void)0 /*TODO delete if function used */ + +/** + * @brief Provided data buffer for i2c access for at least n_byte. + * + * You must implement it when i2c @a #I2C_BUFFER_CONFIG is set to 2 (User defined).\n + * This is used used in the context of #VL6180x_I2C_USER_VAR + * + * @param dev The device + * @param n_byte Minimal number of byte + * @return The buffer (cannot fail return not checked) + * @ingroup cci_i2c + */ +uint8_t *VL6180x_GetI2cBuffer(VL6180xDev_t dev, int n_byte); +#if I2C_BUFFER_CONFIG == 2 +#error /* TODO add your macro of code here for VL6180x_GetI2cBuffer */ +#endif + + + + + +#endif /* VL6180_I2C_H_ */
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_platform.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,115 @@ +/******************************************************************************* +Copyright © 2014, STMicroelectronics International N.V. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * 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. + * 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, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED. +IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. 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. +********************************************************************************/ + + + +/* vl6180x_platform.h STM32 Nucelo F401 single device using generic cci-i2c + * trace via swo port some GnuArm eclipse toolset */ + +#ifndef VL6180x_PLATFORM +#define VL6180x_PLATFORM + + +#include "vl6180x_appcfg.h" +#include "vl6180x_def.h" + + + +#define VL6180x_DEV_DATA_ATTR + +#define ROMABLE_DATA +/* #define ROMABLE_DATA __attribute__ ((section ("user_rom"))) */ + + + +#if VL6180X_LOG_ENABLE +/* dot not include non ansi here trace was a case :( */ +#ifdef TRACE +#include "diag/trace.h" +extern volatile uint32_t g_TickCnt; +#define LOG_GET_TIME() g_TickCnt +#else +/* these is nto stm32 vl6180x GNuArm eclpse build*/ +#define trace_printf(...) (void)0 +#define LOG_GET_TIME() (int)0 /* add your code here expect to be an integer native (%d) type value */ +#endif + + + +#define LOG_FUNCTION_START(fmt, ... ) \ + trace_printf("beg %s start @%d\t" fmt "\n", __func__, LOG_GET_TIME(), ##__VA_ARGS__) + +#define LOG_FUNCTION_END(status)\ + trace_printf("end %s @%d %d\n", __func__, LOG_GET_TIME(), (int)status) + +#define LOG_FUNCTION_END_FMT(status, fmt, ... )\ + trace_printf("End %s @%d %d\t"fmt"\n" , __func__, LOG_GET_TIME(), (int)status, ##__VA_ARGS__) + +#define VL6180x_ErrLog(msg, ... )\ + do{\ + trace_printf("ERR in %s line %d\n" msg, __func__, __LINE__, ##__VA_ARGS__);\ + }while(0) + +#else /* VL6180X_LOG_ENABLE no logging */ + void OnErrLog(void); + #define LOG_FUNCTION_START(...) (void)0 + #define LOG_FUNCTION_END(...) (void)0 + #define LOG_FUNCTION_END_FMT(...) (void)0 + #define VL6180x_ErrLog(... ) OnErrLog() +#endif + + +#if VL6180x_SINGLE_DEVICE_DRIVER + typedef uint8_t VL6180xDev_t; + +#else /* VL6180x_SINGLE_DEVICE_DRIVER */ + + struct MyVL6180Dev_t { + struct VL6180xDevData_t Data; + #if I2C_BUFFER_CONFIG == 2 + uint8_t i2c_buffer[VL6180x_MAX_I2C_XFER_SIZE]; + #define VL6180x_GetI2cBuffer(dev, n) ((dev)->i2c_buffer) + #endif + }; + typedef struct MyVL6180Dev_t *VL6180xDev_t; + +#define VL6180xDevDataGet(dev, field) (dev->Data.field) +#define VL6180xDevDataSet(dev, field, data) (dev->Data.field)=(data) + +#endif /* #else VL6180x_SINGLE_DEVICE_DRIVER */ + +void VL6180x_PollDelay(VL6180xDev_t dev); + +void DISP_ExecLoopBody(void); +#define VL6180x_PollDelay(dev) DISP_ExecLoopBody(); + + +#endif /* VL6180x_PLATFORM */ + + +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/VL6180X/vl6180x_types.h Wed Sep 09 16:00:39 2015 +0000 @@ -0,0 +1,62 @@ +/******************************************************************************* +Copyright © 2014, STMicroelectronics International N.V. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * 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. + * 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, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED. +IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. 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. +********************************************************************************/ + +#ifndef VL6180x_TYPES_H_ +#define VL6180x_TYPES_H_ + + +#include <stdint.h> +#include <stddef.h> /* these is for NULL */ + +#ifndef NULL +#error "review NULL definition or add required include " +#endif + +#if !defined(STDINT_H) && !defined(_GCC_STDINT_H) && !defined(__STDINT_DECLS) && !defined(_STDINT) && !defined(_STDINT_H) + +#pragma message("Please review type definition of STDINT define for your platform and add to list above ") + + /* + * target platform do not provide stdint or use a different #define than above + * to avoid seeing the message below addapt the #define list above or implement + * all type and delete these pragma + */ + +typedef unsigned int uint32_t; +typedef int int32_t; + +typedef unsigned short uint16_t; +typedef short int16_t; + +typedef unsigned char uint8_t; + +typedef signed char int8_t; + +#endif /* _STDINT_H */ + +#endif /* VL6180x_TYPES_H_ */