Tarek Lule / VL53L0X_Condensed2

Greatly simplified Architecture, Identical Functions Removed: Platform Interfaces, STP6001 interface

VL53L0X_def.h@7:3a1115c2556b, 2019-06-20 (annotated)

Committer:
sepp_nepp
Date:
Thu Jun 20 12:54:25 2019 +0000
Revision:
7:3a1115c2556b
Parent:
6:fb11b746ceb5
Child:
8:2fd7cb217068
Removed all notions of device handle. The class is the device, and the device is the class. This is the base strategy of object oriented programming!; Then flattened the Device properties hierarchy. ; Removed Functions that are "not implemented".

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sepp_nepp 6:fb11b746ceb5 1 /*******************************************************************************
sepp_nepp 6:fb11b746ceb5 2 Copyright © 2016, STMicroelectronics International N.V.
sepp_nepp 6:fb11b746ceb5 3 All rights reserved.
sepp_nepp 6:fb11b746ceb5 4
sepp_nepp 6:fb11b746ceb5 5 Redistribution and use in source and binary forms, with or without
sepp_nepp 6:fb11b746ceb5 6 modification, are permitted provided that the following conditions are met:
sepp_nepp 6:fb11b746ceb5 7 * Redistributions of source code must retain the above copyright
sepp_nepp 6:fb11b746ceb5 8 notice, this list of conditions and the following disclaimer.
sepp_nepp 6:fb11b746ceb5 9 * Redistributions in binary form must reproduce the above copyright
sepp_nepp 6:fb11b746ceb5 10 notice, this list of conditions and the following disclaimer in the
sepp_nepp 6:fb11b746ceb5 11 documentation and/or other materials provided with the distribution.
sepp_nepp 6:fb11b746ceb5 12 * Neither the name of STMicroelectronics nor the
sepp_nepp 6:fb11b746ceb5 13 names of its contributors may be used to endorse or promote products
sepp_nepp 6:fb11b746ceb5 14 derived from this software without specific prior written permission.
sepp_nepp 6:fb11b746ceb5 15
sepp_nepp 6:fb11b746ceb5 16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
sepp_nepp 6:fb11b746ceb5 17 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
sepp_nepp 6:fb11b746ceb5 18 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
sepp_nepp 6:fb11b746ceb5 19 NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.
sepp_nepp 6:fb11b746ceb5 20 IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY
sepp_nepp 6:fb11b746ceb5 21 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
sepp_nepp 6:fb11b746ceb5 22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
sepp_nepp 6:fb11b746ceb5 23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
sepp_nepp 6:fb11b746ceb5 24 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
sepp_nepp 6:fb11b746ceb5 25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
sepp_nepp 6:fb11b746ceb5 26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
sepp_nepp 6:fb11b746ceb5 27 *******************************************************************************/
sepp_nepp 6:fb11b746ceb5 28
sepp_nepp 6:fb11b746ceb5 29 /**
sepp_nepp 6:fb11b746ceb5 30 * @file VL53L0X_def.h
sepp_nepp 6:fb11b746ceb5 31 *
sepp_nepp 6:fb11b746ceb5 32 * @brief Type definitions for VL53L0X API.
sepp_nepp 6:fb11b746ceb5 33 *
sepp_nepp 6:fb11b746ceb5 34 */
sepp_nepp 6:fb11b746ceb5 35
sepp_nepp 6:fb11b746ceb5 36
sepp_nepp 6:fb11b746ceb5 37 #ifndef _VL53L0X_DEF_H_
sepp_nepp 6:fb11b746ceb5 38 #define _VL53L0X_DEF_H_
sepp_nepp 6:fb11b746ceb5 39
sepp_nepp 6:fb11b746ceb5 40
sepp_nepp 6:fb11b746ceb5 41 #ifdef __cplusplus
sepp_nepp 6:fb11b746ceb5 42 extern "C" {
sepp_nepp 6:fb11b746ceb5 43 #endif
sepp_nepp 6:fb11b746ceb5 44
sepp_nepp 6:fb11b746ceb5 45 /** @defgroup VL53L0X_globaldefine_group VL53L0X Defines
sepp_nepp 6:fb11b746ceb5 46 * @brief VL53L0X Defines
sepp_nepp 6:fb11b746ceb5 47 * @{
sepp_nepp 6:fb11b746ceb5 48 */
sepp_nepp 6:fb11b746ceb5 49
sepp_nepp 6:fb11b746ceb5 50 /** PAL SPECIFICATION major version */
sepp_nepp 6:fb11b746ceb5 51 #define VL53L0X10_SPECIFICATION_VER_MAJOR 1
sepp_nepp 6:fb11b746ceb5 52 /** PAL SPECIFICATION minor version */
sepp_nepp 6:fb11b746ceb5 53 #define VL53L0X10_SPECIFICATION_VER_MINOR 2
sepp_nepp 6:fb11b746ceb5 54 /** PAL SPECIFICATION sub version */
sepp_nepp 6:fb11b746ceb5 55 #define VL53L0X10_SPECIFICATION_VER_SUB 7
sepp_nepp 6:fb11b746ceb5 56 /** PAL SPECIFICATION sub version */
sepp_nepp 6:fb11b746ceb5 57 #define VL53L0X10_SPECIFICATION_VER_REVISION 1440
sepp_nepp 6:fb11b746ceb5 58
sepp_nepp 6:fb11b746ceb5 59 /** VL53L0X PAL IMPLEMENTATION major version */
sepp_nepp 6:fb11b746ceb5 60 #define VL53L0X10_IMPLEMENTATION_VER_MAJOR 1
sepp_nepp 6:fb11b746ceb5 61 /** VL53L0X PAL IMPLEMENTATION minor version */
sepp_nepp 6:fb11b746ceb5 62 #define VL53L0X10_IMPLEMENTATION_VER_MINOR 0
sepp_nepp 6:fb11b746ceb5 63 /** VL53L0X PAL IMPLEMENTATION sub version */
sepp_nepp 6:fb11b746ceb5 64 #define VL53L0X10_IMPLEMENTATION_VER_SUB 9
sepp_nepp 6:fb11b746ceb5 65 /** VL53L0X PAL IMPLEMENTATION sub version */
sepp_nepp 6:fb11b746ceb5 66 #define VL53L0X10_IMPLEMENTATION_VER_REVISION 3673
sepp_nepp 6:fb11b746ceb5 67
sepp_nepp 6:fb11b746ceb5 68 /** PAL SPECIFICATION major version */
sepp_nepp 6:fb11b746ceb5 69 #define VL53L0X_SPECIFICATION_VER_MAJOR 1
sepp_nepp 6:fb11b746ceb5 70 /** PAL SPECIFICATION minor version */
sepp_nepp 6:fb11b746ceb5 71 #define VL53L0X_SPECIFICATION_VER_MINOR 2
sepp_nepp 6:fb11b746ceb5 72 /** PAL SPECIFICATION sub version */
sepp_nepp 6:fb11b746ceb5 73 #define VL53L0X_SPECIFICATION_VER_SUB 7
sepp_nepp 6:fb11b746ceb5 74 /** PAL SPECIFICATION sub version */
sepp_nepp 6:fb11b746ceb5 75 #define VL53L0X_SPECIFICATION_VER_REVISION 1440
sepp_nepp 6:fb11b746ceb5 76
sepp_nepp 6:fb11b746ceb5 77 /** VL53L0X PAL IMPLEMENTATION major version */
sepp_nepp 6:fb11b746ceb5 78 #define VL53L0X_IMPLEMENTATION_VER_MAJOR 1
sepp_nepp 6:fb11b746ceb5 79 /** VL53L0X PAL IMPLEMENTATION minor version */
sepp_nepp 6:fb11b746ceb5 80 #define VL53L0X_IMPLEMENTATION_VER_MINOR 1
sepp_nepp 6:fb11b746ceb5 81 /** VL53L0X PAL IMPLEMENTATION sub version */
sepp_nepp 6:fb11b746ceb5 82 #define VL53L0X_IMPLEMENTATION_VER_SUB 21
sepp_nepp 6:fb11b746ceb5 83 /** VL53L0X PAL IMPLEMENTATION sub version */
sepp_nepp 6:fb11b746ceb5 84 #define VL53L0X_IMPLEMENTATION_VER_REVISION 4823
sepp_nepp 6:fb11b746ceb5 85 #define VL53L0X_DEFAULT_MAX_LOOP 2000
sepp_nepp 6:fb11b746ceb5 86 #define VL53L0X_MAX_STRING_LENGTH 32
sepp_nepp 6:fb11b746ceb5 87
sepp_nepp 6:fb11b746ceb5 88
sepp_nepp 6:fb11b746ceb5 89 /** use where fractional values are expected
sepp_nepp 6:fb11b746ceb5 90 *
sepp_nepp 6:fb11b746ceb5 91 * Given a floating point value f it's .16 bit point is (int)(f*(1<<16))*/
sepp_nepp 6:fb11b746ceb5 92 typedef uint32_t FixPoint1616_t;
sepp_nepp 6:fb11b746ceb5 93
sepp_nepp 6:fb11b746ceb5 94 /* Speed of light in um per 1E-10 Seconds */
sepp_nepp 6:fb11b746ceb5 95 #define VL53L0X_SPEED_OF_LIGHT_IN_AIR 2997
sepp_nepp 6:fb11b746ceb5 96
sepp_nepp 6:fb11b746ceb5 97
sepp_nepp 6:fb11b746ceb5 98 /** @defgroup VL53L0X_DevSpecDefines_group VL53L0X cut1.1 Device Specific Defines
sepp_nepp 6:fb11b746ceb5 99 * @brief VL53L0X cut1.1 Device Specific Defines
sepp_nepp 6:fb11b746ceb5 100 * @{
sepp_nepp 6:fb11b746ceb5 101 */
sepp_nepp 6:fb11b746ceb5 102
sepp_nepp 6:fb11b746ceb5 103
sepp_nepp 6:fb11b746ceb5 104 /** @defgroup VL53L0X_DeviceError_group Device Error
sepp_nepp 6:fb11b746ceb5 105 * @brief Device Error code
sepp_nepp 6:fb11b746ceb5 106 *
sepp_nepp 6:fb11b746ceb5 107 * This enum is Device specific it should be updated in the implementation
sepp_nepp 6:fb11b746ceb5 108 * Use @a VL53L0X_GetStatusErrorString() to get the string.
sepp_nepp 6:fb11b746ceb5 109 * It is related to Status Register of the Device.
sepp_nepp 6:fb11b746ceb5 110 * @{
sepp_nepp 6:fb11b746ceb5 111 */
sepp_nepp 6:fb11b746ceb5 112 typedef uint8_t VL53L0X_DeviceError;
sepp_nepp 6:fb11b746ceb5 113
sepp_nepp 6:fb11b746ceb5 114 #define VL53L0X_DEVICEERROR_NONE ((VL53L0X_DeviceError) 0)
sepp_nepp 6:fb11b746ceb5 115 /*!< 0 NoError */
sepp_nepp 6:fb11b746ceb5 116 #define VL53L0X_DEVICEERROR_VCSELCONTINUITYTESTFAILURE ((VL53L0X_DeviceError) 1)
sepp_nepp 6:fb11b746ceb5 117 #define VL53L0X_DEVICEERROR_VCSELWATCHDOGTESTFAILURE ((VL53L0X_DeviceError) 2)
sepp_nepp 6:fb11b746ceb5 118 #define VL53L0X_DEVICEERROR_NOVHVVALUEFOUND ((VL53L0X_DeviceError) 3)
sepp_nepp 6:fb11b746ceb5 119 #define VL53L0X_DEVICEERROR_MSRCNOTARGET ((VL53L0X_DeviceError) 4)
sepp_nepp 6:fb11b746ceb5 120 #define VL53L0X_DEVICEERROR_SNRCHECK ((VL53L0X_DeviceError) 5)
sepp_nepp 6:fb11b746ceb5 121 #define VL53L0X_DEVICEERROR_RANGEPHASECHECK ((VL53L0X_DeviceError) 6)
sepp_nepp 6:fb11b746ceb5 122 #define VL53L0X_DEVICEERROR_SIGMATHRESHOLDCHECK ((VL53L0X_DeviceError) 7)
sepp_nepp 6:fb11b746ceb5 123 #define VL53L0X_DEVICEERROR_TCC ((VL53L0X_DeviceError) 8)
sepp_nepp 6:fb11b746ceb5 124 #define VL53L0X_DEVICEERROR_PHASECONSISTENCY ((VL53L0X_DeviceError) 9)
sepp_nepp 6:fb11b746ceb5 125 #define VL53L0X_DEVICEERROR_MINCLIP ((VL53L0X_DeviceError) 10)
sepp_nepp 6:fb11b746ceb5 126 #define VL53L0X_DEVICEERROR_RANGECOMPLETE ((VL53L0X_DeviceError) 11)
sepp_nepp 6:fb11b746ceb5 127 #define VL53L0X_DEVICEERROR_ALGOUNDERFLOW ((VL53L0X_DeviceError) 12)
sepp_nepp 6:fb11b746ceb5 128 #define VL53L0X_DEVICEERROR_ALGOOVERFLOW ((VL53L0X_DeviceError) 13)
sepp_nepp 6:fb11b746ceb5 129 #define VL53L0X_DEVICEERROR_RANGEIGNORETHRESHOLD ((VL53L0X_DeviceError) 14)
sepp_nepp 6:fb11b746ceb5 130
sepp_nepp 6:fb11b746ceb5 131 /** @} end of VL53L0X_DeviceError_group */
sepp_nepp 6:fb11b746ceb5 132
sepp_nepp 6:fb11b746ceb5 133
sepp_nepp 6:fb11b746ceb5 134 /* PAL ERROR strings */
sepp_nepp 6:fb11b746ceb5 135 #define VL53L0X_STRING_ERROR_NONE "No Error"
sepp_nepp 6:fb11b746ceb5 136 #define VL53L0X_STRING_ERROR_CALIBRATION_WARNING "Calibration Warning Error"
sepp_nepp 6:fb11b746ceb5 137 #define VL53L0X_STRING_ERROR_MIN_CLIPPED "Min clipped error"
sepp_nepp 6:fb11b746ceb5 138 #define VL53L0X_STRING_ERROR_UNDEFINED "Undefined error"
sepp_nepp 6:fb11b746ceb5 139 #define VL53L0X_STRING_ERROR_INVALID_PARAMS "Invalid parameters error"
sepp_nepp 6:fb11b746ceb5 140 #define VL53L0X_STRING_ERROR_NOT_SUPPORTED "Not supported error"
sepp_nepp 6:fb11b746ceb5 141 #define VL53L0X_STRING_ERROR_RANGE_ERROR "Range error"
sepp_nepp 6:fb11b746ceb5 142 #define VL53L0X_STRING_ERROR_TIME_OUT "Time out error"
sepp_nepp 6:fb11b746ceb5 143 #define VL53L0X_STRING_ERROR_MODE_NOT_SUPPORTED "Mode not supported error"
sepp_nepp 6:fb11b746ceb5 144 #define VL53L0X_STRING_ERROR_BUFFER_TOO_SMALL "Buffer too small"
sepp_nepp 6:fb11b746ceb5 145 #define VL53L0X_STRING_ERROR_GPIO_NOT_EXISTING "GPIO not existing"
sepp_nepp 6:fb11b746ceb5 146 #define VL53L0X_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED "GPIO funct not supported"
sepp_nepp 6:fb11b746ceb5 147 #define VL53L0X_STRING_ERROR_INTERRUPT_NOT_CLEARED "Interrupt not Cleared"
sepp_nepp 6:fb11b746ceb5 148 #define VL53L0X_STRING_ERROR_CONTROL_INTERFACE "Control Interface Error"
sepp_nepp 6:fb11b746ceb5 149 #define VL53L0X_STRING_ERROR_INVALID_COMMAND "Invalid Command Error"
sepp_nepp 6:fb11b746ceb5 150 #define VL53L0X_STRING_ERROR_DIVISION_BY_ZERO "Division by zero Error"
sepp_nepp 6:fb11b746ceb5 151 #define VL53L0X_STRING_ERROR_REF_SPAD_INIT "Reference Spad Init Error"
sepp_nepp 6:fb11b746ceb5 152 #define VL53L0X_STRING_ERROR_NOT_IMPLEMENTED "Not implemented error"
sepp_nepp 6:fb11b746ceb5 153 #define VL53L0X_STRING_UNKNOW_ERROR_CODE "Unknown Error Code"
sepp_nepp 6:fb11b746ceb5 154
sepp_nepp 6:fb11b746ceb5 155 /* Range Status */
sepp_nepp 6:fb11b746ceb5 156 #define VL53L0X_STRING_RANGESTATUS_NONE "No Update"
sepp_nepp 6:fb11b746ceb5 157 #define VL53L0X_STRING_RANGESTATUS_RANGEVALID "Range Valid"
sepp_nepp 6:fb11b746ceb5 158 #define VL53L0X_STRING_RANGESTATUS_SIGMA "Sigma Fail"
sepp_nepp 6:fb11b746ceb5 159 #define VL53L0X_STRING_RANGESTATUS_SIGNAL "Signal Fail"
sepp_nepp 6:fb11b746ceb5 160 #define VL53L0X_STRING_RANGESTATUS_MINRANGE "Min Range Fail"
sepp_nepp 6:fb11b746ceb5 161 #define VL53L0X_STRING_RANGESTATUS_PHASE "Phase Fail"
sepp_nepp 6:fb11b746ceb5 162 #define VL53L0X_STRING_RANGESTATUS_HW "Hardware Fail"
sepp_nepp 6:fb11b746ceb5 163
sepp_nepp 6:fb11b746ceb5 164 /* Range Status */
sepp_nepp 6:fb11b746ceb5 165 #define VL53L0X_STRING_STATE_POWERDOWN "POWERDOWN State"
sepp_nepp 6:fb11b746ceb5 166 #define VL53L0X_STRING_STATE_WAIT_STATICINIT "Wait for staticinit State"
sepp_nepp 6:fb11b746ceb5 167 #define VL53L0X_STRING_STATE_STANDBY "STANDBY State"
sepp_nepp 6:fb11b746ceb5 168 #define VL53L0X_STRING_STATE_IDLE "IDLE State"
sepp_nepp 6:fb11b746ceb5 169 #define VL53L0X_STRING_STATE_RUNNING "RUNNING State"
sepp_nepp 6:fb11b746ceb5 170 #define VL53L0X_STRING_STATE_UNKNOWN "UNKNOWN State"
sepp_nepp 6:fb11b746ceb5 171 #define VL53L0X_STRING_STATE_ERROR "ERROR State"
sepp_nepp 6:fb11b746ceb5 172
sepp_nepp 6:fb11b746ceb5 173 /* Device Specific */
sepp_nepp 6:fb11b746ceb5 174 #define VL53L0X_STRING_DEVICEERROR_NONE "No Update"
sepp_nepp 6:fb11b746ceb5 175 #define VL53L0X_STRING_DEVICEERROR_VCSELCONTINUITYTESTFAILURE "VCSEL Continuity Test Failure"
sepp_nepp 6:fb11b746ceb5 176 #define VL53L0X_STRING_DEVICEERROR_VCSELWATCHDOGTESTFAILURE "VCSEL Watchdog Test Failure"
sepp_nepp 6:fb11b746ceb5 177 #define VL53L0X_STRING_DEVICEERROR_NOVHVVALUEFOUND "No VHV Value found"
sepp_nepp 6:fb11b746ceb5 178 #define VL53L0X_STRING_DEVICEERROR_MSRCNOTARGET "MSRC No Target Error"
sepp_nepp 6:fb11b746ceb5 179 #define VL53L0X_STRING_DEVICEERROR_SNRCHECK "SNR Check Exit"
sepp_nepp 6:fb11b746ceb5 180 #define VL53L0X_STRING_DEVICEERROR_RANGEPHASECHECK "Range Phase Check Error"
sepp_nepp 6:fb11b746ceb5 181 #define VL53L0X_STRING_DEVICEERROR_SIGMATHRESHOLDCHECK "Sigma Threshold Check Error"
sepp_nepp 6:fb11b746ceb5 182 #define VL53L0X_STRING_DEVICEERROR_TCC "TCC Error"
sepp_nepp 6:fb11b746ceb5 183 #define VL53L0X_STRING_DEVICEERROR_PHASECONSISTENCY "Phase Consistency Error"
sepp_nepp 6:fb11b746ceb5 184 #define VL53L0X_STRING_DEVICEERROR_MINCLIP "Min Clip Error"
sepp_nepp 6:fb11b746ceb5 185 #define VL53L0X_STRING_DEVICEERROR_RANGECOMPLETE "Range Complete"
sepp_nepp 6:fb11b746ceb5 186 #define VL53L0X_STRING_DEVICEERROR_ALGOUNDERFLOW "Range Algo Underflow Error"
sepp_nepp 6:fb11b746ceb5 187 #define VL53L0X_STRING_DEVICEERROR_ALGOOVERFLOW "Range Algo Overlow Error"
sepp_nepp 6:fb11b746ceb5 188 #define VL53L0X_STRING_DEVICEERROR_RANGEIGNORETHRESHOLD "Range Ignore Threshold Error"
sepp_nepp 6:fb11b746ceb5 189 #define VL53L0X_STRING_DEVICEERROR_UNKNOWN "Unknown error code"
sepp_nepp 6:fb11b746ceb5 190
sepp_nepp 6:fb11b746ceb5 191 /* Check Enable */
sepp_nepp 6:fb11b746ceb5 192 #define VL53L0X_STRING_CHECKENABLE_SIGMA_FINAL_RANGE "SIGMA FINAL RANGE"
sepp_nepp 6:fb11b746ceb5 193 #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE "SIGNAL RATE FINAL RANGE"
sepp_nepp 6:fb11b746ceb5 194 #define VL53L0X_STRING_CHECKENABLE_SIGNAL_REF_CLIP "SIGNAL REF CLIP"
sepp_nepp 6:fb11b746ceb5 195 #define VL53L0X_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD "RANGE IGNORE THRESHOLD"
sepp_nepp 6:fb11b746ceb5 196 #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_MSRC "SIGNAL RATE MSRC"
sepp_nepp 6:fb11b746ceb5 197 #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_PRE_RANGE "SIGNAL RATE PRE RANGE"
sepp_nepp 6:fb11b746ceb5 198
sepp_nepp 6:fb11b746ceb5 199 /* Sequence Step */
sepp_nepp 6:fb11b746ceb5 200 #define VL53L0X_STRING_SEQUENCESTEP_TCC "TCC"
sepp_nepp 6:fb11b746ceb5 201 #define VL53L0X_STRING_SEQUENCESTEP_DSS "DSS"
sepp_nepp 6:fb11b746ceb5 202 #define VL53L0X_STRING_SEQUENCESTEP_MSRC "MSRC"
sepp_nepp 6:fb11b746ceb5 203 #define VL53L0X_STRING_SEQUENCESTEP_PRE_RANGE "PRE RANGE"
sepp_nepp 6:fb11b746ceb5 204 #define VL53L0X_STRING_SEQUENCESTEP_FINAL_RANGE "FINAL RANGE"
sepp_nepp 6:fb11b746ceb5 205
sepp_nepp 6:fb11b746ceb5 206
sepp_nepp 6:fb11b746ceb5 207 /** @defgroup VL53L0X_CheckEnable_group Check Enable list
sepp_nepp 6:fb11b746ceb5 208 * @brief Check Enable code
sepp_nepp 6:fb11b746ceb5 209 *
sepp_nepp 6:fb11b746ceb5 210 * Define used to specify the LimitCheckId.
sepp_nepp 6:fb11b746ceb5 211 * Use @a VL53L0X_GetLimitCheckInfo() to get the string.
sepp_nepp 6:fb11b746ceb5 212 * @{
sepp_nepp 6:fb11b746ceb5 213 */
sepp_nepp 6:fb11b746ceb5 214
sepp_nepp 6:fb11b746ceb5 215 #define VL53L0X_CHECKENABLE_SIGMA_FINAL_RANGE 0
sepp_nepp 6:fb11b746ceb5 216 #define VL53L0X_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE 1
sepp_nepp 6:fb11b746ceb5 217 #define VL53L0X_CHECKENABLE_SIGNAL_REF_CLIP 2
sepp_nepp 6:fb11b746ceb5 218 #define VL53L0X_CHECKENABLE_RANGE_IGNORE_THRESHOLD 3
sepp_nepp 6:fb11b746ceb5 219 #define VL53L0X_CHECKENABLE_SIGNAL_RATE_MSRC 4
sepp_nepp 6:fb11b746ceb5 220 #define VL53L0X_CHECKENABLE_SIGNAL_RATE_PRE_RANGE 5
sepp_nepp 6:fb11b746ceb5 221
sepp_nepp 6:fb11b746ceb5 222 #define VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS 6
sepp_nepp 6:fb11b746ceb5 223
sepp_nepp 6:fb11b746ceb5 224 /** @} end of VL53L0X_CheckEnable_group */
sepp_nepp 6:fb11b746ceb5 225
sepp_nepp 6:fb11b746ceb5 226
sepp_nepp 6:fb11b746ceb5 227 /** @defgroup VL53L0X_GpioFunctionality_group Gpio Functionality
sepp_nepp 6:fb11b746ceb5 228 * @brief Defines the different functionalities for the device GPIO(s)
sepp_nepp 6:fb11b746ceb5 229 * @{
sepp_nepp 6:fb11b746ceb5 230 */
sepp_nepp 6:fb11b746ceb5 231 typedef uint8_t VL53L0X_GpioFunctionality;
sepp_nepp 6:fb11b746ceb5 232
sepp_nepp 6:fb11b746ceb5 233 #define VL53L0X_GPIOFUNCTIONALITY_OFF \
sepp_nepp 6:fb11b746ceb5 234 ((VL53L0X_GpioFunctionality) 0) /*!< NO Interrupt */
sepp_nepp 6:fb11b746ceb5 235 #define VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_LOW \
sepp_nepp 6:fb11b746ceb5 236 ((VL53L0X_GpioFunctionality) 1) /*!< Level Low (value < thresh_low) */
sepp_nepp 6:fb11b746ceb5 237 #define VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_HIGH \
sepp_nepp 6:fb11b746ceb5 238 ((VL53L0X_GpioFunctionality) 2) /*!< Level High (value > thresh_high) */
sepp_nepp 6:fb11b746ceb5 239 #define VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_OUT \
sepp_nepp 6:fb11b746ceb5 240 ((VL53L0X_GpioFunctionality) 3)
sepp_nepp 6:fb11b746ceb5 241 /*!< Out Of Window (value < thresh_low OR value > thresh_high) */
sepp_nepp 6:fb11b746ceb5 242 #define VL53L0X_GPIOFUNCTIONALITY_NEW_MEASURE_READY \
sepp_nepp 6:fb11b746ceb5 243 ((VL53L0X_GpioFunctionality) 4) /*!< New Sample Ready */
sepp_nepp 6:fb11b746ceb5 244
sepp_nepp 6:fb11b746ceb5 245 /** @} end of VL53L0X_GpioFunctionality_group */
sepp_nepp 6:fb11b746ceb5 246
sepp_nepp 6:fb11b746ceb5 247
sepp_nepp 6:fb11b746ceb5 248 /* Device register map */
sepp_nepp 6:fb11b746ceb5 249 /** default device address */
sepp_nepp 6:fb11b746ceb5 250 #define VL53L0X_DEFAULT_ADDRESS 0x52 /* (8-bit) */
sepp_nepp 6:fb11b746ceb5 251
sepp_nepp 6:fb11b746ceb5 252 /** @defgroup VL53L0X_DefineRegisters_group Define Registers
sepp_nepp 6:fb11b746ceb5 253 * @brief List of all the defined registers
sepp_nepp 6:fb11b746ceb5 254 * @{
sepp_nepp 6:fb11b746ceb5 255 */
sepp_nepp 6:fb11b746ceb5 256 #define VL53L0X_REG_SYSRANGE_START 0x000
sepp_nepp 6:fb11b746ceb5 257 /** mask existing bit in #VL53L0X_REG_SYSRANGE_START*/
sepp_nepp 6:fb11b746ceb5 258 #define VL53L0X_REG_SYSRANGE_MODE_MASK 0x0F
sepp_nepp 6:fb11b746ceb5 259 /** bit 0 in #VL53L0X_REG_SYSRANGE_START write 1 toggle state in
sepp_nepp 6:fb11b746ceb5 260 * continuous mode and arm next shot in single shot mode */
sepp_nepp 6:fb11b746ceb5 261 #define VL53L0X_REG_SYSRANGE_MODE_START_STOP 0x01
sepp_nepp 6:fb11b746ceb5 262 /** bit 1 write 0 in #VL53L0X_REG_SYSRANGE_START set single shot mode */
sepp_nepp 6:fb11b746ceb5 263 #define VL53L0X_REG_SYSRANGE_MODE_SINGLESHOT 0x00
sepp_nepp 6:fb11b746ceb5 264 /** bit 1 write 1 in #VL53L0X_REG_SYSRANGE_START set back-to-back operation mode */
sepp_nepp 6:fb11b746ceb5 265 #define VL53L0X_REG_SYSRANGE_MODE_BACKTOBACK 0x02
sepp_nepp 6:fb11b746ceb5 266 /** bit 2 write 1 in #VL53L0X_REG_SYSRANGE_START set timed operation mode */
sepp_nepp 6:fb11b746ceb5 267 #define VL53L0X_REG_SYSRANGE_MODE_TIMED 0x04
sepp_nepp 6:fb11b746ceb5 268 /** bit 3 write 1 in #VL53L0X_REG_SYSRANGE_START set histogram operation mode */
sepp_nepp 6:fb11b746ceb5 269 #define VL53L0X_REG_SYSRANGE_MODE_HISTOGRAM 0x08
sepp_nepp 6:fb11b746ceb5 270
sepp_nepp 6:fb11b746ceb5 271
sepp_nepp 6:fb11b746ceb5 272 #define VL53L0X_REG_SYSTEM_THRESH_HIGH 0x000C
sepp_nepp 6:fb11b746ceb5 273 #define VL53L0X_REG_SYSTEM_THRESH_LOW 0x000E
sepp_nepp 6:fb11b746ceb5 274 #define VL53L0X_REG_SYSTEM_SEQUENCE_CONFIG 0x0001
sepp_nepp 6:fb11b746ceb5 275 #define VL53L0X_REG_SYSTEM_RANGE_CONFIG 0x0009
sepp_nepp 6:fb11b746ceb5 276 #define VL53L0X_REG_SYSTEM_INTERMEASUREMENT_PERIOD 0x0004
sepp_nepp 6:fb11b746ceb5 277 #define VL53L0X_REG_SYSTEM_INTERRUPT_CONFIG_GPIO 0x000A
sepp_nepp 6:fb11b746ceb5 278 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_DISABLED 0x00
sepp_nepp 6:fb11b746ceb5 279 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_LEVEL_LOW 0x01
sepp_nepp 6:fb11b746ceb5 280 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_LEVEL_HIGH 0x02
sepp_nepp 6:fb11b746ceb5 281 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_OUT_OF_WINDOW 0x03
sepp_nepp 6:fb11b746ceb5 282 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_NEW_SAMPLE_READY 0x04
sepp_nepp 6:fb11b746ceb5 283 #define VL53L0X_REG_GPIO_HV_MUX_ACTIVE_HIGH 0x0084
sepp_nepp 6:fb11b746ceb5 284 #define VL53L0X_REG_SYSTEM_INTERRUPT_CLEAR 0x000B
sepp_nepp 6:fb11b746ceb5 285
sepp_nepp 6:fb11b746ceb5 286 /* Result registers */
sepp_nepp 6:fb11b746ceb5 287 #define VL53L0X_REG_RESULT_INTERRUPT_STATUS 0x0013
sepp_nepp 6:fb11b746ceb5 288 #define VL53L0X_REG_RESULT_RANGE_STATUS 0x0014
sepp_nepp 6:fb11b746ceb5 289 #define VL53L0X_REG_RESULT_CORE_PAGE 1
sepp_nepp 6:fb11b746ceb5 290 #define VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN 0x00BC
sepp_nepp 6:fb11b746ceb5 291 #define VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN 0x00C0
sepp_nepp 6:fb11b746ceb5 292 #define VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF 0x00D0
sepp_nepp 6:fb11b746ceb5 293 #define VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_REF 0x00D4
sepp_nepp 6:fb11b746ceb5 294 #define VL53L0X_REG_RESULT_PEAK_SIGNAL_RATE_REF 0x00B6
sepp_nepp 6:fb11b746ceb5 295
sepp_nepp 6:fb11b746ceb5 296 /* Algo register */
sepp_nepp 6:fb11b746ceb5 297 #define VL53L0X_REG_ALGO_PART_TO_PART_RANGE_OFFSET_MM 0x0028
sepp_nepp 6:fb11b746ceb5 298 #define VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS 0x008a
sepp_nepp 6:fb11b746ceb5 299
sepp_nepp 6:fb11b746ceb5 300 /* Check Limit registers */
sepp_nepp 6:fb11b746ceb5 301 #define VL53L0X_REG_MSRC_CONFIG_CONTROL 0x0060
sepp_nepp 6:fb11b746ceb5 302 #define VL53L0X_REG_PRE_RANGE_CONFIG_MIN_SNR 0X0027
sepp_nepp 6:fb11b746ceb5 303 #define VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_LOW 0x0056
sepp_nepp 6:fb11b746ceb5 304 #define VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_HIGH 0x0057
sepp_nepp 6:fb11b746ceb5 305 #define VL53L0X_REG_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT 0x0064
sepp_nepp 6:fb11b746ceb5 306 #define VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_SNR 0X0067
sepp_nepp 6:fb11b746ceb5 307 #define VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_LOW 0x0047
sepp_nepp 6:fb11b746ceb5 308 #define VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH 0x0048
sepp_nepp 6:fb11b746ceb5 309 #define VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT 0x0044
sepp_nepp 6:fb11b746ceb5 310 #define VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_HI 0X0061
sepp_nepp 6:fb11b746ceb5 311 #define VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_LO 0X0062
sepp_nepp 6:fb11b746ceb5 312
sepp_nepp 6:fb11b746ceb5 313 /* PRE RANGE registers */
sepp_nepp 6:fb11b746ceb5 314 #define VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD 0x0050
sepp_nepp 6:fb11b746ceb5 315 #define VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI 0x0051
sepp_nepp 6:fb11b746ceb5 316 #define VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO 0x0052
sepp_nepp 6:fb11b746ceb5 317 #define VL53L0X_REG_SYSTEM_HISTOGRAM_BIN 0x0081
sepp_nepp 6:fb11b746ceb5 318 #define VL53L0X_REG_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT 0x0033
sepp_nepp 6:fb11b746ceb5 319 #define VL53L0X_REG_HISTOGRAM_CONFIG_READOUT_CTRL 0x0055
sepp_nepp 6:fb11b746ceb5 320 #define VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD 0x0070
sepp_nepp 6:fb11b746ceb5 321 #define VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI 0x0071
sepp_nepp 6:fb11b746ceb5 322 #define VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO 0x0072
sepp_nepp 6:fb11b746ceb5 323 #define VL53L0X_REG_CROSSTALK_COMPENSATION_PEAK_RATE_MCPS 0x0020
sepp_nepp 6:fb11b746ceb5 324 #define VL53L0X_REG_MSRC_CONFIG_TIMEOUT_MACROP 0x0046
sepp_nepp 6:fb11b746ceb5 325 #define VL53L0X_REG_SOFT_RESET_GO2_SOFT_RESET_N 0x00bf
sepp_nepp 6:fb11b746ceb5 326 #define VL53L0X_REG_IDENTIFICATION_MODEL_ID 0x00c0
sepp_nepp 6:fb11b746ceb5 327 #define VL53L0X_REG_IDENTIFICATION_REVISION_ID 0x00c2
sepp_nepp 6:fb11b746ceb5 328 #define VL53L0X_REG_OSC_CALIBRATE_VAL 0x00f8
sepp_nepp 6:fb11b746ceb5 329 #define VL53L0X_SIGMA_ESTIMATE_MAX_VALUE 65535
sepp_nepp 6:fb11b746ceb5 330 /* equivalent to a range sigma of 655.35mm */
sepp_nepp 6:fb11b746ceb5 331
sepp_nepp 6:fb11b746ceb5 332 #define VL53L0X_REG_GLOBAL_CONFIG_VCSEL_WIDTH 0x032
sepp_nepp 6:fb11b746ceb5 333 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_0 0x0B0
sepp_nepp 6:fb11b746ceb5 334 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_1 0x0B1
sepp_nepp 6:fb11b746ceb5 335 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_2 0x0B2
sepp_nepp 6:fb11b746ceb5 336 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_3 0x0B3
sepp_nepp 6:fb11b746ceb5 337 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_4 0x0B4
sepp_nepp 6:fb11b746ceb5 338 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_5 0x0B5
sepp_nepp 6:fb11b746ceb5 339 #define VL53L0X_REG_GLOBAL_CONFIG_REF_EN_START_SELECT 0xB6
sepp_nepp 6:fb11b746ceb5 340 #define VL53L0X_REG_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD 0x4E /* 0x14E */
sepp_nepp 6:fb11b746ceb5 341 #define VL53L0X_REG_DYNAMIC_SPAD_REF_EN_START_OFFSET 0x4F /* 0x14F */
sepp_nepp 6:fb11b746ceb5 342 #define VL53L0X_REG_POWER_MANAGEMENT_GO1_POWER_FORCE 0x80
sepp_nepp 6:fb11b746ceb5 343 #define VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV 0x0089
sepp_nepp 6:fb11b746ceb5 344 #define VL53L0X_REG_ALGO_PHASECAL_LIM 0x0030 /* 0x130 */
sepp_nepp 6:fb11b746ceb5 345 #define VL53L0X_REG_ALGO_PHASECAL_CONFIG_TIMEOUT 0x0030
sepp_nepp 6:fb11b746ceb5 346 /** @} VL53L0X_DefineRegisters_group */
sepp_nepp 6:fb11b746ceb5 347
sepp_nepp 6:fb11b746ceb5 348 /** @} VL53L0X_DevSpecDefines_group */
sepp_nepp 6:fb11b746ceb5 349
sepp_nepp 6:fb11b746ceb5 350 /****************************************
sepp_nepp 6:fb11b746ceb5 351 * PRIVATE define do not edit
sepp_nepp 6:fb11b746ceb5 352 ****************************************/
sepp_nepp 6:fb11b746ceb5 353
sepp_nepp 6:fb11b746ceb5 354 /** @brief Defines the parameters of the Get Version Functions
sepp_nepp 6:fb11b746ceb5 355 */
sepp_nepp 6:fb11b746ceb5 356 typedef struct {
sepp_nepp 6:fb11b746ceb5 357 uint32_t revision; /*!< revision number */
sepp_nepp 6:fb11b746ceb5 358 uint8_t major; /*!< major number */
sepp_nepp 6:fb11b746ceb5 359 uint8_t minor; /*!< minor number */
sepp_nepp 6:fb11b746ceb5 360 uint8_t build; /*!< build number */
sepp_nepp 6:fb11b746ceb5 361 } VL53L0X_Version_t;
sepp_nepp 6:fb11b746ceb5 362
sepp_nepp 6:fb11b746ceb5 363
sepp_nepp 6:fb11b746ceb5 364 /** @brief Defines the parameters of the Get Device Info Functions
sepp_nepp 6:fb11b746ceb5 365 */
sepp_nepp 6:fb11b746ceb5 366 typedef struct {
sepp_nepp 6:fb11b746ceb5 367 char Name[VL53L0X_MAX_STRING_LENGTH];
sepp_nepp 6:fb11b746ceb5 368 /*!< Name of the Device e.g. Left_Distance */
sepp_nepp 6:fb11b746ceb5 369 char Type[VL53L0X_MAX_STRING_LENGTH];
sepp_nepp 6:fb11b746ceb5 370 /*!< Type of the Device e.g VL53L0X */
sepp_nepp 6:fb11b746ceb5 371 char ProductId[VL53L0X_MAX_STRING_LENGTH];
sepp_nepp 6:fb11b746ceb5 372 /*!< Product Identifier String */
sepp_nepp 6:fb11b746ceb5 373 uint8_t ProductType;
sepp_nepp 6:fb11b746ceb5 374 /*!< Product Type, VL53L0X = 1, VL53L1 = 2 */
sepp_nepp 6:fb11b746ceb5 375 uint8_t ProductRevisionMajor;
sepp_nepp 6:fb11b746ceb5 376 /*!< Product revision major */
sepp_nepp 6:fb11b746ceb5 377 uint8_t ProductRevisionMinor;
sepp_nepp 6:fb11b746ceb5 378 /*!< Product revision minor */
sepp_nepp 6:fb11b746ceb5 379 } VL53L0X_DeviceInfo_t;
sepp_nepp 6:fb11b746ceb5 380
sepp_nepp 6:fb11b746ceb5 381
sepp_nepp 6:fb11b746ceb5 382 /** @defgroup VL53L0X_define_Error_group Error and Warning code returned by API
sepp_nepp 6:fb11b746ceb5 383 * The following DEFINE are used to identify the PAL ERROR
sepp_nepp 6:fb11b746ceb5 384 * @{ */
sepp_nepp 6:fb11b746ceb5 385 typedef int8_t VL53L0X_Error;
sepp_nepp 6:fb11b746ceb5 386
sepp_nepp 6:fb11b746ceb5 387 #define VL53L0X_ERROR_NONE ((VL53L0X_Error) 0)
sepp_nepp 6:fb11b746ceb5 388 #define VL53L0X_ERROR_CALIBRATION_WARNING ((VL53L0X_Error) -1)
sepp_nepp 6:fb11b746ceb5 389 /*!< Warning invalid calibration data may be in used
sepp_nepp 6:fb11b746ceb5 390 \a VL53L0X_InitData()
sepp_nepp 6:fb11b746ceb5 391 \a VL53L0X_GetOffsetCalibrationData
sepp_nepp 6:fb11b746ceb5 392 \a VL53L0X_SetOffsetCalibrationData */
sepp_nepp 6:fb11b746ceb5 393 #define VL53L0X_ERROR_MIN_CLIPPED ((VL53L0X_Error) -2)
sepp_nepp 6:fb11b746ceb5 394 /*!< Warning parameter passed was clipped to min before to be applied */
sepp_nepp 6:fb11b746ceb5 395 #define VL53L0X_ERROR_UNDEFINED ((VL53L0X_Error) -3)
sepp_nepp 6:fb11b746ceb5 396 /*!< Unqualified error */
sepp_nepp 6:fb11b746ceb5 397 #define VL53L0X_ERROR_INVALID_PARAMS ((VL53L0X_Error) -4)
sepp_nepp 6:fb11b746ceb5 398 /*!< Parameter passed is invalid or out of range */
sepp_nepp 6:fb11b746ceb5 399 #define VL53L0X_ERROR_NOT_SUPPORTED ((VL53L0X_Error) -5)
sepp_nepp 6:fb11b746ceb5 400 /*!< Function is not supported in current mode or configuration */
sepp_nepp 6:fb11b746ceb5 401 #define VL53L0X_ERROR_RANGE_ERROR ((VL53L0X_Error) -6)
sepp_nepp 6:fb11b746ceb5 402 /*!< Device report a ranging error interrupt status */
sepp_nepp 6:fb11b746ceb5 403 #define VL53L0X_ERROR_TIME_OUT ((VL53L0X_Error) -7)
sepp_nepp 6:fb11b746ceb5 404 /*!< Aborted due to time out */
sepp_nepp 6:fb11b746ceb5 405 #define VL53L0X_ERROR_MODE_NOT_SUPPORTED ((VL53L0X_Error) -8)
sepp_nepp 6:fb11b746ceb5 406 /*!< Asked mode is not supported by the device */
sepp_nepp 6:fb11b746ceb5 407 #define VL53L0X_ERROR_BUFFER_TOO_SMALL ((VL53L0X_Error) -9)
sepp_nepp 6:fb11b746ceb5 408 /*!< ... */
sepp_nepp 6:fb11b746ceb5 409 #define VL53L0X_ERROR_GPIO_NOT_EXISTING ((VL53L0X_Error) -10)
sepp_nepp 6:fb11b746ceb5 410 /*!< User tried to setup a non-existing GPIO pin */
sepp_nepp 6:fb11b746ceb5 411 #define VL53L0X_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED ((VL53L0X_Error) -11)
sepp_nepp 6:fb11b746ceb5 412 /*!< unsupported GPIO functionality */
sepp_nepp 6:fb11b746ceb5 413 #define VL53L0X_ERROR_INTERRUPT_NOT_CLEARED ((VL53L0X_Error) -12)
sepp_nepp 6:fb11b746ceb5 414 /*!< Error during interrupt clear */
sepp_nepp 6:fb11b746ceb5 415 #define VL53L0X_ERROR_CONTROL_INTERFACE ((VL53L0X_Error) -20)
sepp_nepp 6:fb11b746ceb5 416 /*!< error reported from IO functions */
sepp_nepp 6:fb11b746ceb5 417 #define VL53L0X_ERROR_INVALID_COMMAND ((VL53L0X_Error) -30)
sepp_nepp 6:fb11b746ceb5 418 /*!< The command is not allowed in the current device state
sepp_nepp 6:fb11b746ceb5 419 * (power down) */
sepp_nepp 6:fb11b746ceb5 420 #define VL53L0X_ERROR_DIVISION_BY_ZERO ((VL53L0X_Error) -40)
sepp_nepp 6:fb11b746ceb5 421 /*!< In the function a division by zero occurs */
sepp_nepp 6:fb11b746ceb5 422 #define VL53L0X_ERROR_REF_SPAD_INIT ((VL53L0X_Error) -50)
sepp_nepp 6:fb11b746ceb5 423 /*!< Error during reference SPAD initialization */
sepp_nepp 6:fb11b746ceb5 424 #define VL53L0X_ERROR_NOT_IMPLEMENTED ((VL53L0X_Error) -99)
sepp_nepp 6:fb11b746ceb5 425 /*!< Tells requested functionality has not been implemented yet or
sepp_nepp 6:fb11b746ceb5 426 * not compatible with the device */
sepp_nepp 6:fb11b746ceb5 427 /** @} VL53L0X_define_Error_group */
sepp_nepp 6:fb11b746ceb5 428
sepp_nepp 6:fb11b746ceb5 429
sepp_nepp 6:fb11b746ceb5 430 /** @defgroup VL53L0X_define_DeviceModes_group Defines Device modes
sepp_nepp 6:fb11b746ceb5 431 * Defines all possible modes for the device
sepp_nepp 6:fb11b746ceb5 432 * @{
sepp_nepp 6:fb11b746ceb5 433 */
sepp_nepp 6:fb11b746ceb5 434 typedef uint8_t VL53L0X_DeviceModes;
sepp_nepp 6:fb11b746ceb5 435
sepp_nepp 6:fb11b746ceb5 436 #define VL53L0X_DEVICEMODE_SINGLE_RANGING ((VL53L0X_DeviceModes) 0)
sepp_nepp 6:fb11b746ceb5 437 #define VL53L0X_DEVICEMODE_CONTINUOUS_RANGING ((VL53L0X_DeviceModes) 1)
sepp_nepp 6:fb11b746ceb5 438 #define VL53L0X_DEVICEMODE_SINGLE_HISTOGRAM ((VL53L0X_DeviceModes) 2)
sepp_nepp 6:fb11b746ceb5 439 #define VL53L0X_DEVICEMODE_CONTINUOUS_TIMED_RANGING ((VL53L0X_DeviceModes) 3)
sepp_nepp 6:fb11b746ceb5 440 #define VL53L0X_DEVICEMODE_SINGLE_ALS ((VL53L0X_DeviceModes) 10)
sepp_nepp 6:fb11b746ceb5 441 #define VL53L0X_DEVICEMODE_GPIO_DRIVE ((VL53L0X_DeviceModes) 20)
sepp_nepp 6:fb11b746ceb5 442 #define VL53L0X_DEVICEMODE_GPIO_OSC ((VL53L0X_DeviceModes) 21)
sepp_nepp 6:fb11b746ceb5 443 /* ... Modes to be added depending on device */
sepp_nepp 6:fb11b746ceb5 444 /** @} VL53L0X_define_DeviceModes_group */
sepp_nepp 6:fb11b746ceb5 445
sepp_nepp 6:fb11b746ceb5 446
sepp_nepp 6:fb11b746ceb5 447
sepp_nepp 6:fb11b746ceb5 448 /** @defgroup VL53L0X_define_HistogramModes_group Defines Histogram modes
sepp_nepp 6:fb11b746ceb5 449 * Defines all possible Histogram modes for the device
sepp_nepp 6:fb11b746ceb5 450 * @{
sepp_nepp 6:fb11b746ceb5 451 */
sepp_nepp 6:fb11b746ceb5 452 typedef uint8_t VL53L0X_HistogramModes;
sepp_nepp 6:fb11b746ceb5 453
sepp_nepp 6:fb11b746ceb5 454 #define VL53L0X_HISTOGRAMMODE_DISABLED ((VL53L0X_HistogramModes) 0)
sepp_nepp 6:fb11b746ceb5 455 /*!< Histogram Disabled */
sepp_nepp 6:fb11b746ceb5 456 #define VL53L0X_HISTOGRAMMODE_REFERENCE_ONLY ((VL53L0X_HistogramModes) 1)
sepp_nepp 6:fb11b746ceb5 457 /*!< Histogram Reference array only */
sepp_nepp 6:fb11b746ceb5 458 #define VL53L0X_HISTOGRAMMODE_RETURN_ONLY ((VL53L0X_HistogramModes) 2)
sepp_nepp 6:fb11b746ceb5 459 /*!< Histogram Return array only */
sepp_nepp 6:fb11b746ceb5 460 #define VL53L0X_HISTOGRAMMODE_BOTH ((VL53L0X_HistogramModes) 3)
sepp_nepp 6:fb11b746ceb5 461 /*!< Histogram both Reference and Return Arrays */
sepp_nepp 6:fb11b746ceb5 462 /* ... Modes to be added depending on device */
sepp_nepp 6:fb11b746ceb5 463 /** @} VL53L0X_define_HistogramModes_group */
sepp_nepp 6:fb11b746ceb5 464
sepp_nepp 6:fb11b746ceb5 465
sepp_nepp 6:fb11b746ceb5 466 /** @defgroup VL53L0X_define_PowerModes_group List of available Power Modes
sepp_nepp 6:fb11b746ceb5 467 * List of available Power Modes
sepp_nepp 6:fb11b746ceb5 468 * @{
sepp_nepp 6:fb11b746ceb5 469 */
sepp_nepp 6:fb11b746ceb5 470
sepp_nepp 6:fb11b746ceb5 471 typedef uint8_t VL53L0X_PowerModes;
sepp_nepp 6:fb11b746ceb5 472 #define VL53L0X_POWERMODE_STANDBY_LEVEL1 ((VL53L0X_PowerModes) 0)
sepp_nepp 6:fb11b746ceb5 473 /*!< Standby level 1 */
sepp_nepp 6:fb11b746ceb5 474 #define VL53L0X_POWERMODE_STANDBY_LEVEL2 ((VL53L0X_PowerModes) 1)
sepp_nepp 6:fb11b746ceb5 475 /*!< Standby level 2 */
sepp_nepp 6:fb11b746ceb5 476 #define VL53L0X_POWERMODE_IDLE_LEVEL1 ((VL53L0X_PowerModes) 2)
sepp_nepp 6:fb11b746ceb5 477 /*!< Idle level 1 */
sepp_nepp 6:fb11b746ceb5 478 #define VL53L0X_POWERMODE_IDLE_LEVEL2 ((VL53L0X_PowerModes) 3)
sepp_nepp 6:fb11b746ceb5 479 /*!< Idle level 2 */
sepp_nepp 6:fb11b746ceb5 480
sepp_nepp 6:fb11b746ceb5 481 /** @} VL53L0X_define_PowerModes_group */
sepp_nepp 6:fb11b746ceb5 482
sepp_nepp 6:fb11b746ceb5 483
sepp_nepp 6:fb11b746ceb5 484 /** @brief Defines all parameters for the device
sepp_nepp 6:fb11b746ceb5 485 */
sepp_nepp 6:fb11b746ceb5 486 typedef struct {
sepp_nepp 6:fb11b746ceb5 487 VL53L0X_DeviceModes DeviceMode;
sepp_nepp 6:fb11b746ceb5 488 /*!< Defines type of measurement to be done for the next measure */
sepp_nepp 6:fb11b746ceb5 489 VL53L0X_HistogramModes HistogramMode;
sepp_nepp 6:fb11b746ceb5 490 /*!< Defines type of histogram measurement to be done for the next
sepp_nepp 6:fb11b746ceb5 491 * measure */
sepp_nepp 6:fb11b746ceb5 492 uint32_t MeasurementTimingBudgetMicroSeconds;
sepp_nepp 6:fb11b746ceb5 493 /*!< Defines the allowed total time for a single measurement */
sepp_nepp 6:fb11b746ceb5 494 uint32_t InterMeasurementPeriodMilliSeconds;
sepp_nepp 6:fb11b746ceb5 495 /*!< Defines time between two consecutive measurements (between two
sepp_nepp 6:fb11b746ceb5 496 * measurement starts). If set to 0 means back-to-back mode */
sepp_nepp 6:fb11b746ceb5 497 uint8_t XTalkCompensationEnable;
sepp_nepp 6:fb11b746ceb5 498 /*!< Tells if Crosstalk compensation shall be enable or not */
sepp_nepp 6:fb11b746ceb5 499 uint16_t XTalkCompensationRangeMilliMeter;
sepp_nepp 6:fb11b746ceb5 500 /*!< CrossTalk compensation range in millimeter */
sepp_nepp 6:fb11b746ceb5 501 FixPoint1616_t XTalkCompensationRateMegaCps;
sepp_nepp 6:fb11b746ceb5 502 /*!< CrossTalk compensation rate in Mega counts per seconds.
sepp_nepp 6:fb11b746ceb5 503 * Expressed in 16.16 fixed point format. */
sepp_nepp 6:fb11b746ceb5 504 int32_t RangeOffsetMicroMeters;
sepp_nepp 6:fb11b746ceb5 505 /*!< Range offset adjustment (mm). */
sepp_nepp 6:fb11b746ceb5 506
sepp_nepp 6:fb11b746ceb5 507 uint8_t LimitChecksEnable[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
sepp_nepp 6:fb11b746ceb5 508 /*!< This Array store all the Limit Check enable for this device. */
sepp_nepp 6:fb11b746ceb5 509 uint8_t LimitChecksStatus[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
sepp_nepp 6:fb11b746ceb5 510 /*!< This Array store all the Status of the check linked to last
sepp_nepp 6:fb11b746ceb5 511 * measurement. */
sepp_nepp 6:fb11b746ceb5 512 FixPoint1616_t LimitChecksValue[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
sepp_nepp 6:fb11b746ceb5 513 /*!< This Array store all the Limit Check value for this device */
sepp_nepp 6:fb11b746ceb5 514
sepp_nepp 6:fb11b746ceb5 515 uint8_t WrapAroundCheckEnable;
sepp_nepp 6:fb11b746ceb5 516 /*!< Tells if Wrap Around Check shall be enable or not */
sepp_nepp 6:fb11b746ceb5 517 } VL53L0X_DeviceParameters_t;
sepp_nepp 6:fb11b746ceb5 518
sepp_nepp 6:fb11b746ceb5 519
sepp_nepp 6:fb11b746ceb5 520 /** @defgroup VL53L0X_define_State_group Defines the current status of the device
sepp_nepp 6:fb11b746ceb5 521 * Defines the current status of the device
sepp_nepp 6:fb11b746ceb5 522 * @{
sepp_nepp 6:fb11b746ceb5 523 */
sepp_nepp 6:fb11b746ceb5 524
sepp_nepp 6:fb11b746ceb5 525 typedef uint8_t VL53L0X_State;
sepp_nepp 6:fb11b746ceb5 526
sepp_nepp 6:fb11b746ceb5 527 #define VL53L0X_STATE_POWERDOWN ((VL53L0X_State) 0)
sepp_nepp 6:fb11b746ceb5 528 /*!< Device is in HW reset */
sepp_nepp 6:fb11b746ceb5 529 #define VL53L0X_STATE_WAIT_STATICINIT ((VL53L0X_State) 1)
sepp_nepp 6:fb11b746ceb5 530 /*!< Device is initialized and wait for static initialization */
sepp_nepp 6:fb11b746ceb5 531 #define VL53L0X_STATE_STANDBY ((VL53L0X_State) 2)
sepp_nepp 6:fb11b746ceb5 532 /*!< Device is in Low power Standby mode */
sepp_nepp 6:fb11b746ceb5 533 #define VL53L0X_STATE_IDLE ((VL53L0X_State) 3)
sepp_nepp 6:fb11b746ceb5 534 /*!< Device has been initialized and ready to do measurements */
sepp_nepp 6:fb11b746ceb5 535 #define VL53L0X_STATE_RUNNING ((VL53L0X_State) 4)
sepp_nepp 6:fb11b746ceb5 536 /*!< Device is performing measurement */
sepp_nepp 6:fb11b746ceb5 537 #define VL53L0X_STATE_UNKNOWN ((VL53L0X_State) 98)
sepp_nepp 6:fb11b746ceb5 538 /*!< Device is in unknown state and need to be rebooted */
sepp_nepp 6:fb11b746ceb5 539 #define VL53L0X_STATE_ERROR ((VL53L0X_State) 99)
sepp_nepp 6:fb11b746ceb5 540 /*!< Device is in error state and need to be rebooted */
sepp_nepp 6:fb11b746ceb5 541
sepp_nepp 6:fb11b746ceb5 542 /** @} VL53L0X_define_State_group */
sepp_nepp 6:fb11b746ceb5 543
sepp_nepp 6:fb11b746ceb5 544
sepp_nepp 6:fb11b746ceb5 545 /**
sepp_nepp 6:fb11b746ceb5 546 * @struct VL53L0X_RangeData_t
sepp_nepp 6:fb11b746ceb5 547 * @brief Range measurement data.
sepp_nepp 6:fb11b746ceb5 548 */
sepp_nepp 6:fb11b746ceb5 549 typedef struct {
sepp_nepp 6:fb11b746ceb5 550 uint16_t RangeMilliMeter; /*!< range distance in millimeter. */
sepp_nepp 6:fb11b746ceb5 551 uint16_t RangeDMaxMilliMeter; /*!< Tells what is the maximum detection distance of the device
sepp_nepp 6:fb11b746ceb5 552 * in current setup and environment conditions (Filled when applicable) */
sepp_nepp 6:fb11b746ceb5 553 FixPoint1616_t SignalRateRtnMegaCps; /*!< Return signal rate (MCPS)\n these is a 16.16 fix point
sepp_nepp 6:fb11b746ceb5 554 * value, which is effectively a measure of target reflectance.*/
sepp_nepp 6:fb11b746ceb5 555 FixPoint1616_t AmbientRateRtnMegaCps;
sepp_nepp 6:fb11b746ceb5 556 /*!< Return ambient rate (MCPS)\n these is a 16.16 fix point value,
sepp_nepp 6:fb11b746ceb5 557 which is effectively a measure of the ambient light.*/
sepp_nepp 6:fb11b746ceb5 558 uint16_t EffectiveSpadRtnCount; /*!< Return the effective SPAD count for the return signal.
sepp_nepp 6:fb11b746ceb5 559 * To obtain Real value it should be divided by 256 */
sepp_nepp 6:fb11b746ceb5 560 uint8_t RangeFractionalPart;
sepp_nepp 6:fb11b746ceb5 561 /*!< Fractional part of range distance. Final value is a FixPoint168 value.; only noise :( */
sepp_nepp 6:fb11b746ceb5 562 uint8_t RangeStatus; /*!< Range Status for the current measurement. This is device
sepp_nepp 6:fb11b746ceb5 563 * dependent. Value = 0 means value is valid. See \ref RangeStatusPage */
sepp_nepp 6:fb11b746ceb5 564 } VL53L0X_RangingMeasurementData_t;
sepp_nepp 6:fb11b746ceb5 565
sepp_nepp 6:fb11b746ceb5 566
sepp_nepp 6:fb11b746ceb5 567 #define VL53L0X_HISTOGRAM_BUFFER_SIZE 24
sepp_nepp 6:fb11b746ceb5 568
sepp_nepp 6:fb11b746ceb5 569 /**
sepp_nepp 6:fb11b746ceb5 570 * @struct VL53L0X_HistogramData_t
sepp_nepp 6:fb11b746ceb5 571 * @brief Histogram measurement data.
sepp_nepp 6:fb11b746ceb5 572 */
sepp_nepp 6:fb11b746ceb5 573 typedef struct {
sepp_nepp 6:fb11b746ceb5 574 /* Histogram Measurement data */
sepp_nepp 6:fb11b746ceb5 575 uint32_t HistogramData[VL53L0X_HISTOGRAM_BUFFER_SIZE];/*!< Histogram data */
sepp_nepp 6:fb11b746ceb5 576 uint8_t HistogramType; /*!< Indicate the types of histogram data :Return only, Reference only, both Return and Reference */
sepp_nepp 6:fb11b746ceb5 577 uint8_t FirstBin; /*!< First Bin value */
sepp_nepp 6:fb11b746ceb5 578 uint8_t BufferSize; /*!< Buffer Size - Set by the user.*/
sepp_nepp 6:fb11b746ceb5 579 uint8_t NumberOfBins; /*!< Number of bins filled by the histogram measurement */
sepp_nepp 6:fb11b746ceb5 580 VL53L0X_DeviceError ErrorStatus; /*!< Error status of the current measurement. \n
sepp_nepp 6:fb11b746ceb5 581 see @a ::VL53L0X_DeviceError @a VL53L0X_GetStatusErrorString() */
sepp_nepp 6:fb11b746ceb5 582 } VL53L0X_HistogramMeasurementData_t;
sepp_nepp 6:fb11b746ceb5 583
sepp_nepp 6:fb11b746ceb5 584 #define VL53L0X_REF_SPAD_BUFFER_SIZE 6
sepp_nepp 6:fb11b746ceb5 585
sepp_nepp 6:fb11b746ceb5 586 /** @struct VL53L0X_SpadData_t
sepp_nepp 6:fb11b746ceb5 587 * @brief Spad Configuration Data. */
sepp_nepp 6:fb11b746ceb5 588 typedef struct {
sepp_nepp 6:fb11b746ceb5 589 uint8_t RefSpadEnables[VL53L0X_REF_SPAD_BUFFER_SIZE];
sepp_nepp 6:fb11b746ceb5 590 /*!< Reference Spad Enables */
sepp_nepp 6:fb11b746ceb5 591 uint8_t RefGoodSpadMap[VL53L0X_REF_SPAD_BUFFER_SIZE];
sepp_nepp 6:fb11b746ceb5 592 /*!< Reference Spad Good Spad Map */
sepp_nepp 6:fb11b746ceb5 593 } VL53L0X_SpadData_t;
sepp_nepp 6:fb11b746ceb5 594
sepp_nepp 6:fb11b746ceb5 595 /**
sepp_nepp 6:fb11b746ceb5 596 * @struct VL53L0X_DevData_t
sepp_nepp 6:fb11b746ceb5 597 *
sepp_nepp 6:fb11b746ceb5 598 * @brief VL53L0X PAL device ST private data structure \n
sepp_nepp 6:fb11b746ceb5 599 * End user should never access any of these field directly
sepp_nepp 6:fb11b746ceb5 600 *
sepp_nepp 6:fb11b746ceb5 601 * These must never access directly but only via macro
sepp_nepp 6:fb11b746ceb5 602 */
sepp_nepp 6:fb11b746ceb5 603 typedef struct {
sepp_nepp 6:fb11b746ceb5 604 // merged in here all parts of "VL53L0X_DeviceSpecificParameters_t DeviceSpecificParameters;"
sepp_nepp 6:fb11b746ceb5 605 FixPoint1616_t OscFrequencyMHz; /* Frequency used */
sepp_nepp 6:fb11b746ceb5 606 uint16_t LastEncodedTimeout; /* last encoded Time out used for timing budget*/
sepp_nepp 6:fb11b746ceb5 607 VL53L0X_GpioFunctionality Pin0GpioFunctionality; /* store the functionality of the GPIO: pin0 */
sepp_nepp 6:fb11b746ceb5 608 uint32_t FinalRangeTimeoutMicroSecs;/*!< Execution time of the final range*/
sepp_nepp 6:fb11b746ceb5 609 uint8_t FinalRangeVcselPulsePeriod; /*!< Vcsel pulse period (pll clocks) for the final range measurement*/
sepp_nepp 6:fb11b746ceb5 610 uint32_t PreRangeTimeoutMicroSecs; /*!< Execution time of the final range*/
sepp_nepp 6:fb11b746ceb5 611 uint8_t PreRangeVcselPulsePeriod; /*!< Vcsel pulse period (pll clocks) for the pre-range measurement*/
sepp_nepp 6:fb11b746ceb5 612 uint8_t ReadDataFromDeviceDone; /* Indicate if read from device has been done (==1) or not (==0) */
sepp_nepp 6:fb11b746ceb5 613 uint8_t ModuleId; /* Module ID */
sepp_nepp 6:fb11b746ceb5 614 uint8_t Revision; /* test Revision */
sepp_nepp 6:fb11b746ceb5 615 char ProductId[VL53L0X_MAX_STRING_LENGTH]; /* Product Identifier String */
sepp_nepp 6:fb11b746ceb5 616 uint8_t ReferenceSpadCount; /* used for ref spad management */
sepp_nepp 6:fb11b746ceb5 617 uint8_t ReferenceSpadType; /* used for ref spad management */
sepp_nepp 6:fb11b746ceb5 618 uint8_t RefSpadsInitialised; /* reports if ref spads are initialised. */
sepp_nepp 6:fb11b746ceb5 619 uint32_t PartUIDUpper; /*!< Unique Part ID Upper */
sepp_nepp 6:fb11b746ceb5 620 uint32_t PartUIDLower; /*!< Unique Part ID Lower */
sepp_nepp 6:fb11b746ceb5 621 FixPoint1616_t SignalRateMeasFixed400mm; /*!< Peek Signal rate at 400 mm*/
sepp_nepp 6:fb11b746ceb5 622
sepp_nepp 6:fb11b746ceb5 623 int32_t Part2PartOffsetNVMMicroMeter; /*!< backed up NVM value */
sepp_nepp 6:fb11b746ceb5 624 int32_t Part2PartOffsetAdjustmentNVMMicroMeter; /*!< backed up NVM value representing additional offset adjustment */
sepp_nepp 6:fb11b746ceb5 625 VL53L0X_DeviceParameters_t CurrentParameters; /*!< Current Device Parameter */
sepp_nepp 6:fb11b746ceb5 626 VL53L0X_RangingMeasurementData_t LastRangeMeasure; /*!< Ranging Data */
sepp_nepp 6:fb11b746ceb5 627 VL53L0X_HistogramMeasurementData_t LastHistogramMeasure; /*!< Histogram Data */
sepp_nepp 6:fb11b746ceb5 628 VL53L0X_SpadData_t SpadData; /*!< Spad Data; Enables and Good-Map */
sepp_nepp 6:fb11b746ceb5 629 uint8_t SequenceConfig; /*!< Internal value for the sequence config */
sepp_nepp 6:fb11b746ceb5 630 uint8_t RangeFractionalEnable; /*!< Enable/Disable fractional part of ranging data */
sepp_nepp 6:fb11b746ceb5 631 VL53L0X_State PalState; /*!< Current state of the PAL for this device */
sepp_nepp 6:fb11b746ceb5 632 VL53L0X_PowerModes PowerMode; /*!< Current Power Mode; Stdby1/2, Idle1/2 */
sepp_nepp 6:fb11b746ceb5 633 uint16_t SigmaEstRefArray; /*!< Reference array sigma value in 1/100th of [mm] e.g. 100 = 1mm; loaded from tuning settings */
sepp_nepp 6:fb11b746ceb5 634 uint16_t SigmaEstEffPulseWidth; /*!< Effective Pulse width for sigma estimate in 1/100th of ns e.g. 900 = 9.0ns */
sepp_nepp 6:fb11b746ceb5 635 uint16_t SigmaEstEffAmbWidth; /*!< Effective Ambient width for sigma estimate in 1/100th of ns e.g. 500 = 5.0ns */
sepp_nepp 6:fb11b746ceb5 636 uint8_t StopVariable; /*!< StopVariable used during the stop sequence */
sepp_nepp 6:fb11b746ceb5 637 uint16_t targetRefRate; /*!< Target Ambient Rate for Ref spad management */
sepp_nepp 6:fb11b746ceb5 638 FixPoint1616_t SigmaEstimate; /*!< Sigma Estimate - based on ambient & VCSEL rates and signal_total_events */
sepp_nepp 6:fb11b746ceb5 639 FixPoint1616_t LastSignalRefMcps; /*!< Latest Signal ref in Mcps */
sepp_nepp 6:fb11b746ceb5 640 uint8_t *pTuningSettingsPointer; /*!< Pointer for Tuning Settings table */
sepp_nepp 6:fb11b746ceb5 641 uint8_t UseInternalTuningSettings; /*!< Indicate if we use Tuning Settings table */
sepp_nepp 6:fb11b746ceb5 642 uint16_t LinearityCorrectiveGain; /*!< Linearity Corrective Gain value in x1000 */
sepp_nepp 6:fb11b746ceb5 643 uint16_t DmaxCalRangeMilliMeter; /*!< Dmax Calibration Range millimeter */
sepp_nepp 6:fb11b746ceb5 644 FixPoint1616_t DmaxCalSignalRateRtnMegaCps;/*!< Dmax Calibration Signal Rate Return MegaCps */
sepp_nepp 6:fb11b746ceb5 645 } VL53L0X_DevData_t;
sepp_nepp 6:fb11b746ceb5 646
sepp_nepp 7:3a1115c2556b 647 /** @def PALDevDataGet
sepp_nepp 7:3a1115c2556b 648 * @brief Get ST private structure @a VL53L0X_DevData_t data access
sepp_nepp 7:3a1115c2556b 649 *
sepp_nepp 7:3a1115c2556b 650 * @param Dev Device Handle
sepp_nepp 7:3a1115c2556b 651 * @param field ST structure field name
sepp_nepp 7:3a1115c2556b 652 * It maybe used and as real data "ref" not just as "get" for sub-structure item
sepp_nepp 7:3a1115c2556b 653 * like PALDevDataGet(FilterData.field)[i] or PALDevDataGet(FilterData.MeasurementIndex)++
sepp_nepp 7:3a1115c2556b 654 */
sepp_nepp 7:3a1115c2556b 655 #define PALDevDataGet(field) (Data.field)
sepp_nepp 6:fb11b746ceb5 656
sepp_nepp 7:3a1115c2556b 657 /** @def PALDevDataSet(Dev, field, data)
sepp_nepp 7:3a1115c2556b 658 * @brief Set ST private structure @a VL53L0X_DevData_t data field
sepp_nepp 7:3a1115c2556b 659 * @param Dev Device Handle
sepp_nepp 7:3a1115c2556b 660 * @param field ST structure field name
sepp_nepp 7:3a1115c2556b 661 * @param data Data to be set
sepp_nepp 7:3a1115c2556b 662 */
sepp_nepp 7:3a1115c2556b 663 #define PALDevDataSet(field, data) (Data.field)=(data)
sepp_nepp 6:fb11b746ceb5 664
sepp_nepp 7:3a1115c2556b 665 /* MACRO Definitions */
sepp_nepp 7:3a1115c2556b 666 /** @defgroup VL53L0X_define_GeneralMacro_group General Macro Defines
sepp_nepp 7:3a1115c2556b 667 * General Macro Defines
sepp_nepp 7:3a1115c2556b 668 * @{
sepp_nepp 7:3a1115c2556b 669 */
sepp_nepp 7:3a1115c2556b 670 #define VL53L0X_SETPARAMETERFIELD(field, value) PALDevDataSet(CurrentParameters.field, value)
sepp_nepp 7:3a1115c2556b 671 #define VL53L0X_GETPARAMETERFIELD(field, variable) variable = PALDevDataGet(CurrentParameters).field
sepp_nepp 7:3a1115c2556b 672 #define VL53L0X_SETARRAYPARAMETERFIELD(field, index, value) PALDevDataSet(CurrentParameters.field[index], value)
sepp_nepp 7:3a1115c2556b 673 #define VL53L0X_GETARRAYPARAMETERFIELD(field, index, variable) variable = PALDevDataGet(CurrentParameters).field[index]
sepp_nepp 7:3a1115c2556b 674 #define VL53L0X_SETDEVICESPECIFICPARAMETER(field, value) PALDevDataSet(field, value)
sepp_nepp 7:3a1115c2556b 675 #define VL53L0X_GETDEVICESPECIFICPARAMETER(field) PALDevDataGet(field)
sepp_nepp 6:fb11b746ceb5 676
sepp_nepp 6:fb11b746ceb5 677 /** @defgroup VL53L0X_define_InterruptPolarity_group Defines the Polarity of the Interrupt
sepp_nepp 6:fb11b746ceb5 678 * Defines the Polarity of the Interrupt
sepp_nepp 6:fb11b746ceb5 679 * @{
sepp_nepp 6:fb11b746ceb5 680 */
sepp_nepp 6:fb11b746ceb5 681 typedef uint8_t VL53L0X_InterruptPolarity;
sepp_nepp 6:fb11b746ceb5 682
sepp_nepp 6:fb11b746ceb5 683 #define VL53L0X_INTERRUPTPOLARITY_LOW ((VL53L0X_InterruptPolarity) 0)
sepp_nepp 6:fb11b746ceb5 684 /*!< Set active low polarity best setup for falling edge. */
sepp_nepp 6:fb11b746ceb5 685 #define VL53L0X_INTERRUPTPOLARITY_HIGH ((VL53L0X_InterruptPolarity) 1)
sepp_nepp 6:fb11b746ceb5 686 /*!< Set active high polarity best setup for rising edge. */
sepp_nepp 6:fb11b746ceb5 687
sepp_nepp 6:fb11b746ceb5 688 /** @} VL53L0X_define_InterruptPolarity_group */
sepp_nepp 6:fb11b746ceb5 689
sepp_nepp 6:fb11b746ceb5 690
sepp_nepp 6:fb11b746ceb5 691 /** @defgroup VL53L0X_define_VcselPeriod_group Vcsel Period Defines
sepp_nepp 6:fb11b746ceb5 692 * Defines the range measurement for which to access the vcsel period.
sepp_nepp 6:fb11b746ceb5 693 * @{
sepp_nepp 6:fb11b746ceb5 694 */
sepp_nepp 6:fb11b746ceb5 695 typedef uint8_t VL53L0X_VcselPeriod;
sepp_nepp 6:fb11b746ceb5 696
sepp_nepp 6:fb11b746ceb5 697 #define VL53L0X_VCSEL_PERIOD_PRE_RANGE ((VL53L0X_VcselPeriod) 0)
sepp_nepp 6:fb11b746ceb5 698 /*!<Identifies the pre-range vcsel period. */
sepp_nepp 6:fb11b746ceb5 699 #define VL53L0X_VCSEL_PERIOD_FINAL_RANGE ((VL53L0X_VcselPeriod) 1)
sepp_nepp 6:fb11b746ceb5 700 /*!<Identifies the final range vcsel period. */
sepp_nepp 6:fb11b746ceb5 701
sepp_nepp 6:fb11b746ceb5 702 /** @} VL53L0X_define_VcselPeriod_group */
sepp_nepp 6:fb11b746ceb5 703
sepp_nepp 6:fb11b746ceb5 704 /** @defgroup VL53L0X_define_SchedulerSequence_group Defines the steps
sepp_nepp 6:fb11b746ceb5 705 * carried out by the scheduler during a range measurement.
sepp_nepp 6:fb11b746ceb5 706 * @{
sepp_nepp 6:fb11b746ceb5 707 * Defines the states of all the steps in the scheduler
sepp_nepp 6:fb11b746ceb5 708 * i.e. enabled/disabled.
sepp_nepp 6:fb11b746ceb5 709 */
sepp_nepp 6:fb11b746ceb5 710 typedef struct {
sepp_nepp 6:fb11b746ceb5 711 uint8_t TccOn; /*!<Reports if Target Centre Check On */
sepp_nepp 6:fb11b746ceb5 712 uint8_t MsrcOn; /*!<Reports if MSRC On */
sepp_nepp 6:fb11b746ceb5 713 uint8_t DssOn; /*!<Reports if DSS On */
sepp_nepp 6:fb11b746ceb5 714 uint8_t PreRangeOn; /*!<Reports if Pre-Range On */
sepp_nepp 6:fb11b746ceb5 715 uint8_t FinalRangeOn; /*!<Reports if Final-Range On */
sepp_nepp 6:fb11b746ceb5 716 } VL53L0X_SchedulerSequenceSteps_t;
sepp_nepp 6:fb11b746ceb5 717
sepp_nepp 6:fb11b746ceb5 718 /** @} VL53L0X_define_SchedulerSequence_group */
sepp_nepp 6:fb11b746ceb5 719
sepp_nepp 6:fb11b746ceb5 720 /** @defgroup VL53L0X_define_SequenceStepId_group Defines the Polarity
sepp_nepp 6:fb11b746ceb5 721 * of the Interrupt
sepp_nepp 6:fb11b746ceb5 722 * Defines the the sequence steps performed during ranging..
sepp_nepp 6:fb11b746ceb5 723 * @{
sepp_nepp 6:fb11b746ceb5 724 */
sepp_nepp 6:fb11b746ceb5 725 typedef uint8_t VL53L0X_SequenceStepId;
sepp_nepp 6:fb11b746ceb5 726
sepp_nepp 6:fb11b746ceb5 727 #define VL53L0X_SEQUENCESTEP_TCC ((VL53L0X_VcselPeriod) 0)
sepp_nepp 6:fb11b746ceb5 728 /*!<Target CentreCheck identifier. */
sepp_nepp 6:fb11b746ceb5 729 #define VL53L0X_SEQUENCESTEP_DSS ((VL53L0X_VcselPeriod) 1)
sepp_nepp 6:fb11b746ceb5 730 /*!<Dynamic Spad Selection function Identifier. */
sepp_nepp 6:fb11b746ceb5 731 #define VL53L0X_SEQUENCESTEP_MSRC ((VL53L0X_VcselPeriod) 2)
sepp_nepp 6:fb11b746ceb5 732 /*!<Minimum Signal Rate Check function Identifier. */
sepp_nepp 6:fb11b746ceb5 733 #define VL53L0X_SEQUENCESTEP_PRE_RANGE ((VL53L0X_VcselPeriod) 3)
sepp_nepp 6:fb11b746ceb5 734 /*!<Pre-Range check Identifier. */
sepp_nepp 6:fb11b746ceb5 735 #define VL53L0X_SEQUENCESTEP_FINAL_RANGE ((VL53L0X_VcselPeriod) 4)
sepp_nepp 6:fb11b746ceb5 736 /*!<Final Range Check Identifier. */
sepp_nepp 6:fb11b746ceb5 737
sepp_nepp 6:fb11b746ceb5 738 #define VL53L0X_SEQUENCESTEP_NUMBER_OF_CHECKS 5
sepp_nepp 6:fb11b746ceb5 739 /*!<Number of Sequence Step Managed by the API. */
sepp_nepp 6:fb11b746ceb5 740
sepp_nepp 6:fb11b746ceb5 741 /** @} VL53L0X_define_SequenceStepId_group */
sepp_nepp 6:fb11b746ceb5 742
sepp_nepp 6:fb11b746ceb5 743 typedef enum {
sepp_nepp 6:fb11b746ceb5 744 Range_Config_DEFAULT,
sepp_nepp 6:fb11b746ceb5 745 Range_Config_LONG_RANGE,
sepp_nepp 6:fb11b746ceb5 746 Range_Config_HIGH_ACCURACY,
sepp_nepp 6:fb11b746ceb5 747 Range_Config_HIGH_SPEED
sepp_nepp 6:fb11b746ceb5 748 } VL53L0X_RangingConfig;
sepp_nepp 6:fb11b746ceb5 749
sepp_nepp 6:fb11b746ceb5 750
sepp_nepp 6:fb11b746ceb5 751 #define VL53L0X_FIXPOINT1616TOFIXPOINT97(Value) (uint16_t)((Value>>9)&0xFFFF)
sepp_nepp 6:fb11b746ceb5 752 #define VL53L0X_FIXPOINT97TOFIXPOINT1616(Value) (FixPoint1616_t)(Value<<9)
sepp_nepp 6:fb11b746ceb5 753 #define VL53L0X_FIXPOINT1616TOFIXPOINT88(Value) (uint16_t)((Value>>8)&0xFFFF)
sepp_nepp 6:fb11b746ceb5 754 #define VL53L0X_FIXPOINT88TOFIXPOINT1616(Value) (FixPoint1616_t)(Value<<8)
sepp_nepp 6:fb11b746ceb5 755 #define VL53L0X_FIXPOINT1616TOFIXPOINT412(Value) (uint16_t)((Value>>4)&0xFFFF)
sepp_nepp 6:fb11b746ceb5 756 #define VL53L0X_FIXPOINT412TOFIXPOINT1616(Value) (FixPoint1616_t)(Value<<4)
sepp_nepp 6:fb11b746ceb5 757 #define VL53L0X_FIXPOINT1616TOFIXPOINT313(Value) (uint16_t)((Value>>3)&0xFFFF)
sepp_nepp 6:fb11b746ceb5 758 #define VL53L0X_FIXPOINT313TOFIXPOINT1616(Value) (FixPoint1616_t)(Value<<3)
sepp_nepp 6:fb11b746ceb5 759 #define VL53L0X_FIXPOINT1616TOFIXPOINT08(Value) (uint8_t)((Value>>8)&0x00FF)
sepp_nepp 6:fb11b746ceb5 760 #define VL53L0X_FIXPOINT08TOFIXPOINT1616(Value) (FixPoint1616_t)(Value<<8)
sepp_nepp 6:fb11b746ceb5 761 #define VL53L0X_FIXPOINT1616TOFIXPOINT53(Value) (uint8_t)((Value>>13)&0x00FF)
sepp_nepp 6:fb11b746ceb5 762 #define VL53L0X_FIXPOINT53TOFIXPOINT1616(Value) (FixPoint1616_t)(Value<<13)
sepp_nepp 6:fb11b746ceb5 763 #define VL53L0X_FIXPOINT1616TOFIXPOINT102(Value) (uint16_t)((Value>>14)&0x0FFF)
sepp_nepp 6:fb11b746ceb5 764 #define VL53L0X_FIXPOINT102TOFIXPOINT1616(Value) (FixPoint1616_t)(Value<<12)
sepp_nepp 6:fb11b746ceb5 765 #define VL53L0X_MAKEUINT16(lsb, msb) (uint16_t)((((uint16_t)msb)<<8) + (uint16_t)lsb)
sepp_nepp 6:fb11b746ceb5 766
sepp_nepp 6:fb11b746ceb5 767 /** @} VL53L0X_define_GeneralMacro_group */
sepp_nepp 6:fb11b746ceb5 768
sepp_nepp 6:fb11b746ceb5 769 /** @} VL53L0X_globaldefine_group */
sepp_nepp 6:fb11b746ceb5 770
sepp_nepp 6:fb11b746ceb5 771 /****************** define for i2c configuration *******************************/
sepp_nepp 6:fb11b746ceb5 772
sepp_nepp 6:fb11b746ceb5 773 /** Maximum buffer size to be used in i2c */
sepp_nepp 6:fb11b746ceb5 774 #define VL53L0X_MAX_I2C_XFER_SIZE 64 /* Maximum buffer size to be used in i2c */
sepp_nepp 6:fb11b746ceb5 775
sepp_nepp 6:fb11b746ceb5 776 #define VL53L0X_COPYSTRING(str, ...) strcpy(str, ##__VA_ARGS__)
sepp_nepp 6:fb11b746ceb5 777
sepp_nepp 6:fb11b746ceb5 778 #define REF_ARRAY_SPAD_0 0
sepp_nepp 6:fb11b746ceb5 779 #define REF_ARRAY_SPAD_5 5
sepp_nepp 6:fb11b746ceb5 780 #define REF_ARRAY_SPAD_10 10
sepp_nepp 6:fb11b746ceb5 781
sepp_nepp 6:fb11b746ceb5 782 static uint32_t refArrayQuadrants[4] = {REF_ARRAY_SPAD_10, REF_ARRAY_SPAD_5,
sepp_nepp 6:fb11b746ceb5 783 REF_ARRAY_SPAD_0, REF_ARRAY_SPAD_5 };
sepp_nepp 6:fb11b746ceb5 784 /**
sepp_nepp 6:fb11b746ceb5 785 * The device model ID
sepp_nepp 6:fb11b746ceb5 786 */
sepp_nepp 6:fb11b746ceb5 787 #define IDENTIFICATION_MODEL_ID 0x000
sepp_nepp 6:fb11b746ceb5 788
sepp_nepp 6:fb11b746ceb5 789 #define STATUS_OK 0x00
sepp_nepp 6:fb11b746ceb5 790 #define STATUS_FAIL 0x01
sepp_nepp 6:fb11b746ceb5 791
sepp_nepp 6:fb11b746ceb5 792 #define VL53L0X_OsDelay(...) wait_ms(2) // 2 msec delay. can also use wait(float secs)/wait_us(int)
sepp_nepp 6:fb11b746ceb5 793
sepp_nepp 6:fb11b746ceb5 794 #define VL53L0X_STRING_DEVICE_INFO_NAME "VL53L0X cut1.0"
sepp_nepp 6:fb11b746ceb5 795 #define VL53L0X_STRING_DEVICE_INFO_NAME_TS0 "VL53L0X TS0"
sepp_nepp 6:fb11b746ceb5 796 #define VL53L0X_STRING_DEVICE_INFO_NAME_TS1 "VL53L0X TS1"
sepp_nepp 6:fb11b746ceb5 797 #define VL53L0X_STRING_DEVICE_INFO_NAME_TS2 "VL53L0X TS2"
sepp_nepp 6:fb11b746ceb5 798 #define VL53L0X_STRING_DEVICE_INFO_NAME_ES1 "VL53L0X ES1 or later"
sepp_nepp 6:fb11b746ceb5 799 #define VL53L0X_STRING_DEVICE_INFO_TYPE "VL53L0X"
sepp_nepp 6:fb11b746ceb5 800
sepp_nepp 6:fb11b746ceb5 801
sepp_nepp 6:fb11b746ceb5 802
sepp_nepp 6:fb11b746ceb5 803 /* sensor operating modes */
sepp_nepp 6:fb11b746ceb5 804 typedef enum {
sepp_nepp 6:fb11b746ceb5 805 range_single_shot_polling = 1,
sepp_nepp 6:fb11b746ceb5 806 range_continuous_polling,
sepp_nepp 6:fb11b746ceb5 807 range_continuous_interrupt,
sepp_nepp 6:fb11b746ceb5 808 range_continuous_polling_low_threshold,
sepp_nepp 6:fb11b746ceb5 809 range_continuous_polling_high_threshold,
sepp_nepp 6:fb11b746ceb5 810 range_continuous_polling_out_of_window,
sepp_nepp 6:fb11b746ceb5 811 range_continuous_interrupt_low_threshold,
sepp_nepp 6:fb11b746ceb5 812 range_continuous_interrupt_high_threshold,
sepp_nepp 6:fb11b746ceb5 813 range_continuous_interrupt_out_of_window,
sepp_nepp 6:fb11b746ceb5 814 } OperatingMode;
sepp_nepp 6:fb11b746ceb5 815
sepp_nepp 6:fb11b746ceb5 816
sepp_nepp 6:fb11b746ceb5 817
sepp_nepp 6:fb11b746ceb5 818 #ifdef __cplusplus
sepp_nepp 6:fb11b746ceb5 819 }
sepp_nepp 6:fb11b746ceb5 820 #endif
sepp_nepp 6:fb11b746ceb5 821
sepp_nepp 6:fb11b746ceb5 822
sepp_nepp 6:fb11b746ceb5 823 #endif /* _VL53L0X_DEF_H_ */