Kenji Arai / 6180XA1_simple

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

Dependents:   Check_VL6180XA1_ToF

Fork of X_NUCLEO_6180XA1 by ST

vl6180x_cfg.h@60:972b4898a007, 2018-02-01 (annotated)

Committer:
kenjiArai
Date:
Thu Feb 01 12:05:43 2018 +0000
Revision:
60:972b4898a007
Parent:
59:81afbb75311d 
more simple / delete DevI2C and others

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gallonm 1:1de1ea2994d9 1 /*******************************************************************************
gallonm 1:1de1ea2994d9 2 Copyright © 2014, STMicroelectronics International N.V.
gallonm 1:1de1ea2994d9 3 All rights reserved.
gallonm 1:1de1ea2994d9 4
gallonm 1:1de1ea2994d9 5 Redistribution and use in source and binary forms, with or without
gallonm 1:1de1ea2994d9 6 modification, are permitted provided that the following conditions are met:
gallonm 1:1de1ea2994d9 7 * Redistributions of source code must retain the above copyright
gallonm 1:1de1ea2994d9 8 notice, this list of conditions and the following disclaimer.
gallonm 1:1de1ea2994d9 9 * Redistributions in binary form must reproduce the above copyright
gallonm 1:1de1ea2994d9 10 notice, this list of conditions and the following disclaimer in the
gallonm 1:1de1ea2994d9 11 documentation and/or other materials provided with the distribution.
gallonm 1:1de1ea2994d9 12 * Neither the name of STMicroelectronics nor the
gallonm 1:1de1ea2994d9 13 names of its contributors may be used to endorse or promote products
gallonm 1:1de1ea2994d9 14 derived from this software without specific prior written permission.
gallonm 1:1de1ea2994d9 15
gallonm 1:1de1ea2994d9 16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
gallonm 1:1de1ea2994d9 17 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
gallonm 1:1de1ea2994d9 18 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
kenjiArai 60:972b4898a007 19 NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.
gallonm 1:1de1ea2994d9 20 IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY
gallonm 1:1de1ea2994d9 21 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
gallonm 1:1de1ea2994d9 22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
gallonm 1:1de1ea2994d9 23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
gallonm 1:1de1ea2994d9 24 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
gallonm 1:1de1ea2994d9 25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
gallonm 1:1de1ea2994d9 26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
gallonm 1:1de1ea2994d9 27 ********************************************************************************/
kenjiArai 60:972b4898a007 28
kenjiArai 60:972b4898a007 29 //------- Feburary 1st, 2018 by JH1PJL / K.Arai --------------------------------
kenjiArai 60:972b4898a007 30 // Change X_NUCLEO_6180XA1 library to 6180XA1_simplest library
kenjiArai 60:972b4898a007 31 // modified -> all related files
kenjiArai 60:972b4898a007 32 //------------------------------------------------------------------------------
kenjiArai 60:972b4898a007 33
gallonm 1:1de1ea2994d9 34 /*
gallonm 1:1de1ea2994d9 35 * $Date: 2015-01-08 14:35:34 +0100 (Thu, 08 Jan 2015) $
gallonm 1:1de1ea2994d9 36 * $Revision: 2042 $
gallonm 1:1de1ea2994d9 37 */
kenjiArai 60:972b4898a007 38
gallonm 1:1de1ea2994d9 39 /**
Davidroid 57:fa4c622b04a7 40 * @file VL6180X_cfg.h
gallonm 1:1de1ea2994d9 41 *
gallonm 1:1de1ea2994d9 42 * Proximity and ALS configuration
gallonm 1:1de1ea2994d9 43 */
gallonm 1:1de1ea2994d9 44
Davidroid 57:fa4c622b04a7 45 #ifndef VL6180X_CFG_H_
Davidroid 57:fa4c622b04a7 46 #define VL6180X_CFG_H_
gallonm 1:1de1ea2994d9 47
gallonm 1:1de1ea2994d9 48 /** @defgroup api_config Configuration
gallonm 1:1de1ea2994d9 49 * @brief API static configuration
gallonm 1:1de1ea2994d9 50 */
gallonm 1:1de1ea2994d9 51
gallonm 1:1de1ea2994d9 52
gallonm 1:1de1ea2994d9 53
gallonm 1:1de1ea2994d9 54 /** @ingroup api_config
gallonm 1:1de1ea2994d9 55 * @{*/
gallonm 1:1de1ea2994d9 56
gallonm 1:1de1ea2994d9 57
gallonm 1:1de1ea2994d9 58 /**
Davidroid 57:fa4c622b04a7 59 * @def VL6180X_UPSCALE_SUPPORT
gallonm 1:1de1ea2994d9 60 * @brief Configure up-scale capabilities and default up-scale factor for ranging operations
kenjiArai 60:972b4898a007 61 *
gallonm 1:1de1ea2994d9 62 * @li 1 : Fixed scaling by 1 (no up-scaling support)
gallonm 1:1de1ea2994d9 63 * @li 2 : Fixed scaling by 2
gallonm 1:1de1ea2994d9 64 * @li 3 : Fixed scaling by 3
Davidroid 57:fa4c622b04a7 65 * @li -1 -2 -3 : Run time programmable through @a VL6180X_UpscaleSetScaling(). Default scaling factore is -VL6180X_UPSCALE_SUPPORT \n
gallonm 1:1de1ea2994d9 66 */
Davidroid 57:fa4c622b04a7 67 //#define VL6180X_UPSCALE_SUPPORT -1
gallonm 1:1de1ea2994d9 68
gallonm 1:1de1ea2994d9 69 /**
Davidroid 57:fa4c622b04a7 70 * @def VL6180X_ALS_SUPPORT
gallonm 1:1de1ea2994d9 71 * @brief Enable ALS support
gallonm 1:1de1ea2994d9 72 *
gallonm 1:1de1ea2994d9 73 * Set to 0 if ALS is not used in application. This can help reducing code size if it is a concern.
gallonm 1:1de1ea2994d9 74 */
Davidroid 57:fa4c622b04a7 75 #define VL6180X_ALS_SUPPORT 1
gallonm 1:1de1ea2994d9 76
gallonm 1:1de1ea2994d9 77 /**
Davidroid 57:fa4c622b04a7 78 * @def VL6180X_HAVE_DMAX_RANGING
gallonm 1:1de1ea2994d9 79 * @brief Enable DMax calculation for ranging applications.
kenjiArai 60:972b4898a007 80 *
Davidroid 57:fa4c622b04a7 81 * When set to 1, __Dmax__ is returned by API typically when @a VL6180X_RangePollMeasurement() high level
Davidroid 57:fa4c622b04a7 82 * function is called (this is returned in @a VL6180X_RangeData_t structure).
kenjiArai 60:972b4898a007 83 * __Dmax__ is an estimation of the maximum distance (in mm) the product can report a valid distance of a 17% target for
gallonm 1:1de1ea2994d9 84 * the current ambient light conditions (__Dmax__ decreases when ambient light increases). __Dmax__ should be used only
gallonm 1:1de1ea2994d9 85 * when the product is not able to return a valid distance (no object or object is too far from the ranging sensor).
kenjiArai 60:972b4898a007 86 * Typically, this is done by checking the __errorStatus__ field of the @a VL6180X_RangeData_t structure returned by
Davidroid 57:fa4c622b04a7 87 * the @a VL6180X_RangePollMeasurement() function.
gallonm 1:1de1ea2994d9 88 * You may refer to ::RangeError_u to get full list of supported error codes.
kenjiArai 60:972b4898a007 89 * @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
gallonm 1:1de1ea2994d9 90 */
kenjiArai 60:972b4898a007 91 #define VL6180X_HAVE_DMAX_RANGING 0
gallonm 1:1de1ea2994d9 92
gallonm 1:1de1ea2994d9 93 /**
Davidroid 57:fa4c622b04a7 94 * @def VL6180X_EXTENDED_RANGE
gallonm 1:1de1ea2994d9 95 * @brief Enable extended ranging support
gallonm 1:1de1ea2994d9 96 *
gallonm 1:1de1ea2994d9 97 * Device that do not formally support extended ranging should only be used with a scaling factor of 1.
gallonm 1:1de1ea2994d9 98 * Correct operation with scaling factor other than 1 (>200mm ) is not granted by ST.
gallonm 1:1de1ea2994d9 99 */
kenjiArai 60:972b4898a007 100 #define VL6180X_EXTENDED_RANGE 0
gallonm 24:025afc3fe30f 101
mapellil 35:407b0b127eb8 102 #define EXTENDED_RANGE_50CM 0
Davidroid 57:fa4c622b04a7 103 #define VL6180X_UPSCALE_SUPPORT -1
Davidroid 57:fa4c622b04a7 104 #define VL6180X_EXTENDED_RANGE 0
gallonm 1:1de1ea2994d9 105
Davidroid 57:fa4c622b04a7 106 #if (VL6180X_EXTENDED_RANGE) && (VL6180X_ALS_SUPPORT)
gallonm 1:1de1ea2994d9 107 #warning "Als support should be OFF for extended range"
gallonm 1:1de1ea2994d9 108 #endif
gallonm 1:1de1ea2994d9 109
gallonm 1:1de1ea2994d9 110 #endif
gallonm 1:1de1ea2994d9 111 /** @} */ // end of api_config
gallonm 1:1de1ea2994d9 112
Davidroid 57:fa4c622b04a7 113 /* VL6180X_CFG_H_ */