Time of Flight Sensor
Dependencies: ST_INTERFACES X_NUCLEO_COMMON
Dependents: Ultrasound_And_IMU
Fork of X_NUCLEO_6180XA1 by
Diff: Components/VL6180X/vl6180x_cfg.h
- Revision:
- 57:fa4c622b04a7
- Parent:
- 35:407b0b127eb8
--- a/Components/VL6180X/vl6180x_cfg.h Mon Mar 13 17:57:03 2017 +0100 +++ b/Components/VL6180X/vl6180x_cfg.h Mon Mar 13 19:08:10 2017 +0000 @@ -31,13 +31,13 @@ */ /** - * @file VL6180x_cfg.h + * @file VL6180X_cfg.h * * Proximity and ALS configuration */ -#ifndef VL6180x_CFG_H_ -#define VL6180x_CFG_H_ +#ifndef VL6180X_CFG_H_ +#define VL6180X_CFG_H_ /** @defgroup api_config Configuration * @brief API static configuration @@ -50,42 +50,42 @@ /** - * @def VL6180x_UPSCALE_SUPPORT + * @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 + * @li -1 -2 -3 : Run time programmable through @a VL6180X_UpscaleSetScaling(). Default scaling factore is -VL6180X_UPSCALE_SUPPORT \n */ -//#define VL6180x_UPSCALE_SUPPORT -1 +//#define VL6180X_UPSCALE_SUPPORT -1 /** - * @def VL6180x_ALS_SUPPORT + * @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 +#define VL6180X_ALS_SUPPORT 1 /** - * @def VL6180x_HAVE_DMAX_RANGING + * @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). + * 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. + * 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 +#define VL6180X_HAVE_DMAX_RANGING 1 /** - * @def VL6180x_WRAP_AROUND_FILTER_SUPPORT + * @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 @@ -95,35 +95,35 @@ * * @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 + * @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 +#define VL6180X_WRAP_AROUND_FILTER_SUPPORT 1 /** - * @def VL6180x_EXTENDED_RANGE + * @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 +//#define VL6180X_EXTENDED_RANGE 0 #define EXTENDED_RANGE_50CM 0 //#define EXTENDED_RANGE_50CM 1 #if EXTENDED_RANGE_50CM -#define VL6180x_UPSCALE_SUPPORT -3 -#define VL6180x_EXTENDED_RANGE 1 +#define VL6180X_UPSCALE_SUPPORT -3 +#define VL6180X_EXTENDED_RANGE 1 #else -#define VL6180x_UPSCALE_SUPPORT -1 -#define VL6180x_EXTENDED_RANGE 0 +#define VL6180X_UPSCALE_SUPPORT -1 +#define VL6180X_EXTENDED_RANGE 0 #endif -#if (VL6180x_EXTENDED_RANGE) && (VL6180x_ALS_SUPPORT) +#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_ */ +/* VL6180X_CFG_H_ */