Tarek Lule / VL53L0X_Condensed2

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

VL53L0X_def.h@13:253cb4ea3fcc, 2019-07-20 (annotated)

Committer:
sepp_nepp
Date:
Sat Jul 20 08:48:49 2019 +0000
Revision:
13:253cb4ea3fcc
Parent:
12:81f37e50f8f8 
Proven to work with TOF-Synth-III

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 10:cd1758e186a4 32 * @brief Type definitions for VL53L0X API. */
sepp_nepp 6:fb11b746ceb5 33
sepp_nepp 6:fb11b746ceb5 34 #ifndef _VL53L0X_DEF_H_
sepp_nepp 6:fb11b746ceb5 35 #define _VL53L0X_DEF_H_
sepp_nepp 6:fb11b746ceb5 36
sepp_nepp 6:fb11b746ceb5 37 #ifdef __cplusplus
sepp_nepp 6:fb11b746ceb5 38 extern "C" {
sepp_nepp 6:fb11b746ceb5 39 #endif
sepp_nepp 6:fb11b746ceb5 40
sepp_nepp 6:fb11b746ceb5 41 /** @defgroup VL53L0X_globaldefine_group VL53L0X Defines
sepp_nepp 6:fb11b746ceb5 42 * @brief VL53L0X Defines
sepp_nepp 10:cd1758e186a4 43 * @{ */
sepp_nepp 6:fb11b746ceb5 44 /** PAL SPECIFICATION major version */
sepp_nepp 6:fb11b746ceb5 45 #define VL53L0X10_SPECIFICATION_VER_MAJOR 1
sepp_nepp 6:fb11b746ceb5 46 /** PAL SPECIFICATION minor version */
sepp_nepp 6:fb11b746ceb5 47 #define VL53L0X10_SPECIFICATION_VER_MINOR 2
sepp_nepp 6:fb11b746ceb5 48 /** PAL SPECIFICATION sub version */
sepp_nepp 10:cd1758e186a4 49 #define VL53L0X10_SPECIFICATION_VER_SUB 7
sepp_nepp 6:fb11b746ceb5 50 /** PAL SPECIFICATION sub version */
sepp_nepp 6:fb11b746ceb5 51 #define VL53L0X10_SPECIFICATION_VER_REVISION 1440
sepp_nepp 6:fb11b746ceb5 52
sepp_nepp 6:fb11b746ceb5 53 /** VL53L0X PAL IMPLEMENTATION major version */
sepp_nepp 6:fb11b746ceb5 54 #define VL53L0X10_IMPLEMENTATION_VER_MAJOR 1
sepp_nepp 6:fb11b746ceb5 55 /** VL53L0X PAL IMPLEMENTATION minor version */
sepp_nepp 6:fb11b746ceb5 56 #define VL53L0X10_IMPLEMENTATION_VER_MINOR 0
sepp_nepp 6:fb11b746ceb5 57 /** VL53L0X PAL IMPLEMENTATION sub version */
sepp_nepp 10:cd1758e186a4 58 #define VL53L0X10_IMPLEMENTATION_VER_SUB 9
sepp_nepp 6:fb11b746ceb5 59 /** VL53L0X PAL IMPLEMENTATION sub version */
sepp_nepp 6:fb11b746ceb5 60 #define VL53L0X10_IMPLEMENTATION_VER_REVISION 3673
sepp_nepp 6:fb11b746ceb5 61
sepp_nepp 6:fb11b746ceb5 62 /** PAL SPECIFICATION major version */
sepp_nepp 10:cd1758e186a4 63 #define VL53L0X_SPECIFICATION_VER_MAJOR 1
sepp_nepp 6:fb11b746ceb5 64 /** PAL SPECIFICATION minor version */
sepp_nepp 10:cd1758e186a4 65 #define VL53L0X_SPECIFICATION_VER_MINOR 2
sepp_nepp 6:fb11b746ceb5 66 /** PAL SPECIFICATION sub version */
sepp_nepp 10:cd1758e186a4 67 #define VL53L0X_SPECIFICATION_VER_SUB 7
sepp_nepp 6:fb11b746ceb5 68 /** PAL SPECIFICATION sub version */
sepp_nepp 10:cd1758e186a4 69 #define VL53L0X_SPECIFICATION_VER_REVISION 1440
sepp_nepp 6:fb11b746ceb5 70
sepp_nepp 6:fb11b746ceb5 71 /** VL53L0X PAL IMPLEMENTATION major version */
sepp_nepp 10:cd1758e186a4 72 #define VL53L0X_IMPLEMENTATION_VER_MAJOR 1
sepp_nepp 6:fb11b746ceb5 73 /** VL53L0X PAL IMPLEMENTATION minor version */
sepp_nepp 10:cd1758e186a4 74 #define VL53L0X_IMPLEMENTATION_VER_MINOR 1
sepp_nepp 10:cd1758e186a4 75 /** VL53L0X PAL IMPLEMENTATION sub version */
sepp_nepp 10:cd1758e186a4 76 #define VL53L0X_IMPLEMENTATION_VER_SUB 21
sepp_nepp 6:fb11b746ceb5 77 /** VL53L0X PAL IMPLEMENTATION sub version */
sepp_nepp 10:cd1758e186a4 78 #define VL53L0X_IMPLEMENTATION_VER_REVISION 4823
sepp_nepp 10:cd1758e186a4 79
sepp_nepp 10:cd1758e186a4 80 /** FixPoint1616_t is used where fractional values are needed
sepp_nepp 10:cd1758e186a4 81 * Given a floating point value f it's .16 bit point is (int)(f*(1<<16))*/
sepp_nepp 10:cd1758e186a4 82 typedef uint32_t FixPoint1616_t;
sepp_nepp 11:d8dbe3b87f9f 83 #define VL53L0X_FP1616TOFP97(Value) (uint16_t)((Value>>9)&0xFFFF)
sepp_nepp 11:d8dbe3b87f9f 84 #define VL53L0X_FP97TOFP1616(Value) (FixPoint1616_t)(Value<<9)
sepp_nepp 11:d8dbe3b87f9f 85 #define VL53L0X_FP1616TOFP88(Value) (uint16_t)((Value>>8)&0xFFFF)
sepp_nepp 11:d8dbe3b87f9f 86 #define VL53L0X_FP88TOFP1616(Value) (FixPoint1616_t)(Value<<8)
sepp_nepp 11:d8dbe3b87f9f 87 #define VL53L0X_FP1616TOFP412(Value) (uint16_t)((Value>>4)&0xFFFF)
sepp_nepp 11:d8dbe3b87f9f 88 #define VL53L0X_FP412TOFP1616(Value) (FixPoint1616_t)(Value<<4)
sepp_nepp 11:d8dbe3b87f9f 89 #define VL53L0X_FP1616TOFP313(Value) (uint16_t)((Value>>3)&0xFFFF)
sepp_nepp 11:d8dbe3b87f9f 90 #define VL53L0X_FP313TOFP1616(Value) (FixPoint1616_t)(Value<<3)
sepp_nepp 11:d8dbe3b87f9f 91 #define VL53L0X_FP1616TOFP08(Value) (uint8_t)((Value>>8)&0x00FF)
sepp_nepp 11:d8dbe3b87f9f 92 #define VL53L0X_FP08TOFP1616(Value) (FixPoint1616_t)(Value<<8)
sepp_nepp 11:d8dbe3b87f9f 93 #define VL53L0X_FP1616TOFP53(Value) (uint8_t)((Value>>13)&0x00FF)
sepp_nepp 11:d8dbe3b87f9f 94 #define VL53L0X_FP53TOFP1616(Value) (FixPoint1616_t)(Value<<13)
sepp_nepp 11:d8dbe3b87f9f 95 #define VL53L0X_FP1616TOFP102(Value) (uint16_t)((Value>>14)&0x0FFF)
sepp_nepp 11:d8dbe3b87f9f 96 #define VL53L0X_FP102TOFP1616(Value) (FixPoint1616_t)(Value<<12)
sepp_nepp 10:cd1758e186a4 97 #define VL53L0X_MAKEUINT16(lsb, msb) (uint16_t)((((uint16_t)msb)<<8) + (uint16_t)lsb)
sepp_nepp 6:fb11b746ceb5 98
sepp_nepp 6:fb11b746ceb5 99
sepp_nepp 10:cd1758e186a4 100 /** The device model ID */
sepp_nepp 10:cd1758e186a4 101 #define IDENTIFICATION_MODEL_ID 0x000
sepp_nepp 10:cd1758e186a4 102
sepp_nepp 10:cd1758e186a4 103 #define VL53L0X_OsDelay(...) wait_ms(2) // 2 msec delay. can also use wait(float secs)/wait_us(int)
sepp_nepp 10:cd1758e186a4 104
sepp_nepp 10:cd1758e186a4 105 /** Maximum buffer size to be used in i2c */
sepp_nepp 10:cd1758e186a4 106 #define VL53L0X_MAX_I2C_XFER_SIZE 64
sepp_nepp 10:cd1758e186a4 107
sepp_nepp 10:cd1758e186a4 108 #define VL53L0X_COPYSTRING(str, ...) strcpy(str, ##__VA_ARGS__)
sepp_nepp 6:fb11b746ceb5 109
sepp_nepp 6:fb11b746ceb5 110 /* Speed of light in um per 1E-10 Seconds */
sepp_nepp 10:cd1758e186a4 111 #define VL53L0X_SPEED_OF_LIGHT_IN_AIR 2997
sepp_nepp 10:cd1758e186a4 112
sepp_nepp 10:cd1758e186a4 113 /** default device address */
sepp_nepp 10:cd1758e186a4 114 #define VL53L0X_DEFAULT_ADDRESS 0x52 /* (8-bit) */
sepp_nepp 10:cd1758e186a4 115
sepp_nepp 10:cd1758e186a4 116 #define VL53L0X_DEFAULT_MAX_LOOP 2000
sepp_nepp 10:cd1758e186a4 117
sepp_nepp 10:cd1758e186a4 118 #define VL53L0X_MAX_STRING_LENGTH 32
sepp_nepp 6:fb11b746ceb5 119
sepp_nepp 10:cd1758e186a4 120 /* equivalent to a range sigma of 655.35mm */
sepp_nepp 10:cd1758e186a4 121 #define VL53L0X_SIGMA_ESTIMATE_MAX_VALUE 65535
sepp_nepp 10:cd1758e186a4 122
sepp_nepp 10:cd1758e186a4 123 #define REF_ARRAY_SPAD_0 0
sepp_nepp 10:cd1758e186a4 124 #define REF_ARRAY_SPAD_5 5
sepp_nepp 10:cd1758e186a4 125 #define REF_ARRAY_SPAD_10 10
sepp_nepp 10:cd1758e186a4 126
sepp_nepp 10:cd1758e186a4 127 static uint32_t refArrayQuadrants[4] = {REF_ARRAY_SPAD_10, REF_ARRAY_SPAD_5,
sepp_nepp 10:cd1758e186a4 128 REF_ARRAY_SPAD_0, REF_ARRAY_SPAD_5 };
sepp_nepp 6:fb11b746ceb5 129
sepp_nepp 10:cd1758e186a4 130 #define VL53L0X_STRING_DEVICE_INFO_NAME "VL53L0X cut1.0"
sepp_nepp 10:cd1758e186a4 131 #define VL53L0X_STRING_DEVICE_INFO_NAME_TS0 "VL53L0X TS0"
sepp_nepp 10:cd1758e186a4 132 #define VL53L0X_STRING_DEVICE_INFO_NAME_TS1 "VL53L0X TS1"
sepp_nepp 10:cd1758e186a4 133 #define VL53L0X_STRING_DEVICE_INFO_NAME_TS2 "VL53L0X TS2"
sepp_nepp 10:cd1758e186a4 134 #define VL53L0X_STRING_DEVICE_INFO_NAME_ES1 "VL53L0X ES1 or later"
sepp_nepp 10:cd1758e186a4 135 #define VL53L0X_STRING_DEVICE_INFO_TYPE "VL53L0X"
sepp_nepp 6:fb11b746ceb5 136
sepp_nepp 10:cd1758e186a4 137 /* sensor operating modes */
sepp_nepp 10:cd1758e186a4 138 typedef enum {
sepp_nepp 10:cd1758e186a4 139 range_single_shot_polling = 1,
sepp_nepp 10:cd1758e186a4 140 range_continuous_polling,
sepp_nepp 10:cd1758e186a4 141 range_continuous_interrupt,
sepp_nepp 10:cd1758e186a4 142 range_continuous_polling_low_threshold,
sepp_nepp 10:cd1758e186a4 143 range_continuous_polling_high_threshold,
sepp_nepp 10:cd1758e186a4 144 range_continuous_polling_out_of_window,
sepp_nepp 10:cd1758e186a4 145 range_continuous_interrupt_low_threshold,
sepp_nepp 10:cd1758e186a4 146 range_continuous_interrupt_high_threshold,
sepp_nepp 10:cd1758e186a4 147 range_continuous_interrupt_out_of_window,
sepp_nepp 10:cd1758e186a4 148 } OperatingMode;
sepp_nepp 6:fb11b746ceb5 149
sepp_nepp 6:fb11b746ceb5 150 /** @defgroup VL53L0X_DeviceError_group Device Error
sepp_nepp 6:fb11b746ceb5 151 * @brief Device Error code
sepp_nepp 6:fb11b746ceb5 152 *
sepp_nepp 6:fb11b746ceb5 153 * This enum is Device specific it should be updated in the implementation
sepp_nepp 6:fb11b746ceb5 154 * Use @a VL53L0X_GetStatusErrorString() to get the string.
sepp_nepp 6:fb11b746ceb5 155 * It is related to Status Register of the Device.
sepp_nepp 10:cd1758e186a4 156 * @{ */
sepp_nepp 6:fb11b746ceb5 157 typedef uint8_t VL53L0X_DeviceError;
sepp_nepp 11:d8dbe3b87f9f 158 #define VL53L0X_DEVICEERROR_NONE ((VL53L0X_DeviceError) 0) /*!< 0 NoError */
sepp_nepp 6:fb11b746ceb5 159 #define VL53L0X_DEVICEERROR_VCSELCONTINUITYTESTFAILURE ((VL53L0X_DeviceError) 1)
sepp_nepp 6:fb11b746ceb5 160 #define VL53L0X_DEVICEERROR_VCSELWATCHDOGTESTFAILURE ((VL53L0X_DeviceError) 2)
sepp_nepp 6:fb11b746ceb5 161 #define VL53L0X_DEVICEERROR_NOVHVVALUEFOUND ((VL53L0X_DeviceError) 3)
sepp_nepp 6:fb11b746ceb5 162 #define VL53L0X_DEVICEERROR_MSRCNOTARGET ((VL53L0X_DeviceError) 4)
sepp_nepp 6:fb11b746ceb5 163 #define VL53L0X_DEVICEERROR_SNRCHECK ((VL53L0X_DeviceError) 5)
sepp_nepp 6:fb11b746ceb5 164 #define VL53L0X_DEVICEERROR_RANGEPHASECHECK ((VL53L0X_DeviceError) 6)
sepp_nepp 6:fb11b746ceb5 165 #define VL53L0X_DEVICEERROR_SIGMATHRESHOLDCHECK ((VL53L0X_DeviceError) 7)
sepp_nepp 6:fb11b746ceb5 166 #define VL53L0X_DEVICEERROR_TCC ((VL53L0X_DeviceError) 8)
sepp_nepp 6:fb11b746ceb5 167 #define VL53L0X_DEVICEERROR_PHASECONSISTENCY ((VL53L0X_DeviceError) 9)
sepp_nepp 6:fb11b746ceb5 168 #define VL53L0X_DEVICEERROR_MINCLIP ((VL53L0X_DeviceError) 10)
sepp_nepp 6:fb11b746ceb5 169 #define VL53L0X_DEVICEERROR_RANGECOMPLETE ((VL53L0X_DeviceError) 11)
sepp_nepp 6:fb11b746ceb5 170 #define VL53L0X_DEVICEERROR_ALGOUNDERFLOW ((VL53L0X_DeviceError) 12)
sepp_nepp 6:fb11b746ceb5 171 #define VL53L0X_DEVICEERROR_ALGOOVERFLOW ((VL53L0X_DeviceError) 13)
sepp_nepp 6:fb11b746ceb5 172 #define VL53L0X_DEVICEERROR_RANGEIGNORETHRESHOLD ((VL53L0X_DeviceError) 14)
sepp_nepp 6:fb11b746ceb5 173 /** @} end of VL53L0X_DeviceError_group */
sepp_nepp 6:fb11b746ceb5 174
sepp_nepp 6:fb11b746ceb5 175
sepp_nepp 6:fb11b746ceb5 176 /* PAL ERROR strings */
sepp_nepp 6:fb11b746ceb5 177 #define VL53L0X_STRING_ERROR_NONE "No Error"
sepp_nepp 6:fb11b746ceb5 178 #define VL53L0X_STRING_ERROR_CALIBRATION_WARNING "Calibration Warning Error"
sepp_nepp 6:fb11b746ceb5 179 #define VL53L0X_STRING_ERROR_MIN_CLIPPED "Min clipped error"
sepp_nepp 6:fb11b746ceb5 180 #define VL53L0X_STRING_ERROR_UNDEFINED "Undefined error"
sepp_nepp 6:fb11b746ceb5 181 #define VL53L0X_STRING_ERROR_INVALID_PARAMS "Invalid parameters error"
sepp_nepp 6:fb11b746ceb5 182 #define VL53L0X_STRING_ERROR_NOT_SUPPORTED "Not supported error"
sepp_nepp 6:fb11b746ceb5 183 #define VL53L0X_STRING_ERROR_RANGE_ERROR "Range error"
sepp_nepp 6:fb11b746ceb5 184 #define VL53L0X_STRING_ERROR_TIME_OUT "Time out error"
sepp_nepp 6:fb11b746ceb5 185 #define VL53L0X_STRING_ERROR_MODE_NOT_SUPPORTED "Mode not supported error"
sepp_nepp 6:fb11b746ceb5 186 #define VL53L0X_STRING_ERROR_BUFFER_TOO_SMALL "Buffer too small"
sepp_nepp 6:fb11b746ceb5 187 #define VL53L0X_STRING_ERROR_GPIO_NOT_EXISTING "GPIO not existing"
sepp_nepp 6:fb11b746ceb5 188 #define VL53L0X_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED "GPIO funct not supported"
sepp_nepp 6:fb11b746ceb5 189 #define VL53L0X_STRING_ERROR_INTERRUPT_NOT_CLEARED "Interrupt not Cleared"
sepp_nepp 6:fb11b746ceb5 190 #define VL53L0X_STRING_ERROR_CONTROL_INTERFACE "Control Interface Error"
sepp_nepp 6:fb11b746ceb5 191 #define VL53L0X_STRING_ERROR_INVALID_COMMAND "Invalid Command Error"
sepp_nepp 6:fb11b746ceb5 192 #define VL53L0X_STRING_ERROR_DIVISION_BY_ZERO "Division by zero Error"
sepp_nepp 6:fb11b746ceb5 193 #define VL53L0X_STRING_ERROR_REF_SPAD_INIT "Reference Spad Init Error"
sepp_nepp 6:fb11b746ceb5 194 #define VL53L0X_STRING_UNKNOW_ERROR_CODE "Unknown Error Code"
sepp_nepp 6:fb11b746ceb5 195
sepp_nepp 6:fb11b746ceb5 196 /* Range Status */
sepp_nepp 6:fb11b746ceb5 197 #define VL53L0X_STRING_RANGESTATUS_NONE "No Update"
sepp_nepp 6:fb11b746ceb5 198 #define VL53L0X_STRING_RANGESTATUS_RANGEVALID "Range Valid"
sepp_nepp 6:fb11b746ceb5 199 #define VL53L0X_STRING_RANGESTATUS_SIGMA "Sigma Fail"
sepp_nepp 6:fb11b746ceb5 200 #define VL53L0X_STRING_RANGESTATUS_SIGNAL "Signal Fail"
sepp_nepp 6:fb11b746ceb5 201 #define VL53L0X_STRING_RANGESTATUS_MINRANGE "Min Range Fail"
sepp_nepp 6:fb11b746ceb5 202 #define VL53L0X_STRING_RANGESTATUS_PHASE "Phase Fail"
sepp_nepp 6:fb11b746ceb5 203 #define VL53L0X_STRING_RANGESTATUS_HW "Hardware Fail"
sepp_nepp 6:fb11b746ceb5 204
sepp_nepp 6:fb11b746ceb5 205 /* Range Status */
sepp_nepp 6:fb11b746ceb5 206 #define VL53L0X_STRING_STATE_POWERDOWN "POWERDOWN State"
sepp_nepp 6:fb11b746ceb5 207 #define VL53L0X_STRING_STATE_WAIT_STATICINIT "Wait for staticinit State"
sepp_nepp 6:fb11b746ceb5 208 #define VL53L0X_STRING_STATE_STANDBY "STANDBY State"
sepp_nepp 6:fb11b746ceb5 209 #define VL53L0X_STRING_STATE_IDLE "IDLE State"
sepp_nepp 6:fb11b746ceb5 210 #define VL53L0X_STRING_STATE_RUNNING "RUNNING State"
sepp_nepp 6:fb11b746ceb5 211 #define VL53L0X_STRING_STATE_UNKNOWN "UNKNOWN State"
sepp_nepp 6:fb11b746ceb5 212 #define VL53L0X_STRING_STATE_ERROR "ERROR State"
sepp_nepp 6:fb11b746ceb5 213
sepp_nepp 6:fb11b746ceb5 214 /* Device Specific */
sepp_nepp 6:fb11b746ceb5 215 #define VL53L0X_STRING_DEVICEERROR_NONE "No Update"
sepp_nepp 6:fb11b746ceb5 216 #define VL53L0X_STRING_DEVICEERROR_VCSELCONTINUITYTESTFAILURE "VCSEL Continuity Test Failure"
sepp_nepp 6:fb11b746ceb5 217 #define VL53L0X_STRING_DEVICEERROR_VCSELWATCHDOGTESTFAILURE "VCSEL Watchdog Test Failure"
sepp_nepp 6:fb11b746ceb5 218 #define VL53L0X_STRING_DEVICEERROR_NOVHVVALUEFOUND "No VHV Value found"
sepp_nepp 6:fb11b746ceb5 219 #define VL53L0X_STRING_DEVICEERROR_MSRCNOTARGET "MSRC No Target Error"
sepp_nepp 6:fb11b746ceb5 220 #define VL53L0X_STRING_DEVICEERROR_SNRCHECK "SNR Check Exit"
sepp_nepp 6:fb11b746ceb5 221 #define VL53L0X_STRING_DEVICEERROR_RANGEPHASECHECK "Range Phase Check Error"
sepp_nepp 6:fb11b746ceb5 222 #define VL53L0X_STRING_DEVICEERROR_SIGMATHRESHOLDCHECK "Sigma Threshold Check Error"
sepp_nepp 6:fb11b746ceb5 223 #define VL53L0X_STRING_DEVICEERROR_TCC "TCC Error"
sepp_nepp 6:fb11b746ceb5 224 #define VL53L0X_STRING_DEVICEERROR_PHASECONSISTENCY "Phase Consistency Error"
sepp_nepp 6:fb11b746ceb5 225 #define VL53L0X_STRING_DEVICEERROR_MINCLIP "Min Clip Error"
sepp_nepp 6:fb11b746ceb5 226 #define VL53L0X_STRING_DEVICEERROR_RANGECOMPLETE "Range Complete"
sepp_nepp 6:fb11b746ceb5 227 #define VL53L0X_STRING_DEVICEERROR_ALGOUNDERFLOW "Range Algo Underflow Error"
sepp_nepp 6:fb11b746ceb5 228 #define VL53L0X_STRING_DEVICEERROR_ALGOOVERFLOW "Range Algo Overlow Error"
sepp_nepp 6:fb11b746ceb5 229 #define VL53L0X_STRING_DEVICEERROR_RANGEIGNORETHRESHOLD "Range Ignore Threshold Error"
sepp_nepp 6:fb11b746ceb5 230 #define VL53L0X_STRING_DEVICEERROR_UNKNOWN "Unknown error code"
sepp_nepp 6:fb11b746ceb5 231
sepp_nepp 6:fb11b746ceb5 232 /* Check Enable */
sepp_nepp 6:fb11b746ceb5 233 #define VL53L0X_STRING_CHECKENABLE_SIGMA_FINAL_RANGE "SIGMA FINAL RANGE"
sepp_nepp 6:fb11b746ceb5 234 #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE "SIGNAL RATE FINAL RANGE"
sepp_nepp 6:fb11b746ceb5 235 #define VL53L0X_STRING_CHECKENABLE_SIGNAL_REF_CLIP "SIGNAL REF CLIP"
sepp_nepp 6:fb11b746ceb5 236 #define VL53L0X_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD "RANGE IGNORE THRESHOLD"
sepp_nepp 6:fb11b746ceb5 237 #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_MSRC "SIGNAL RATE MSRC"
sepp_nepp 6:fb11b746ceb5 238 #define VL53L0X_STRING_CHECKENABLE_SIGNAL_RATE_PRE_RANGE "SIGNAL RATE PRE RANGE"
sepp_nepp 6:fb11b746ceb5 239
sepp_nepp 6:fb11b746ceb5 240 /* Sequence Step */
sepp_nepp 6:fb11b746ceb5 241 #define VL53L0X_STRING_SEQUENCESTEP_TCC "TCC"
sepp_nepp 6:fb11b746ceb5 242 #define VL53L0X_STRING_SEQUENCESTEP_DSS "DSS"
sepp_nepp 6:fb11b746ceb5 243 #define VL53L0X_STRING_SEQUENCESTEP_MSRC "MSRC"
sepp_nepp 6:fb11b746ceb5 244 #define VL53L0X_STRING_SEQUENCESTEP_PRE_RANGE "PRE RANGE"
sepp_nepp 6:fb11b746ceb5 245 #define VL53L0X_STRING_SEQUENCESTEP_FINAL_RANGE "FINAL RANGE"
sepp_nepp 6:fb11b746ceb5 246
sepp_nepp 6:fb11b746ceb5 247
sepp_nepp 6:fb11b746ceb5 248 /** @defgroup VL53L0X_CheckEnable_group Check Enable list
sepp_nepp 6:fb11b746ceb5 249 * @brief Check Enable code
sepp_nepp 6:fb11b746ceb5 250 *
sepp_nepp 6:fb11b746ceb5 251 * Define used to specify the LimitCheckId.
sepp_nepp 6:fb11b746ceb5 252 * Use @a VL53L0X_GetLimitCheckInfo() to get the string.
sepp_nepp 10:cd1758e186a4 253 * @{ */
sepp_nepp 6:fb11b746ceb5 254 #define VL53L0X_CHECKENABLE_SIGMA_FINAL_RANGE 0
sepp_nepp 6:fb11b746ceb5 255 #define VL53L0X_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE 1
sepp_nepp 6:fb11b746ceb5 256 #define VL53L0X_CHECKENABLE_SIGNAL_REF_CLIP 2
sepp_nepp 6:fb11b746ceb5 257 #define VL53L0X_CHECKENABLE_RANGE_IGNORE_THRESHOLD 3
sepp_nepp 6:fb11b746ceb5 258 #define VL53L0X_CHECKENABLE_SIGNAL_RATE_MSRC 4
sepp_nepp 6:fb11b746ceb5 259 #define VL53L0X_CHECKENABLE_SIGNAL_RATE_PRE_RANGE 5
sepp_nepp 6:fb11b746ceb5 260 #define VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS 6
sepp_nepp 6:fb11b746ceb5 261 /** @} end of VL53L0X_CheckEnable_group */
sepp_nepp 6:fb11b746ceb5 262
sepp_nepp 6:fb11b746ceb5 263
sepp_nepp 10:cd1758e186a4 264
sepp_nepp 10:cd1758e186a4 265 /** @defgroup VL53L0X_DefineRegisters_group Define Registers
sepp_nepp 10:cd1758e186a4 266 * @brief List of all the defined registers
sepp_nepp 10:cd1758e186a4 267 * @{ */
sepp_nepp 10:cd1758e186a4 268 #define VL53L0X_REG_SYSRANGE_START 0x000
sepp_nepp 10:cd1758e186a4 269 /** mask existing bit in #VL53L0X_REG_SYSRANGE_START*/
sepp_nepp 10:cd1758e186a4 270 #define VL53L0X_REG_SYSRANGE_MODE_MASK 0x0F
sepp_nepp 10:cd1758e186a4 271 /** bit 0 in #VL53L0X_REG_SYSRANGE_START write 1 toggle state in
sepp_nepp 10:cd1758e186a4 272 * continuous mode and arm next shot in single shot mode */
sepp_nepp 10:cd1758e186a4 273 #define VL53L0X_REG_SYSRANGE_MODE_START_STOP 0x01
sepp_nepp 10:cd1758e186a4 274 /** bit 1 write 0 in #VL53L0X_REG_SYSRANGE_START set single shot mode */
sepp_nepp 10:cd1758e186a4 275 #define VL53L0X_REG_SYSRANGE_MODE_SINGLESHOT 0x00
sepp_nepp 10:cd1758e186a4 276 /** bit 1 write 1 in #VL53L0X_REG_SYSRANGE_START set back-to-back operation mode */
sepp_nepp 10:cd1758e186a4 277 #define VL53L0X_REG_SYSRANGE_MODE_BACKTOBACK 0x02
sepp_nepp 10:cd1758e186a4 278 /** bit 2 write 1 in #VL53L0X_REG_SYSRANGE_START set timed operation mode */
sepp_nepp 10:cd1758e186a4 279 #define VL53L0X_REG_SYSRANGE_MODE_TIMED 0x04
sepp_nepp 10:cd1758e186a4 280 /** bit 3 write 1 in #VL53L0X_REG_SYSRANGE_START set histogram operation mode */
sepp_nepp 10:cd1758e186a4 281 #define VL53L0X_REG_SYSRANGE_MODE_HISTOGRAM 0x08
sepp_nepp 10:cd1758e186a4 282 #define VL53L0X_REG_SYSTEM_THRESH_HIGH 0x000C
sepp_nepp 10:cd1758e186a4 283 #define VL53L0X_REG_SYSTEM_THRESH_LOW 0x000E
sepp_nepp 10:cd1758e186a4 284 #define VL53L0X_REG_SYSTEM_SEQUENCE_CONFIG 0x0001
sepp_nepp 10:cd1758e186a4 285 #define VL53L0X_REG_SYSTEM_RANGE_CONFIG 0x0009
sepp_nepp 10:cd1758e186a4 286 #define VL53L0X_REG_SYSTEM_INTERMEASUREMENT_PERIOD 0x0004
sepp_nepp 10:cd1758e186a4 287 #define VL53L0X_REG_SYSTEM_INTERRUPT_CONFIG_GPIO 0x000A
sepp_nepp 10:cd1758e186a4 288 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_DISABLED 0x00
sepp_nepp 10:cd1758e186a4 289 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_LEVEL_LOW 0x01
sepp_nepp 10:cd1758e186a4 290 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_LEVEL_HIGH 0x02
sepp_nepp 10:cd1758e186a4 291 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_OUT_OF_WINDOW 0x03
sepp_nepp 10:cd1758e186a4 292 #define VL53L0X_REG_SYSTEM_INTERRUPT_GPIO_NEW_SAMPLE_READY 0x04
sepp_nepp 10:cd1758e186a4 293 #define VL53L0X_REG_GPIO_HV_MUX_ACTIVE_HIGH 0x0084
sepp_nepp 10:cd1758e186a4 294 #define VL53L0X_REG_SYSTEM_INTERRUPT_CLEAR 0x000B
sepp_nepp 10:cd1758e186a4 295
sepp_nepp 10:cd1758e186a4 296 /* Result registers */
sepp_nepp 10:cd1758e186a4 297 #define VL53L0X_REG_RESULT_INTERRUPT_STATUS 0x0013
sepp_nepp 10:cd1758e186a4 298 #define VL53L0X_REG_RESULT_RANGE_STATUS 0x0014
sepp_nepp 10:cd1758e186a4 299 #define VL53L0X_REG_RESULT_CORE_PAGE 1
sepp_nepp 10:cd1758e186a4 300 #define VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN 0x00BC
sepp_nepp 10:cd1758e186a4 301 #define VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN 0x00C0
sepp_nepp 10:cd1758e186a4 302 #define VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF 0x00D0
sepp_nepp 10:cd1758e186a4 303 #define VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_REF 0x00D4
sepp_nepp 10:cd1758e186a4 304 #define VL53L0X_REG_RESULT_PEAK_SIGNAL_RATE_REF 0x00B6
sepp_nepp 10:cd1758e186a4 305 /* Algo register */
sepp_nepp 10:cd1758e186a4 306 #define VL53L0X_REG_ALGO_PART_TO_PART_RANGE_OFFSET_MM 0x0028
sepp_nepp 10:cd1758e186a4 307 #define VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS 0x008a
sepp_nepp 10:cd1758e186a4 308 /* Check Limit registers */
sepp_nepp 10:cd1758e186a4 309 #define VL53L0X_REG_MSRC_CONFIG_CONTROL 0x0060
sepp_nepp 10:cd1758e186a4 310 #define VL53L0X_REG_PRE_RANGE_CONFIG_MIN_SNR 0X0027
sepp_nepp 10:cd1758e186a4 311 #define VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_LOW 0x0056
sepp_nepp 10:cd1758e186a4 312 #define VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_HIGH 0x0057
sepp_nepp 10:cd1758e186a4 313 #define VL53L0X_REG_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT 0x0064
sepp_nepp 10:cd1758e186a4 314 #define VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_SNR 0X0067
sepp_nepp 10:cd1758e186a4 315 #define VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_LOW 0x0047
sepp_nepp 10:cd1758e186a4 316 #define VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH 0x0048
sepp_nepp 10:cd1758e186a4 317 #define VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT 0x0044
sepp_nepp 10:cd1758e186a4 318 #define VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_HI 0X0061
sepp_nepp 10:cd1758e186a4 319 #define VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_LO 0X0062
sepp_nepp 10:cd1758e186a4 320
sepp_nepp 10:cd1758e186a4 321 /* PRE RANGE registers */
sepp_nepp 10:cd1758e186a4 322 #define VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD 0x0050
sepp_nepp 10:cd1758e186a4 323 #define VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI 0x0051
sepp_nepp 10:cd1758e186a4 324 #define VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO 0x0052
sepp_nepp 10:cd1758e186a4 325 #define VL53L0X_REG_SYSTEM_HISTOGRAM_BIN 0x0081
sepp_nepp 10:cd1758e186a4 326 #define VL53L0X_REG_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT 0x0033
sepp_nepp 10:cd1758e186a4 327 #define VL53L0X_REG_HISTOGRAM_CONFIG_READOUT_CTRL 0x0055
sepp_nepp 10:cd1758e186a4 328 #define VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD 0x0070
sepp_nepp 10:cd1758e186a4 329 #define VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI 0x0071
sepp_nepp 10:cd1758e186a4 330 #define VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO 0x0072
sepp_nepp 11:d8dbe3b87f9f 331 #define VL53L0X_REG_CROSSTALK_COMPENSATION_PEAK_RATE_MHz 0x0020
sepp_nepp 10:cd1758e186a4 332 #define VL53L0X_REG_MSRC_CONFIG_TIMEOUT_MACROP 0x0046
sepp_nepp 10:cd1758e186a4 333 #define VL53L0X_REG_SOFT_RESET_GO2_SOFT_RESET_N 0x00bf
sepp_nepp 10:cd1758e186a4 334 #define VL53L0X_REG_IDENTIFICATION_MODEL_ID 0x00c0
sepp_nepp 10:cd1758e186a4 335 #define VL53L0X_REG_IDENTIFICATION_REVISION_ID 0x00c2
sepp_nepp 10:cd1758e186a4 336 #define VL53L0X_REG_OSC_CALIBRATE_VAL 0x00f8
sepp_nepp 10:cd1758e186a4 337 #define VL53L0X_REG_GLOBAL_CONFIG_VCSEL_WIDTH 0x0032
sepp_nepp 10:cd1758e186a4 338 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_0 0x00B0
sepp_nepp 10:cd1758e186a4 339 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_1 0x00B1
sepp_nepp 10:cd1758e186a4 340 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_2 0x00B2
sepp_nepp 10:cd1758e186a4 341 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_3 0x00B3
sepp_nepp 10:cd1758e186a4 342 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_4 0x00B4
sepp_nepp 10:cd1758e186a4 343 #define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_5 0x00B5
sepp_nepp 10:cd1758e186a4 344 #define VL53L0X_REG_GLOBAL_CONFIG_REF_EN_START_SELECT 0x00B6
sepp_nepp 10:cd1758e186a4 345 #define VL53L0X_REG_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD 0x004E /* 0x14E */
sepp_nepp 10:cd1758e186a4 346 #define VL53L0X_REG_DYNAMIC_SPAD_REF_EN_START_OFFSET 0x004F /* 0x14F */
sepp_nepp 10:cd1758e186a4 347 #define VL53L0X_REG_POWER_MANAGEMENT_GO1_POWER_FORCE 0x0080
sepp_nepp 10:cd1758e186a4 348 #define VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV 0x0089
sepp_nepp 10:cd1758e186a4 349 #define VL53L0X_REG_ALGO_PHASECAL_LIM 0x0030 /* 0x130 */
sepp_nepp 10:cd1758e186a4 350 #define VL53L0X_REG_ALGO_PHASECAL_CONFIG_TIMEOUT 0x0030
sepp_nepp 10:cd1758e186a4 351 /** @} VL53L0X_DefineRegisters_group */
sepp_nepp 10:cd1758e186a4 352
sepp_nepp 10:cd1758e186a4 353
sepp_nepp 10:cd1758e186a4 354 static uint8_t DefaultTuningSettings[] = {
sepp_nepp 10:cd1758e186a4 355
sepp_nepp 10:cd1758e186a4 356 /* update 02/11/2015_v36 */
sepp_nepp 10:cd1758e186a4 357 0x01, 0xFF, 0x01, 0x01, 0x00, 0x00, 0x01, 0xFF, 0x00, 0x01, 0x09, 0x00,
sepp_nepp 10:cd1758e186a4 358 0x01, 0x10, 0x00, 0x01, 0x11, 0x00, 0x01, 0x24, 0x01, 0x01, 0x25, 0xff,
sepp_nepp 10:cd1758e186a4 359 0x01, 0x75, 0x00, 0x01, 0xFF, 0x01, 0x01, 0x4e, 0x2c, 0x01, 0x48, 0x00,
sepp_nepp 10:cd1758e186a4 360 0x01, 0x30, 0x20, 0x01, 0xFF, 0x00, 0x01, 0x30, 0x09, /* mja changed from 0x64. */
sepp_nepp 10:cd1758e186a4 361 0x01, 0x54, 0x00, 0x01, 0x31, 0x04, 0x01, 0x32, 0x03, 0x01, 0x40, 0x83,
sepp_nepp 10:cd1758e186a4 362 0x01, 0x46, 0x25, 0x01, 0x60, 0x00, 0x01, 0x27, 0x00, 0x01, 0x50, 0x06,
sepp_nepp 10:cd1758e186a4 363 0x01, 0x51, 0x00, 0x01, 0x52, 0x96, 0x01, 0x56, 0x08, 0x01, 0x57, 0x30,
sepp_nepp 10:cd1758e186a4 364 0x01, 0x61, 0x00, 0x01, 0x62, 0x00, 0x01, 0x64, 0x00, 0x01, 0x65, 0x00,
sepp_nepp 10:cd1758e186a4 365 0x01, 0x66, 0xa0, 0x01, 0xFF, 0x01, 0x01, 0x22, 0x32, 0x01, 0x47, 0x14,
sepp_nepp 10:cd1758e186a4 366 0x01, 0x49, 0xff, 0x01, 0x4a, 0x00, 0x01, 0xFF, 0x00, 0x01, 0x7a, 0x0a,
sepp_nepp 10:cd1758e186a4 367 0x01, 0x7b, 0x00, 0x01, 0x78, 0x21, 0x01, 0xFF, 0x01, 0x01, 0x23, 0x34,
sepp_nepp 10:cd1758e186a4 368 0x01, 0x42, 0x00, 0x01, 0x44, 0xff, 0x01, 0x45, 0x26, 0x01, 0x46, 0x05,
sepp_nepp 10:cd1758e186a4 369 0x01, 0x40, 0x40, 0x01, 0x0E, 0x06, 0x01, 0x20, 0x1a, 0x01, 0x43, 0x40,
sepp_nepp 10:cd1758e186a4 370 0x01, 0xFF, 0x00, 0x01, 0x34, 0x03, 0x01, 0x35, 0x44, 0x01, 0xFF, 0x01,
sepp_nepp 10:cd1758e186a4 371 0x01, 0x31, 0x04, 0x01, 0x4b, 0x09, 0x01, 0x4c, 0x05, 0x01, 0x4d, 0x04,
sepp_nepp 10:cd1758e186a4 372 0x01, 0xFF, 0x00, 0x01, 0x44, 0x00, 0x01, 0x45, 0x20, 0x01, 0x47, 0x08,
sepp_nepp 10:cd1758e186a4 373 0x01, 0x48, 0x28, 0x01, 0x67, 0x00, 0x01, 0x70, 0x04, 0x01, 0x71, 0x01,
sepp_nepp 10:cd1758e186a4 374 0x01, 0x72, 0xfe, 0x01, 0x76, 0x00, 0x01, 0x77, 0x00, 0x01, 0xFF, 0x01,
sepp_nepp 10:cd1758e186a4 375 0x01, 0x0d, 0x01, 0x01, 0xFF, 0x00, 0x01, 0x80, 0x01, 0x01, 0x01, 0xF8,
sepp_nepp 10:cd1758e186a4 376 0x01, 0xFF, 0x01, 0x01, 0x8e, 0x01, 0x01, 0x00, 0x01, 0x01, 0xFF, 0x00,
sepp_nepp 10:cd1758e186a4 377 0x01, 0x80, 0x00, 0x00, 0x00, 0x00
sepp_nepp 10:cd1758e186a4 378 };
sepp_nepp 10:cd1758e186a4 379
sepp_nepp 10:cd1758e186a4 380 static uint8_t InterruptThresholdSettings[] = {
sepp_nepp 10:cd1758e186a4 381 /* Start of Interrupt Threshold Settings */
sepp_nepp 10:cd1758e186a4 382 0x1, 0xff, 0x00, 0x1, 0x80, 0x01, 0x1, 0xff, 0x01, 0x1, 0x00, 0x00,
sepp_nepp 10:cd1758e186a4 383 0x1, 0xff, 0x01, 0x1, 0x4f, 0x02, 0x1, 0xFF, 0x0E, 0x1, 0x00, 0x03,
sepp_nepp 10:cd1758e186a4 384 0x1, 0x01, 0x84, 0x1, 0x02, 0x0A, 0x1, 0x03, 0x03, 0x1, 0x04, 0x08,
sepp_nepp 10:cd1758e186a4 385 0x1, 0x05, 0xC8, 0x1, 0x06, 0x03, 0x1, 0x07, 0x8D, 0x1, 0x08, 0x08,
sepp_nepp 10:cd1758e186a4 386 0x1, 0x09, 0xC6, 0x1, 0x0A, 0x01, 0x1, 0x0B, 0x02, 0x1, 0x0C, 0x00,
sepp_nepp 10:cd1758e186a4 387 0x1, 0x0D, 0xD5, 0x1, 0x0E, 0x18, 0x1, 0x0F, 0x12, 0x1, 0x10, 0x01,
sepp_nepp 10:cd1758e186a4 388 0x1, 0x11, 0x82, 0x1, 0x12, 0x00, 0x1, 0x13, 0xD5, 0x1, 0x14, 0x18,
sepp_nepp 10:cd1758e186a4 389 0x1, 0x15, 0x13, 0x1, 0x16, 0x03, 0x1, 0x17, 0x86, 0x1, 0x18, 0x0A,
sepp_nepp 10:cd1758e186a4 390 0x1, 0x19, 0x09, 0x1, 0x1A, 0x08, 0x1, 0x1B, 0xC2, 0x1, 0x1C, 0x03,
sepp_nepp 10:cd1758e186a4 391 0x1, 0x1D, 0x8F, 0x1, 0x1E, 0x0A, 0x1, 0x1F, 0x06, 0x1, 0x20, 0x01,
sepp_nepp 10:cd1758e186a4 392 0x1, 0x21, 0x02, 0x1, 0x22, 0x00, 0x1, 0x23, 0xD5, 0x1, 0x24, 0x18,
sepp_nepp 10:cd1758e186a4 393 0x1, 0x25, 0x22, 0x1, 0x26, 0x01, 0x1, 0x27, 0x82, 0x1, 0x28, 0x00,
sepp_nepp 10:cd1758e186a4 394 0x1, 0x29, 0xD5, 0x1, 0x2A, 0x18, 0x1, 0x2B, 0x0B, 0x1, 0x2C, 0x28,
sepp_nepp 10:cd1758e186a4 395 0x1, 0x2D, 0x78, 0x1, 0x2E, 0x28, 0x1, 0x2F, 0x91, 0x1, 0x30, 0x00,
sepp_nepp 10:cd1758e186a4 396 0x1, 0x31, 0x0B, 0x1, 0x32, 0x00, 0x1, 0x33, 0x0B, 0x1, 0x34, 0x00,
sepp_nepp 10:cd1758e186a4 397 0x1, 0x35, 0xA1, 0x1, 0x36, 0x00, 0x1, 0x37, 0xA0, 0x1, 0x38, 0x00,
sepp_nepp 10:cd1758e186a4 398 0x1, 0x39, 0x04, 0x1, 0x3A, 0x28, 0x1, 0x3B, 0x30, 0x1, 0x3C, 0x0C,
sepp_nepp 10:cd1758e186a4 399 0x1, 0x3D, 0x04, 0x1, 0x3E, 0x0F, 0x1, 0x3F, 0x79, 0x1, 0x40, 0x28,
sepp_nepp 10:cd1758e186a4 400 0x1, 0x41, 0x1E, 0x1, 0x42, 0x2F, 0x1, 0x43, 0x87, 0x1, 0x44, 0x00,
sepp_nepp 10:cd1758e186a4 401 0x1, 0x45, 0x0B, 0x1, 0x46, 0x00, 0x1, 0x47, 0x0B, 0x1, 0x48, 0x00,
sepp_nepp 10:cd1758e186a4 402 0x1, 0x49, 0xA7, 0x1, 0x4A, 0x00, 0x1, 0x4B, 0xA6, 0x1, 0x4C, 0x00,
sepp_nepp 10:cd1758e186a4 403 0x1, 0x4D, 0x04, 0x1, 0x4E, 0x01, 0x1, 0x4F, 0x00, 0x1, 0x50, 0x00,
sepp_nepp 10:cd1758e186a4 404 0x1, 0x51, 0x80, 0x1, 0x52, 0x09, 0x1, 0x53, 0x08, 0x1, 0x54, 0x01,
sepp_nepp 10:cd1758e186a4 405 0x1, 0x55, 0x00, 0x1, 0x56, 0x0F, 0x1, 0x57, 0x79, 0x1, 0x58, 0x09,
sepp_nepp 10:cd1758e186a4 406 0x1, 0x59, 0x05, 0x1, 0x5A, 0x00, 0x1, 0x5B, 0x60, 0x1, 0x5C, 0x05,
sepp_nepp 10:cd1758e186a4 407 0x1, 0x5D, 0xD1, 0x1, 0x5E, 0x0C, 0x1, 0x5F, 0x3C, 0x1, 0x60, 0x00,
sepp_nepp 10:cd1758e186a4 408 0x1, 0x61, 0xD0, 0x1, 0x62, 0x0B, 0x1, 0x63, 0x03, 0x1, 0x64, 0x28,
sepp_nepp 10:cd1758e186a4 409 0x1, 0x65, 0x10, 0x1, 0x66, 0x2A, 0x1, 0x67, 0x39, 0x1, 0x68, 0x0B,
sepp_nepp 10:cd1758e186a4 410 0x1, 0x69, 0x02, 0x1, 0x6A, 0x28, 0x1, 0x6B, 0x10, 0x1, 0x6C, 0x2A,
sepp_nepp 10:cd1758e186a4 411 0x1, 0x6D, 0x61, 0x1, 0x6E, 0x0C, 0x1, 0x6F, 0x00, 0x1, 0x70, 0x0F,
sepp_nepp 10:cd1758e186a4 412 0x1, 0x71, 0x79, 0x1, 0x72, 0x00, 0x1, 0x73, 0x0B, 0x1, 0x74, 0x00,
sepp_nepp 10:cd1758e186a4 413 0x1, 0x75, 0x0B, 0x1, 0x76, 0x00, 0x1, 0x77, 0xA1, 0x1, 0x78, 0x00,
sepp_nepp 10:cd1758e186a4 414 0x1, 0x79, 0xA0, 0x1, 0x7A, 0x00, 0x1, 0x7B, 0x04, 0x1, 0xFF, 0x04,
sepp_nepp 10:cd1758e186a4 415 0x1, 0x79, 0x1D, 0x1, 0x7B, 0x27, 0x1, 0x96, 0x0E, 0x1, 0x97, 0xFE,
sepp_nepp 10:cd1758e186a4 416 0x1, 0x98, 0x03, 0x1, 0x99, 0xEF, 0x1, 0x9A, 0x02, 0x1, 0x9B, 0x44,
sepp_nepp 10:cd1758e186a4 417 0x1, 0x73, 0x07, 0x1, 0x70, 0x01, 0x1, 0xff, 0x01, 0x1, 0x00, 0x01,
sepp_nepp 10:cd1758e186a4 418 0x1, 0xff, 0x00,
sepp_nepp 10:cd1758e186a4 419 0x0, 0x00, 0x00};
sepp_nepp 10:cd1758e186a4 420
sepp_nepp 6:fb11b746ceb5 421 /** @defgroup VL53L0X_GpioFunctionality_group Gpio Functionality
sepp_nepp 6:fb11b746ceb5 422 * @brief Defines the different functionalities for the device GPIO(s)
sepp_nepp 10:cd1758e186a4 423 * @{ */
sepp_nepp 6:fb11b746ceb5 424 typedef uint8_t VL53L0X_GpioFunctionality;
sepp_nepp 6:fb11b746ceb5 425 #define VL53L0X_GPIOFUNCTIONALITY_OFF \
sepp_nepp 6:fb11b746ceb5 426 ((VL53L0X_GpioFunctionality) 0) /*!< NO Interrupt */
sepp_nepp 6:fb11b746ceb5 427 #define VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_LOW \
sepp_nepp 6:fb11b746ceb5 428 ((VL53L0X_GpioFunctionality) 1) /*!< Level Low (value < thresh_low) */
sepp_nepp 6:fb11b746ceb5 429 #define VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_HIGH \
sepp_nepp 6:fb11b746ceb5 430 ((VL53L0X_GpioFunctionality) 2) /*!< Level High (value > thresh_high) */
sepp_nepp 6:fb11b746ceb5 431 #define VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_OUT \
sepp_nepp 6:fb11b746ceb5 432 ((VL53L0X_GpioFunctionality) 3)
sepp_nepp 6:fb11b746ceb5 433 /*!< Out Of Window (value < thresh_low OR value > thresh_high) */
sepp_nepp 6:fb11b746ceb5 434 #define VL53L0X_GPIOFUNCTIONALITY_NEW_MEASURE_READY \
sepp_nepp 6:fb11b746ceb5 435 ((VL53L0X_GpioFunctionality) 4) /*!< New Sample Ready */
sepp_nepp 6:fb11b746ceb5 436 /** @} end of VL53L0X_GpioFunctionality_group */
sepp_nepp 6:fb11b746ceb5 437
sepp_nepp 6:fb11b746ceb5 438
sepp_nepp 10:cd1758e186a4 439 /** @brief Defines the parameters of the Get Version Functions */
sepp_nepp 6:fb11b746ceb5 440 typedef struct {
sepp_nepp 6:fb11b746ceb5 441 uint32_t revision; /*!< revision number */
sepp_nepp 6:fb11b746ceb5 442 uint8_t major; /*!< major number */
sepp_nepp 6:fb11b746ceb5 443 uint8_t minor; /*!< minor number */
sepp_nepp 6:fb11b746ceb5 444 uint8_t build; /*!< build number */
sepp_nepp 6:fb11b746ceb5 445 } VL53L0X_Version_t;
sepp_nepp 6:fb11b746ceb5 446
sepp_nepp 6:fb11b746ceb5 447 /** @defgroup VL53L0X_define_Error_group Error and Warning code returned by API
sepp_nepp 6:fb11b746ceb5 448 * The following DEFINE are used to identify the PAL ERROR
sepp_nepp 6:fb11b746ceb5 449 * @{ */
sepp_nepp 6:fb11b746ceb5 450 typedef int8_t VL53L0X_Error;
sepp_nepp 11:d8dbe3b87f9f 451 #define VL53L0X_ERROR_NONE ((VL53L0X_Error) 0)
sepp_nepp 11:d8dbe3b87f9f 452 #define VL53L0X_ERROR_CALIBRATION_WARNING ((VL53L0X_Error) -1)
sepp_nepp 6:fb11b746ceb5 453 /*!< Warning invalid calibration data may be in used
sepp_nepp 6:fb11b746ceb5 454 \a VL53L0X_InitData()
sepp_nepp 6:fb11b746ceb5 455 \a VL53L0X_GetOffsetCalibrationData
sepp_nepp 6:fb11b746ceb5 456 \a VL53L0X_SetOffsetCalibrationData */
sepp_nepp 11:d8dbe3b87f9f 457 #define VL53L0X_ERROR_MIN_CLIPPED ((VL53L0X_Error) -2)
sepp_nepp 6:fb11b746ceb5 458 /*!< Warning parameter passed was clipped to min before to be applied */
sepp_nepp 11:d8dbe3b87f9f 459 #define VL53L0X_ERROR_UNDEFINED ((VL53L0X_Error) -3)
sepp_nepp 6:fb11b746ceb5 460 /*!< Unqualified error */
sepp_nepp 11:d8dbe3b87f9f 461 #define VL53L0X_ERROR_INVALID_PARAMS ((VL53L0X_Error) -4)
sepp_nepp 6:fb11b746ceb5 462 /*!< Parameter passed is invalid or out of range */
sepp_nepp 11:d8dbe3b87f9f 463 #define VL53L0X_ERROR_NOT_SUPPORTED ((VL53L0X_Error) -5)
sepp_nepp 6:fb11b746ceb5 464 /*!< Function is not supported in current mode or configuration */
sepp_nepp 11:d8dbe3b87f9f 465 #define VL53L0X_ERROR_RANGE_ERROR ((VL53L0X_Error) -6)
sepp_nepp 6:fb11b746ceb5 466 /*!< Device report a ranging error interrupt status */
sepp_nepp 11:d8dbe3b87f9f 467 #define VL53L0X_ERROR_TIME_OUT ((VL53L0X_Error) -7)
sepp_nepp 6:fb11b746ceb5 468 /*!< Aborted due to time out */
sepp_nepp 11:d8dbe3b87f9f 469 #define VL53L0X_ERROR_MODE_NOT_SUPPORTED ((VL53L0X_Error) -8)
sepp_nepp 6:fb11b746ceb5 470 /*!< Asked mode is not supported by the device */
sepp_nepp 11:d8dbe3b87f9f 471 #define VL53L0X_ERROR_BUFFER_TOO_SMALL ((VL53L0X_Error) -9)
sepp_nepp 6:fb11b746ceb5 472 /*!< ... */
sepp_nepp 11:d8dbe3b87f9f 473 #define VL53L0X_ERROR_GPIO_NOT_EXISTING ((VL53L0X_Error) -10)
sepp_nepp 6:fb11b746ceb5 474 /*!< User tried to setup a non-existing GPIO pin */
sepp_nepp 6:fb11b746ceb5 475 #define VL53L0X_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED ((VL53L0X_Error) -11)
sepp_nepp 6:fb11b746ceb5 476 /*!< unsupported GPIO functionality */
sepp_nepp 11:d8dbe3b87f9f 477 #define VL53L0X_ERROR_INTERRUPT_NOT_CLEARED ((VL53L0X_Error) -12)
sepp_nepp 6:fb11b746ceb5 478 /*!< Error during interrupt clear */
sepp_nepp 11:d8dbe3b87f9f 479 #define VL53L0X_ERROR_CONTROL_INTERFACE ((VL53L0X_Error) -20)
sepp_nepp 6:fb11b746ceb5 480 /*!< error reported from IO functions */
sepp_nepp 11:d8dbe3b87f9f 481 #define VL53L0X_ERROR_INVALID_COMMAND ((VL53L0X_Error) -30)
sepp_nepp 11:d8dbe3b87f9f 482 /*!< The command is not allowed in the current device state (power down) */
sepp_nepp 11:d8dbe3b87f9f 483 #define VL53L0X_ERROR_DIVISION_BY_ZERO ((VL53L0X_Error) -40)
sepp_nepp 6:fb11b746ceb5 484 /*!< In the function a division by zero occurs */
sepp_nepp 6:fb11b746ceb5 485 #define VL53L0X_ERROR_REF_SPAD_INIT ((VL53L0X_Error) -50)
sepp_nepp 6:fb11b746ceb5 486 /*!< Error during reference SPAD initialization */
sepp_nepp 6:fb11b746ceb5 487 /** @} VL53L0X_define_Error_group */
sepp_nepp 6:fb11b746ceb5 488
sepp_nepp 6:fb11b746ceb5 489
sepp_nepp 6:fb11b746ceb5 490 /** @defgroup VL53L0X_define_DeviceModes_group Defines Device modes
sepp_nepp 6:fb11b746ceb5 491 * Defines all possible modes for the device
sepp_nepp 10:cd1758e186a4 492 * @{ */
sepp_nepp 6:fb11b746ceb5 493 typedef uint8_t VL53L0X_DeviceModes;
sepp_nepp 6:fb11b746ceb5 494 #define VL53L0X_DEVICEMODE_SINGLE_RANGING ((VL53L0X_DeviceModes) 0)
sepp_nepp 6:fb11b746ceb5 495 #define VL53L0X_DEVICEMODE_CONTINUOUS_RANGING ((VL53L0X_DeviceModes) 1)
sepp_nepp 6:fb11b746ceb5 496 #define VL53L0X_DEVICEMODE_CONTINUOUS_TIMED_RANGING ((VL53L0X_DeviceModes) 3)
sepp_nepp 6:fb11b746ceb5 497 #define VL53L0X_DEVICEMODE_SINGLE_ALS ((VL53L0X_DeviceModes) 10)
sepp_nepp 6:fb11b746ceb5 498 #define VL53L0X_DEVICEMODE_GPIO_DRIVE ((VL53L0X_DeviceModes) 20)
sepp_nepp 6:fb11b746ceb5 499 #define VL53L0X_DEVICEMODE_GPIO_OSC ((VL53L0X_DeviceModes) 21)
sepp_nepp 6:fb11b746ceb5 500 /* ... Modes to be added depending on device */
sepp_nepp 6:fb11b746ceb5 501 /** @} VL53L0X_define_DeviceModes_group */
sepp_nepp 6:fb11b746ceb5 502
sepp_nepp 6:fb11b746ceb5 503
sepp_nepp 6:fb11b746ceb5 504 /** @defgroup VL53L0X_define_PowerModes_group List of available Power Modes
sepp_nepp 6:fb11b746ceb5 505 * List of available Power Modes
sepp_nepp 10:cd1758e186a4 506 * @{ */
sepp_nepp 6:fb11b746ceb5 507 typedef uint8_t VL53L0X_PowerModes;
sepp_nepp 6:fb11b746ceb5 508 #define VL53L0X_POWERMODE_STANDBY_LEVEL1 ((VL53L0X_PowerModes) 0)
sepp_nepp 6:fb11b746ceb5 509 /*!< Standby level 1 */
sepp_nepp 6:fb11b746ceb5 510 #define VL53L0X_POWERMODE_STANDBY_LEVEL2 ((VL53L0X_PowerModes) 1)
sepp_nepp 6:fb11b746ceb5 511 /*!< Standby level 2 */
sepp_nepp 6:fb11b746ceb5 512 #define VL53L0X_POWERMODE_IDLE_LEVEL1 ((VL53L0X_PowerModes) 2)
sepp_nepp 6:fb11b746ceb5 513 /*!< Idle level 1 */
sepp_nepp 6:fb11b746ceb5 514 #define VL53L0X_POWERMODE_IDLE_LEVEL2 ((VL53L0X_PowerModes) 3)
sepp_nepp 6:fb11b746ceb5 515 /*!< Idle level 2 */
sepp_nepp 6:fb11b746ceb5 516 /** @} VL53L0X_define_PowerModes_group */
sepp_nepp 6:fb11b746ceb5 517
sepp_nepp 10:cd1758e186a4 518 /** @defgroup VL53L0X_define_State_group Defines the current status of the device
sepp_nepp 10:cd1758e186a4 519 * Defines the current status of the device
sepp_nepp 10:cd1758e186a4 520 * @{ */
sepp_nepp 10:cd1758e186a4 521 typedef uint8_t VL53L0X_State;
sepp_nepp 10:cd1758e186a4 522 #define VL53L0X_STATE_POWERDOWN ((VL53L0X_State) 0)
sepp_nepp 10:cd1758e186a4 523 /*!< Device is in HW reset */
sepp_nepp 10:cd1758e186a4 524 #define VL53L0X_STATE_WAIT_STATICINIT ((VL53L0X_State) 1)
sepp_nepp 10:cd1758e186a4 525 /*!< Device is initialized and wait for static initialization */
sepp_nepp 10:cd1758e186a4 526 #define VL53L0X_STATE_STANDBY ((VL53L0X_State) 2)
sepp_nepp 10:cd1758e186a4 527 /*!< Device is in Low power Standby mode */
sepp_nepp 10:cd1758e186a4 528 #define VL53L0X_STATE_IDLE ((VL53L0X_State) 3)
sepp_nepp 10:cd1758e186a4 529 /*!< Device has been initialized and ready to do measurements */
sepp_nepp 10:cd1758e186a4 530 #define VL53L0X_STATE_RUNNING ((VL53L0X_State) 4)
sepp_nepp 10:cd1758e186a4 531 /*!< Device is performing measurement */
sepp_nepp 10:cd1758e186a4 532 #define VL53L0X_STATE_UNKNOWN ((VL53L0X_State) 98)
sepp_nepp 10:cd1758e186a4 533 /*!< Device is in unknown state and need to be rebooted */
sepp_nepp 10:cd1758e186a4 534 #define VL53L0X_STATE_ERROR ((VL53L0X_State) 99)
sepp_nepp 10:cd1758e186a4 535 /*!< Device is in error state and need to be rebooted */
sepp_nepp 10:cd1758e186a4 536 /** @} VL53L0X_define_State_group */
sepp_nepp 6:fb11b746ceb5 537
sepp_nepp 10:cd1758e186a4 538
sepp_nepp 10:cd1758e186a4 539 /** @brief Defines the parameters of the Get Device Info Functions */
sepp_nepp 10:cd1758e186a4 540 typedef struct {
sepp_nepp 10:cd1758e186a4 541 char Name[VL53L0X_MAX_STRING_LENGTH];
sepp_nepp 10:cd1758e186a4 542 /*!< Name of the Device e.g. Left_Distance */
sepp_nepp 10:cd1758e186a4 543 char Type[VL53L0X_MAX_STRING_LENGTH];
sepp_nepp 10:cd1758e186a4 544 /*!< Type of the Device e.g VL53L0X */
sepp_nepp 10:cd1758e186a4 545 char ProductId[VL53L0X_MAX_STRING_LENGTH];
sepp_nepp 10:cd1758e186a4 546 /*!< Product Identifier String */
sepp_nepp 10:cd1758e186a4 547 uint8_t ProductType;
sepp_nepp 10:cd1758e186a4 548 /*!< Product Type, VL53L0X = 1, VL53L1 = 2 */
sepp_nepp 10:cd1758e186a4 549 uint8_t ProductRevisionMajor;
sepp_nepp 10:cd1758e186a4 550 /*!< Product revision major */
sepp_nepp 10:cd1758e186a4 551 uint8_t ProductRevisionMinor;
sepp_nepp 10:cd1758e186a4 552 /*!< Product revision minor */
sepp_nepp 10:cd1758e186a4 553 } VL53L0X_DeviceInfo_t;
sepp_nepp 10:cd1758e186a4 554
sepp_nepp 10:cd1758e186a4 555 /** @brief Defines all parameters for the device */
sepp_nepp 6:fb11b746ceb5 556 typedef struct {
sepp_nepp 6:fb11b746ceb5 557 VL53L0X_DeviceModes DeviceMode;
sepp_nepp 11:d8dbe3b87f9f 558 /*!< Defines type of measurement to be done for the next measurement */
sepp_nepp 11:d8dbe3b87f9f 559 uint32_t MeasurementTimingBudget_us;
sepp_nepp 6:fb11b746ceb5 560 /*!< Defines the allowed total time for a single measurement */
sepp_nepp 11:d8dbe3b87f9f 561 uint32_t InterMeasurementPeriod_ms;
sepp_nepp 6:fb11b746ceb5 562 /*!< Defines time between two consecutive measurements (between two
sepp_nepp 6:fb11b746ceb5 563 * measurement starts). If set to 0 means back-to-back mode */
sepp_nepp 6:fb11b746ceb5 564 uint8_t XTalkCompensationEnable;
sepp_nepp 6:fb11b746ceb5 565 /*!< Tells if Crosstalk compensation shall be enable or not */
sepp_nepp 11:d8dbe3b87f9f 566 uint16_t XTalkCompensationRange_mm;
sepp_nepp 11:d8dbe3b87f9f 567 /*!< CrossTalk compensation range in _mm */
sepp_nepp 11:d8dbe3b87f9f 568 FixPoint1616_t XTalkCompensationRate_MHz;
sepp_nepp 6:fb11b746ceb5 569 /*!< CrossTalk compensation rate in Mega counts per seconds.
sepp_nepp 6:fb11b746ceb5 570 * Expressed in 16.16 fixed point format. */
sepp_nepp 11:d8dbe3b87f9f 571 int32_t RangeOffset_um;
sepp_nepp 11:d8dbe3b87f9f 572 /*!< Range offset adjustment (mm) last programmed. */
sepp_nepp 6:fb11b746ceb5 573 uint8_t LimitChecksEnable[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
sepp_nepp 11:d8dbe3b87f9f 574 /*!< This Array store all the 6 Limit Check enables for this device. */
sepp_nepp 6:fb11b746ceb5 575 uint8_t LimitChecksStatus[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
sepp_nepp 11:d8dbe3b87f9f 576 /*!< This Array store all the 6 Status of the check linked to last measurement. */
sepp_nepp 6:fb11b746ceb5 577 FixPoint1616_t LimitChecksValue[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
sepp_nepp 6:fb11b746ceb5 578 /*!< This Array store all the Limit Check value for this device */
sepp_nepp 6:fb11b746ceb5 579 uint8_t WrapAroundCheckEnable;
sepp_nepp 6:fb11b746ceb5 580 /*!< Tells if Wrap Around Check shall be enable or not */
sepp_nepp 6:fb11b746ceb5 581 } VL53L0X_DeviceParameters_t;
sepp_nepp 6:fb11b746ceb5 582
sepp_nepp 6:fb11b746ceb5 583 /**
sepp_nepp 6:fb11b746ceb5 584 * @struct VL53L0X_RangeData_t
sepp_nepp 10:cd1758e186a4 585 * @brief Range measurement data. */
sepp_nepp 6:fb11b746ceb5 586 typedef struct {
sepp_nepp 11:d8dbe3b87f9f 587 uint16_t Range_mm; /*!< range distance in _mm. */
sepp_nepp 11:d8dbe3b87f9f 588 uint16_t RangeDMax_mm; /*!< Tells what is the maximum detection distance of the device
sepp_nepp 6:fb11b746ceb5 589 * in current setup and environment conditions (Filled when applicable) */
sepp_nepp 12:81f37e50f8f8 590 FixPoint1616_t SignalRateRtn_MHz; /*!< Return signal rate (MHz), as 16.16 fix point, effectively a measure of target reflectance.*/
sepp_nepp 12:81f37e50f8f8 591 FixPoint1616_t AmbientRateRtn_MHz; /*!< Return ambient rate (MHz), as 16.16 fix point, effectively a measure of the ambient light.*/
sepp_nepp 12:81f37e50f8f8 592 uint16_t EffectiveSpadRtnCount; /*!< Return the effective SPAD count for the return signal, as a 8.8 fix point value. */
sepp_nepp 12:81f37e50f8f8 593 uint8_t RangeFractionalPart; /*!< Fractional part of range distance. Final value is a FixPoint168 value.; only noise :( */
sepp_nepp 12:81f37e50f8f8 594 uint8_t RangeStatus; /*!< Range Status for the current measurement. Value = 0 means value is valid. See \ref RangeStatusPage */
sepp_nepp 12:81f37e50f8f8 595 FixPoint1616_t SigmaEstimate; /*!< Estimated Sigma - based on ambient & VCSEL rates and signal_total_events */
sepp_nepp 6:fb11b746ceb5 596 } VL53L0X_RangingMeasurementData_t;
sepp_nepp 6:fb11b746ceb5 597
sepp_nepp 6:fb11b746ceb5 598
sepp_nepp 6:fb11b746ceb5 599 #define VL53L0X_REF_SPAD_BUFFER_SIZE 6
sepp_nepp 6:fb11b746ceb5 600 typedef struct {
sepp_nepp 6:fb11b746ceb5 601 // merged in here all parts of "VL53L0X_DeviceSpecificParameters_t DeviceSpecificParameters;"
sepp_nepp 11:d8dbe3b87f9f 602 FixPoint1616_t OscFrequency_MHz; /* Frequency used */
sepp_nepp 6:fb11b746ceb5 603 uint16_t LastEncodedTimeout; /* last encoded Time out used for timing budget*/
sepp_nepp 6:fb11b746ceb5 604 VL53L0X_GpioFunctionality Pin0GpioFunctionality; /* store the functionality of the GPIO: pin0 */
sepp_nepp 11:d8dbe3b87f9f 605 uint32_t FinalRangeTimeout_us;/*!< Execution time of the final range*/
sepp_nepp 6:fb11b746ceb5 606 uint8_t FinalRangeVcselPulsePeriod; /*!< Vcsel pulse period (pll clocks) for the final range measurement*/
sepp_nepp 11:d8dbe3b87f9f 607 uint32_t PreRangeTimeout_us; /*!< Execution time of the final range*/
sepp_nepp 6:fb11b746ceb5 608 uint8_t PreRangeVcselPulsePeriod; /*!< Vcsel pulse period (pll clocks) for the pre-range measurement*/
sepp_nepp 6:fb11b746ceb5 609 uint8_t ReadDataFromDeviceDone; /* Indicate if read from device has been done (==1) or not (==0) */
sepp_nepp 6:fb11b746ceb5 610 uint8_t ModuleId; /* Module ID */
sepp_nepp 6:fb11b746ceb5 611 uint8_t Revision; /* test Revision */
sepp_nepp 6:fb11b746ceb5 612 char ProductId[VL53L0X_MAX_STRING_LENGTH]; /* Product Identifier String */
sepp_nepp 6:fb11b746ceb5 613 uint8_t ReferenceSpadCount; /* used for ref spad management */
sepp_nepp 6:fb11b746ceb5 614 uint8_t ReferenceSpadType; /* used for ref spad management */
sepp_nepp 6:fb11b746ceb5 615 uint8_t RefSpadsInitialised; /* reports if ref spads are initialised. */
sepp_nepp 6:fb11b746ceb5 616 uint32_t PartUIDUpper; /*!< Unique Part ID Upper */
sepp_nepp 6:fb11b746ceb5 617 uint32_t PartUIDLower; /*!< Unique Part ID Lower */
sepp_nepp 6:fb11b746ceb5 618 FixPoint1616_t SignalRateMeasFixed400mm; /*!< Peek Signal rate at 400 mm*/
sepp_nepp 11:d8dbe3b87f9f 619
sepp_nepp 11:d8dbe3b87f9f 620 // Merged in here the VL53L0X_SpadData_t SpadData; /*!< Spad Data; Enables and Good-Map */
sepp_nepp 11:d8dbe3b87f9f 621 uint8_t RefSpadEnables[VL53L0X_REF_SPAD_BUFFER_SIZE]; /*!< Reference Spad Enables */
sepp_nepp 11:d8dbe3b87f9f 622 uint8_t RefGoodSpadMap[VL53L0X_REF_SPAD_BUFFER_SIZE]; /*!< Reference Spad Good Spad Map */
sepp_nepp 11:d8dbe3b87f9f 623
sepp_nepp 8:2fd7cb217068 624 // Merged in here all parts of DeviceParams_t
sepp_nepp 11:d8dbe3b87f9f 625 int32_t Part2PartOffsetNVM_um; /*!< backed up NVM value */
sepp_nepp 11:d8dbe3b87f9f 626 int32_t Part2PartOffsetAdjustNVM_um; /*!< backed up NVM value representing additional offset adjustment */
sepp_nepp 6:fb11b746ceb5 627 uint8_t SequenceConfig; /*!< Internal value for the sequence config */
sepp_nepp 6:fb11b746ceb5 628 uint8_t RangeFractionalEnable; /*!< Enable/Disable fractional part of ranging data */
sepp_nepp 6:fb11b746ceb5 629 VL53L0X_State PalState; /*!< Current state of the PAL for this device */
sepp_nepp 6:fb11b746ceb5 630 VL53L0X_PowerModes PowerMode; /*!< Current Power Mode; Stdby1/2, Idle1/2 */
sepp_nepp 6:fb11b746ceb5 631 uint16_t SigmaEstRefArray; /*!< Reference array sigma value in 1/100th of [mm] e.g. 100 = 1mm; loaded from tuning settings */
sepp_nepp 6:fb11b746ceb5 632 uint16_t SigmaEstEffPulseWidth; /*!< Effective Pulse width for sigma estimate in 1/100th of ns e.g. 900 = 9.0ns */
sepp_nepp 6:fb11b746ceb5 633 uint16_t SigmaEstEffAmbWidth; /*!< Effective Ambient width for sigma estimate in 1/100th of ns e.g. 500 = 5.0ns */
sepp_nepp 6:fb11b746ceb5 634 uint8_t StopVariable; /*!< StopVariable used during the stop sequence */
sepp_nepp 6:fb11b746ceb5 635 uint16_t targetRefRate; /*!< Target Ambient Rate for Ref spad management */
sepp_nepp 11:d8dbe3b87f9f 636 FixPoint1616_t LastSignalRef_MHz; /*!< Latest Signal ref in MHz */
sepp_nepp 11:d8dbe3b87f9f 637 uint8_t *pTuningSettingsPointer; /*!< Pointer for alternative Tuning Settings table */
sepp_nepp 11:d8dbe3b87f9f 638 uint8_t UseInternalTuningSettings; /*!< Indicate if we use Tuning Settings table, default = True */
sepp_nepp 6:fb11b746ceb5 639 uint16_t LinearityCorrectiveGain; /*!< Linearity Corrective Gain value in x1000 */
sepp_nepp 11:d8dbe3b87f9f 640 uint16_t DmaxCalRange_mm; /*!< Dmax Calibration Range _mm */
sepp_nepp 11:d8dbe3b87f9f 641 FixPoint1616_t DmaxCalSignalRateRtn_MHz;/*!< Dmax Calibration Signal Rate Return _MHz */
sepp_nepp 8:2fd7cb217068 642
sepp_nepp 6:fb11b746ceb5 643 } VL53L0X_DevData_t;
sepp_nepp 6:fb11b746ceb5 644
sepp_nepp 8:2fd7cb217068 645 /* All these macros were replaced with following regulator expressions:
sepp_nepp 8:2fd7cb217068 646 a) Search for: \QVL53L0X_SETARRAYPARAMETERFIELD(\E(\s*)([A-Z\d_]+)[[:punct:]](\s*)([A-Z\d_]+)[[:punct:]](\s*)([A-Z\d_\*]+)\Q);\E
sepp_nepp 8:2fd7cb217068 647 Replace by: Data.CurrentParameters.\2[\4] = \6;
sepp_nepp 8:2fd7cb217068 648 to replace this: VL53L0X_SETARRAYPARAMETERFIELD(field, index, value);
sepp_nepp 8:2fd7cb217068 649 by this: Data.CurrentParameters.field[index] = value;
sepp_nepp 8:2fd7cb217068 650
sepp_nepp 8:2fd7cb217068 651 b) Search for: \QVL53L0X_GETARRAYPARAMETERFIELD(\E(\s*)([A-Z\d_]+)[[:punct:]](\s*)([A-Z\d_]+)[[:punct:]](\s*)([A-Z\d_\*]+)\Q);\E
sepp_nepp 8:2fd7cb217068 652 Replace by: \6 = Data.CurrentParameters.\2[\4];
sepp_nepp 8:2fd7cb217068 653 to replace this: VL53L0X_GETARRAYPARAMETERFIELD( LimitChecksValue, limit_check_id, temp_fix1616);
sepp_nepp 8:2fd7cb217068 654 by this: temp_fix1616 = Data.CurrentParameters.LimitChecksValue[limit_check_id];
sepp_nepp 8:2fd7cb217068 655
sepp_nepp 8:2fd7cb217068 656 c) Search for: \QVL53L0X_SETPARAMETERFIELD(\E(\s*)([A-Z\d_]+)[[:punct:]](\s*)([A-Z\d_\*]+)\Q);\E
sepp_nepp 8:2fd7cb217068 657 Replace by: Data.CurrentParameters.\2 = \4;
sepp_nepp 8:2fd7cb217068 658 to replace this: VL53L0X_SETPARAMETERFIELD(field, value);
sepp_nepp 8:2fd7cb217068 659 by this: Data.CurrentParameters.field = value
sepp_nepp 6:fb11b746ceb5 660
sepp_nepp 8:2fd7cb217068 661 d) Search for: \QVL53L0X_GETPARAMETERFIELD(\E(\s*)([A-Z\d_]+)[[:punct:]](\s*)([A-Z\d_\*]+)\Q);\E
sepp_nepp 8:2fd7cb217068 662 Replace by: \4 = Data.CurrentParameters.\2 ;
sepp_nepp 8:2fd7cb217068 663 to replace this: VL53L0X_GETPARAMET ERFIELD(field, variable);
sepp_nepp 8:2fd7cb217068 664 by this: variable = Data.CurrentParameters.field;
sepp_nepp 8:2fd7cb217068 665
sepp_nepp 8:2fd7cb217068 666 d) Search for: \QPALDevDataSet(\E(\s*)([A-Z\d_]+)[[:punct:]](\s*)([A-Z\d_\*]+)\Q);\E
sepp_nepp 8:2fd7cb217068 667 Replace by: Data.\2 = \4;
sepp_nepp 8:2fd7cb217068 668 to replace this: PALDevDataSet(field, value);
sepp_nepp 8:2fd7cb217068 669 by this: Data.field = value;
sepp_nepp 6:fb11b746ceb5 670
sepp_nepp 8:2fd7cb217068 671 d) Search for: \QPALDevDataGet(\E(\s*)([A-Z\d]+)\Q)\E
sepp_nepp 8:2fd7cb217068 672 Replace by: Data.\2
sepp_nepp 8:2fd7cb217068 673 to replace this: PALDevDataGet(field)
sepp_nepp 8:2fd7cb217068 674 by this: Data.field
sepp_nepp 8:2fd7cb217068 675
sepp_nepp 8:2fd7cb217068 676 #define PALDevDataSet(field, value) (Data.field)=(value)
sepp_nepp 8:2fd7cb217068 677 #define PALDevDataGet(field) (Data.field)
sepp_nepp 8:2fd7cb217068 678 #define VL53L0X_SETPARAMETERFIELD(field, value) Data.CurrentParameters.field = value
sepp_nepp 8:2fd7cb217068 679 #define VL53L0X_GETPARAMETERFIELD(field, variable) variable = Data.CurrentParameters.field
sepp_nepp 8:2fd7cb217068 680 #define VL53L0X_SETARRAYPARAMETERFIELD(field, index, value) Data.CurrentParameters.field[index] = value
sepp_nepp 8:2fd7cb217068 681 #define VL53L0X_GETARRAYPARAMETERFIELD(field, index, variable) variable = Data.CurrentParameters.field[index]
sepp_nepp 8:2fd7cb217068 682 #define VL53L0X_SETDEVICESPECIFICPARAMETER(field, value) Data.field = value
sepp_nepp 8:2fd7cb217068 683 #define VL53L0X_GETDEVICESPECIFICPARAMETER(field) Data.field
sepp_nepp 7:3a1115c2556b 684 */
sepp_nepp 11:d8dbe3b87f9f 685
sepp_nepp 11:d8dbe3b87f9f 686
sepp_nepp 6:fb11b746ceb5 687 /** @defgroup VL53L0X_define_InterruptPolarity_group Defines the Polarity of the Interrupt
sepp_nepp 6:fb11b746ceb5 688 * Defines the Polarity of the Interrupt
sepp_nepp 6:fb11b746ceb5 689 * @{
sepp_nepp 6:fb11b746ceb5 690 */
sepp_nepp 6:fb11b746ceb5 691 typedef uint8_t VL53L0X_InterruptPolarity;
sepp_nepp 6:fb11b746ceb5 692 #define VL53L0X_INTERRUPTPOLARITY_LOW ((VL53L0X_InterruptPolarity) 0)
sepp_nepp 6:fb11b746ceb5 693 /*!< Set active low polarity best setup for falling edge. */
sepp_nepp 6:fb11b746ceb5 694 #define VL53L0X_INTERRUPTPOLARITY_HIGH ((VL53L0X_InterruptPolarity) 1)
sepp_nepp 6:fb11b746ceb5 695 /*!< Set active high polarity best setup for rising edge. */
sepp_nepp 6:fb11b746ceb5 696
sepp_nepp 6:fb11b746ceb5 697 /** @} VL53L0X_define_InterruptPolarity_group */
sepp_nepp 6:fb11b746ceb5 698
sepp_nepp 6:fb11b746ceb5 699
sepp_nepp 6:fb11b746ceb5 700 /** @defgroup VL53L0X_define_VcselPeriod_group Vcsel Period Defines
sepp_nepp 6:fb11b746ceb5 701 * Defines the range measurement for which to access the vcsel period.
sepp_nepp 10:cd1758e186a4 702 * @{ */
sepp_nepp 6:fb11b746ceb5 703 typedef uint8_t VL53L0X_VcselPeriod;
sepp_nepp 6:fb11b746ceb5 704 #define VL53L0X_VCSEL_PERIOD_PRE_RANGE ((VL53L0X_VcselPeriod) 0)
sepp_nepp 6:fb11b746ceb5 705 /*!<Identifies the pre-range vcsel period. */
sepp_nepp 6:fb11b746ceb5 706 #define VL53L0X_VCSEL_PERIOD_FINAL_RANGE ((VL53L0X_VcselPeriod) 1)
sepp_nepp 6:fb11b746ceb5 707 /*!<Identifies the final range vcsel period. */
sepp_nepp 6:fb11b746ceb5 708
sepp_nepp 6:fb11b746ceb5 709 /** @} VL53L0X_define_VcselPeriod_group */
sepp_nepp 6:fb11b746ceb5 710 /** @defgroup VL53L0X_define_SchedulerSequence_group Defines the steps
sepp_nepp 6:fb11b746ceb5 711 * carried out by the scheduler during a range measurement.
sepp_nepp 6:fb11b746ceb5 712 * @{
sepp_nepp 11:d8dbe3b87f9f 713 * Defines the states of all the steps in the scheduler i.e. enabled/disabled. */
sepp_nepp 6:fb11b746ceb5 714 typedef struct {
sepp_nepp 10:cd1758e186a4 715 uint8_t TccOn; /*!<Reports if Target Centre Check On */
sepp_nepp 10:cd1758e186a4 716 uint8_t MsrcOn; /*!<Reports if MSRC On */
sepp_nepp 10:cd1758e186a4 717 uint8_t DssOn; /*!<Reports if DSS On */
sepp_nepp 10:cd1758e186a4 718 uint8_t PreRangeOn; /*!<Reports if Pre-Range On */
sepp_nepp 10:cd1758e186a4 719 uint8_t FinalRangeOn; /*!<Reports if Final-Range On */
sepp_nepp 6:fb11b746ceb5 720 } VL53L0X_SchedulerSequenceSteps_t;
sepp_nepp 6:fb11b746ceb5 721 /** @} VL53L0X_define_SchedulerSequence_group */
sepp_nepp 6:fb11b746ceb5 722
sepp_nepp 11:d8dbe3b87f9f 723 /** @defgroup VL53L0X_define_SequenceStepId_group
sepp_nepp 6:fb11b746ceb5 724 * Defines the the sequence steps performed during ranging..
sepp_nepp 10:cd1758e186a4 725 * @{ */
sepp_nepp 6:fb11b746ceb5 726 typedef uint8_t VL53L0X_SequenceStepId;
sepp_nepp 11:d8dbe3b87f9f 727 #define VL53L0X_SEQUENCESTEP_TCC ((VL53L0X_VcselPeriod) 0) /*!<Target CentreCheck identifier. */
sepp_nepp 11:d8dbe3b87f9f 728 #define VL53L0X_SEQUENCESTEP_DSS ((VL53L0X_VcselPeriod) 1) /*!<Dynamic Spad Selection function Identifier. */
sepp_nepp 11:d8dbe3b87f9f 729 #define VL53L0X_SEQUENCESTEP_MSRC ((VL53L0X_VcselPeriod) 2) /*!<Minimum Signal Rate Check function Identifier. */
sepp_nepp 11:d8dbe3b87f9f 730 #define VL53L0X_SEQUENCESTEP_PRE_RANGE ((VL53L0X_VcselPeriod) 3) /*!<Pre-Range check Identifier. */
sepp_nepp 11:d8dbe3b87f9f 731 #define VL53L0X_SEQUENCESTEP_FINAL_RANGE ((VL53L0X_VcselPeriod) 4) /*!<Final Range Check Identifier. */
sepp_nepp 11:d8dbe3b87f9f 732 #define VL53L0X_SEQUENCESTEP_NUMBER_OF_CHECKS 5 /*!<Number of Sequence Step Managed by the API. */
sepp_nepp 11:d8dbe3b87f9f 733 /** @} VL53L0X_define_SequenceStepId_group */
sepp_nepp 6:fb11b746ceb5 734
sepp_nepp 6:fb11b746ceb5 735
sepp_nepp 6:fb11b746ceb5 736 typedef enum {
sepp_nepp 6:fb11b746ceb5 737 Range_Config_DEFAULT,
sepp_nepp 6:fb11b746ceb5 738 Range_Config_LONG_RANGE,
sepp_nepp 6:fb11b746ceb5 739 Range_Config_HIGH_ACCURACY,
sepp_nepp 6:fb11b746ceb5 740 Range_Config_HIGH_SPEED
sepp_nepp 6:fb11b746ceb5 741 } VL53L0X_RangingConfig;
sepp_nepp 11:d8dbe3b87f9f 742 /** @} VL53L0X_define_SequenceStepId_group */
sepp_nepp 6:fb11b746ceb5 743
sepp_nepp 6:fb11b746ceb5 744 /** @} VL53L0X_globaldefine_group */
sepp_nepp 6:fb11b746ceb5 745
sepp_nepp 6:fb11b746ceb5 746
sepp_nepp 6:fb11b746ceb5 747 #ifdef __cplusplus
sepp_nepp 6:fb11b746ceb5 748 }
sepp_nepp 6:fb11b746ceb5 749 #endif
sepp_nepp 6:fb11b746ceb5 750
sepp_nepp 6:fb11b746ceb5 751
sepp_nepp 6:fb11b746ceb5 752 #endif /* _VL53L0X_DEF_H_ */