Tarek Lule / VL53L0X_Condensed

Condensed Version of Public VL53L0X

Dependents:   ToF-Only-Tryout

VL53L0X_def.h@5:b95f6951f7d5, 2019-03-23 (annotated)

Committer:
sepp_nepp
Date:
Sat Mar 23 21:28:30 2019 +0000
Revision:
5:b95f6951f7d5
Parent:
2:d07edeaff6f1
Child:
7:41cbc431e1f4
First Version of My Variant of VL53L0X

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nikapov 0:a1a69d32f310 1 /*******************************************************************************
nikapov 0:a1a69d32f310 2 Copyright © 2016, STMicroelectronics International N.V.
nikapov 0:a1a69d32f310 3 All rights reserved.
nikapov 0:a1a69d32f310 4
nikapov 0:a1a69d32f310 5 Redistribution and use in source and binary forms, with or without
nikapov 0:a1a69d32f310 6 modification, are permitted provided that the following conditions are met:
nikapov 0:a1a69d32f310 7 * Redistributions of source code must retain the above copyright
nikapov 0:a1a69d32f310 8 notice, this list of conditions and the following disclaimer.
nikapov 0:a1a69d32f310 9 * Redistributions in binary form must reproduce the above copyright
nikapov 0:a1a69d32f310 10 notice, this list of conditions and the following disclaimer in the
nikapov 0:a1a69d32f310 11 documentation and/or other materials provided with the distribution.
nikapov 0:a1a69d32f310 12 * Neither the name of STMicroelectronics nor the
nikapov 0:a1a69d32f310 13 names of its contributors may be used to endorse or promote products
nikapov 0:a1a69d32f310 14 derived from this software without specific prior written permission.
nikapov 0:a1a69d32f310 15
nikapov 0:a1a69d32f310 16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
nikapov 0:a1a69d32f310 17 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
nikapov 0:a1a69d32f310 18 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
nikapov 0:a1a69d32f310 19 NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.
nikapov 0:a1a69d32f310 20 IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY
nikapov 0:a1a69d32f310 21 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
nikapov 0:a1a69d32f310 22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
nikapov 0:a1a69d32f310 23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
nikapov 0:a1a69d32f310 24 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nikapov 0:a1a69d32f310 25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
nikapov 0:a1a69d32f310 26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nikapov 0:a1a69d32f310 27 *******************************************************************************/
nikapov 0:a1a69d32f310 28
nikapov 0:a1a69d32f310 29 /**
nikapov 0:a1a69d32f310 30 * @file VL53L0X_def.h
nikapov 0:a1a69d32f310 31 *
nikapov 0:a1a69d32f310 32 * @brief Type definitions for VL53L0X API.
nikapov 0:a1a69d32f310 33 *
nikapov 0:a1a69d32f310 34 */
nikapov 0:a1a69d32f310 35
nikapov 0:a1a69d32f310 36
nikapov 0:a1a69d32f310 37 #ifndef _VL53L0X_DEF_H_
nikapov 0:a1a69d32f310 38 #define _VL53L0X_DEF_H_
nikapov 0:a1a69d32f310 39
nikapov 0:a1a69d32f310 40
nikapov 0:a1a69d32f310 41 #ifdef __cplusplus
nikapov 0:a1a69d32f310 42 extern "C" {
nikapov 0:a1a69d32f310 43 #endif
nikapov 0:a1a69d32f310 44
nikapov 0:a1a69d32f310 45 /** @defgroup VL53L0X_globaldefine_group VL53L0X Defines
nikapov 0:a1a69d32f310 46 * @brief VL53L0X Defines
nikapov 0:a1a69d32f310 47 * @{
nikapov 0:a1a69d32f310 48 */
nikapov 0:a1a69d32f310 49
sepp_nepp 5:b95f6951f7d5 50 /****************** define for i2c configuration *******************************/
sepp_nepp 5:b95f6951f7d5 51 /** Maximum buffer size to be used in i2c */
sepp_nepp 5:b95f6951f7d5 52 #define VL53L0X_MAX_I2C_XFER_SIZE 64 /* Maximum buffer size to be used in i2c */
sepp_nepp 5:b95f6951f7d5 53 #define VL53L0X_I2C_USER_VAR /* none but could be for a flag var to get/pass to mutex interruptible return flags and try again */
sepp_nepp 5:b95f6951f7d5 54
nikapov 0:a1a69d32f310 55
nikapov 0:a1a69d32f310 56 /** PAL SPECIFICATION major version */
nikapov 0:a1a69d32f310 57 #define VL53L0X10_SPECIFICATION_VER_MAJOR 1
nikapov 0:a1a69d32f310 58 /** PAL SPECIFICATION minor version */
nikapov 0:a1a69d32f310 59 #define VL53L0X10_SPECIFICATION_VER_MINOR 2
nikapov 0:a1a69d32f310 60 /** PAL SPECIFICATION sub version */
nikapov 0:a1a69d32f310 61 #define VL53L0X10_SPECIFICATION_VER_SUB 7
nikapov 0:a1a69d32f310 62 /** PAL SPECIFICATION sub version */
nikapov 0:a1a69d32f310 63 #define VL53L0X10_SPECIFICATION_VER_REVISION 1440
nikapov 0:a1a69d32f310 64
nikapov 0:a1a69d32f310 65 /** VL53L0X PAL IMPLEMENTATION major version */
nikapov 0:a1a69d32f310 66 #define VL53L0X10_IMPLEMENTATION_VER_MAJOR 1
nikapov 0:a1a69d32f310 67 /** VL53L0X PAL IMPLEMENTATION minor version */
nikapov 0:a1a69d32f310 68 #define VL53L0X10_IMPLEMENTATION_VER_MINOR 0
nikapov 0:a1a69d32f310 69 /** VL53L0X PAL IMPLEMENTATION sub version */
nikapov 0:a1a69d32f310 70 #define VL53L0X10_IMPLEMENTATION_VER_SUB 9
nikapov 0:a1a69d32f310 71 /** VL53L0X PAL IMPLEMENTATION sub version */
nikapov 0:a1a69d32f310 72 #define VL53L0X10_IMPLEMENTATION_VER_REVISION 3673
nikapov 0:a1a69d32f310 73
nikapov 0:a1a69d32f310 74 /** PAL SPECIFICATION major version */
nikapov 0:a1a69d32f310 75 #define VL53L0X_SPECIFICATION_VER_MAJOR 1
nikapov 0:a1a69d32f310 76 /** PAL SPECIFICATION minor version */
nikapov 0:a1a69d32f310 77 #define VL53L0X_SPECIFICATION_VER_MINOR 2
nikapov 0:a1a69d32f310 78 /** PAL SPECIFICATION sub version */
nikapov 0:a1a69d32f310 79 #define VL53L0X_SPECIFICATION_VER_SUB 7
nikapov 0:a1a69d32f310 80 /** PAL SPECIFICATION sub version */
nikapov 0:a1a69d32f310 81 #define VL53L0X_SPECIFICATION_VER_REVISION 1440
nikapov 0:a1a69d32f310 82
nikapov 0:a1a69d32f310 83 /** VL53L0X PAL IMPLEMENTATION major version */
nikapov 0:a1a69d32f310 84 #define VL53L0X_IMPLEMENTATION_VER_MAJOR 1
nikapov 0:a1a69d32f310 85 /** VL53L0X PAL IMPLEMENTATION minor version */
nikapov 0:a1a69d32f310 86 #define VL53L0X_IMPLEMENTATION_VER_MINOR 1
nikapov 0:a1a69d32f310 87 /** VL53L0X PAL IMPLEMENTATION sub version */
nikapov 0:a1a69d32f310 88 #define VL53L0X_IMPLEMENTATION_VER_SUB 21
nikapov 0:a1a69d32f310 89 /** VL53L0X PAL IMPLEMENTATION sub version */
nikapov 0:a1a69d32f310 90 #define VL53L0X_IMPLEMENTATION_VER_REVISION 4823
sepp_nepp 5:b95f6951f7d5 91
sepp_nepp 5:b95f6951f7d5 92
nikapov 0:a1a69d32f310 93 #define VL53L0X_DEFAULT_MAX_LOOP 2000
nikapov 0:a1a69d32f310 94 #define VL53L0X_MAX_STRING_LENGTH 32
nikapov 0:a1a69d32f310 95
nikapov 0:a1a69d32f310 96
nikapov 0:a1a69d32f310 97 #include "VL53L0X_device.h"
nikapov 0:a1a69d32f310 98
nikapov 0:a1a69d32f310 99 /****************************************
nikapov 0:a1a69d32f310 100 * PRIVATE define do not edit
nikapov 0:a1a69d32f310 101 ****************************************/
nikapov 0:a1a69d32f310 102
nikapov 0:a1a69d32f310 103 /** @brief Defines the parameters of the Get Version Functions
nikapov 0:a1a69d32f310 104 */
nikapov 0:a1a69d32f310 105 typedef struct {
Davidroid 2:d07edeaff6f1 106 uint32_t revision; /*!< revision number */
Davidroid 2:d07edeaff6f1 107 uint8_t major; /*!< major number */
Davidroid 2:d07edeaff6f1 108 uint8_t minor; /*!< minor number */
Davidroid 2:d07edeaff6f1 109 uint8_t build; /*!< build number */
nikapov 0:a1a69d32f310 110 } VL53L0X_Version_t;
nikapov 0:a1a69d32f310 111
nikapov 0:a1a69d32f310 112
nikapov 0:a1a69d32f310 113 /** @brief Defines the parameters of the Get Device Info Functions
nikapov 0:a1a69d32f310 114 */
nikapov 0:a1a69d32f310 115 typedef struct {
Davidroid 2:d07edeaff6f1 116 char Name[VL53L0X_MAX_STRING_LENGTH];
Davidroid 2:d07edeaff6f1 117 /*!< Name of the Device e.g. Left_Distance */
Davidroid 2:d07edeaff6f1 118 char Type[VL53L0X_MAX_STRING_LENGTH];
Davidroid 2:d07edeaff6f1 119 /*!< Type of the Device e.g VL53L0X */
Davidroid 2:d07edeaff6f1 120 char ProductId[VL53L0X_MAX_STRING_LENGTH];
Davidroid 2:d07edeaff6f1 121 /*!< Product Identifier String */
Davidroid 2:d07edeaff6f1 122 uint8_t ProductType;
Davidroid 2:d07edeaff6f1 123 /*!< Product Type, VL53L0X = 1, VL53L1 = 2 */
Davidroid 2:d07edeaff6f1 124 uint8_t ProductRevisionMajor;
Davidroid 2:d07edeaff6f1 125 /*!< Product revision major */
Davidroid 2:d07edeaff6f1 126 uint8_t ProductRevisionMinor;
Davidroid 2:d07edeaff6f1 127 /*!< Product revision minor */
nikapov 0:a1a69d32f310 128 } VL53L0X_DeviceInfo_t;
nikapov 0:a1a69d32f310 129
nikapov 0:a1a69d32f310 130
nikapov 0:a1a69d32f310 131 /** @defgroup VL53L0X_define_Error_group Error and Warning code returned by API
nikapov 0:a1a69d32f310 132 * The following DEFINE are used to identify the PAL ERROR
nikapov 0:a1a69d32f310 133 * @{
nikapov 0:a1a69d32f310 134 */
nikapov 0:a1a69d32f310 135
nikapov 0:a1a69d32f310 136 typedef int8_t VL53L0X_Error;
nikapov 0:a1a69d32f310 137
nikapov 0:a1a69d32f310 138 #define VL53L0X_ERROR_NONE ((VL53L0X_Error) 0)
nikapov 0:a1a69d32f310 139 #define VL53L0X_ERROR_CALIBRATION_WARNING ((VL53L0X_Error) -1)
Davidroid 2:d07edeaff6f1 140 /*!< Warning invalid calibration data may be in used
Davidroid 2:d07edeaff6f1 141 \a VL53L0X_InitData()
Davidroid 2:d07edeaff6f1 142 \a VL53L0X_GetOffsetCalibrationData
Davidroid 2:d07edeaff6f1 143 \a VL53L0X_SetOffsetCalibrationData */
nikapov 0:a1a69d32f310 144 #define VL53L0X_ERROR_MIN_CLIPPED ((VL53L0X_Error) -2)
Davidroid 2:d07edeaff6f1 145 /*!< Warning parameter passed was clipped to min before to be applied */
nikapov 0:a1a69d32f310 146
nikapov 0:a1a69d32f310 147 #define VL53L0X_ERROR_UNDEFINED ((VL53L0X_Error) -3)
Davidroid 2:d07edeaff6f1 148 /*!< Unqualified error */
nikapov 0:a1a69d32f310 149 #define VL53L0X_ERROR_INVALID_PARAMS ((VL53L0X_Error) -4)
Davidroid 2:d07edeaff6f1 150 /*!< Parameter passed is invalid or out of range */
nikapov 0:a1a69d32f310 151 #define VL53L0X_ERROR_NOT_SUPPORTED ((VL53L0X_Error) -5)
Davidroid 2:d07edeaff6f1 152 /*!< Function is not supported in current mode or configuration */
nikapov 0:a1a69d32f310 153 #define VL53L0X_ERROR_RANGE_ERROR ((VL53L0X_Error) -6)
Davidroid 2:d07edeaff6f1 154 /*!< Device report a ranging error interrupt status */
nikapov 0:a1a69d32f310 155 #define VL53L0X_ERROR_TIME_OUT ((VL53L0X_Error) -7)
Davidroid 2:d07edeaff6f1 156 /*!< Aborted due to time out */
nikapov 0:a1a69d32f310 157 #define VL53L0X_ERROR_MODE_NOT_SUPPORTED ((VL53L0X_Error) -8)
Davidroid 2:d07edeaff6f1 158 /*!< Asked mode is not supported by the device */
nikapov 0:a1a69d32f310 159 #define VL53L0X_ERROR_BUFFER_TOO_SMALL ((VL53L0X_Error) -9)
Davidroid 2:d07edeaff6f1 160 /*!< ... */
nikapov 0:a1a69d32f310 161 #define VL53L0X_ERROR_GPIO_NOT_EXISTING ((VL53L0X_Error) -10)
Davidroid 2:d07edeaff6f1 162 /*!< User tried to setup a non-existing GPIO pin */
nikapov 0:a1a69d32f310 163 #define VL53L0X_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED ((VL53L0X_Error) -11)
Davidroid 2:d07edeaff6f1 164 /*!< unsupported GPIO functionality */
nikapov 0:a1a69d32f310 165 #define VL53L0X_ERROR_INTERRUPT_NOT_CLEARED ((VL53L0X_Error) -12)
Davidroid 2:d07edeaff6f1 166 /*!< Error during interrupt clear */
nikapov 0:a1a69d32f310 167 #define VL53L0X_ERROR_CONTROL_INTERFACE ((VL53L0X_Error) -20)
Davidroid 2:d07edeaff6f1 168 /*!< error reported from IO functions */
nikapov 0:a1a69d32f310 169 #define VL53L0X_ERROR_INVALID_COMMAND ((VL53L0X_Error) -30)
Davidroid 2:d07edeaff6f1 170 /*!< The command is not allowed in the current device state
Davidroid 2:d07edeaff6f1 171 * (power down) */
nikapov 0:a1a69d32f310 172 #define VL53L0X_ERROR_DIVISION_BY_ZERO ((VL53L0X_Error) -40)
Davidroid 2:d07edeaff6f1 173 /*!< In the function a division by zero occurs */
nikapov 0:a1a69d32f310 174 #define VL53L0X_ERROR_REF_SPAD_INIT ((VL53L0X_Error) -50)
Davidroid 2:d07edeaff6f1 175 /*!< Error during reference SPAD initialization */
nikapov 0:a1a69d32f310 176 #define VL53L0X_ERROR_NOT_IMPLEMENTED ((VL53L0X_Error) -99)
Davidroid 2:d07edeaff6f1 177 /*!< Tells requested functionality has not been implemented yet or
Davidroid 2:d07edeaff6f1 178 * not compatible with the device */
nikapov 0:a1a69d32f310 179 /** @} VL53L0X_define_Error_group */
nikapov 0:a1a69d32f310 180
nikapov 0:a1a69d32f310 181
nikapov 0:a1a69d32f310 182 /** @defgroup VL53L0X_define_DeviceModes_group Defines Device modes
nikapov 0:a1a69d32f310 183 * Defines all possible modes for the device
nikapov 0:a1a69d32f310 184 * @{
nikapov 0:a1a69d32f310 185 */
nikapov 0:a1a69d32f310 186 typedef uint8_t VL53L0X_DeviceModes;
nikapov 0:a1a69d32f310 187
nikapov 0:a1a69d32f310 188 #define VL53L0X_DEVICEMODE_SINGLE_RANGING ((VL53L0X_DeviceModes) 0)
nikapov 0:a1a69d32f310 189 #define VL53L0X_DEVICEMODE_CONTINUOUS_RANGING ((VL53L0X_DeviceModes) 1)
nikapov 0:a1a69d32f310 190 #define VL53L0X_DEVICEMODE_SINGLE_HISTOGRAM ((VL53L0X_DeviceModes) 2)
nikapov 0:a1a69d32f310 191 #define VL53L0X_DEVICEMODE_CONTINUOUS_TIMED_RANGING ((VL53L0X_DeviceModes) 3)
nikapov 0:a1a69d32f310 192 #define VL53L0X_DEVICEMODE_SINGLE_ALS ((VL53L0X_DeviceModes) 10)
nikapov 0:a1a69d32f310 193 #define VL53L0X_DEVICEMODE_GPIO_DRIVE ((VL53L0X_DeviceModes) 20)
nikapov 0:a1a69d32f310 194 #define VL53L0X_DEVICEMODE_GPIO_OSC ((VL53L0X_DeviceModes) 21)
Davidroid 2:d07edeaff6f1 195 /* ... Modes to be added depending on device */
nikapov 0:a1a69d32f310 196 /** @} VL53L0X_define_DeviceModes_group */
nikapov 0:a1a69d32f310 197
nikapov 0:a1a69d32f310 198 /** @defgroup VL53L0X_define_HistogramModes_group Defines Histogram modes
nikapov 0:a1a69d32f310 199 * Defines all possible Histogram modes for the device
nikapov 0:a1a69d32f310 200 * @{
nikapov 0:a1a69d32f310 201 */
nikapov 0:a1a69d32f310 202 typedef uint8_t VL53L0X_HistogramModes;
nikapov 0:a1a69d32f310 203
nikapov 0:a1a69d32f310 204 #define VL53L0X_HISTOGRAMMODE_DISABLED ((VL53L0X_HistogramModes) 0)
Davidroid 2:d07edeaff6f1 205 /*!< Histogram Disabled */
nikapov 0:a1a69d32f310 206 #define VL53L0X_HISTOGRAMMODE_REFERENCE_ONLY ((VL53L0X_HistogramModes) 1)
Davidroid 2:d07edeaff6f1 207 /*!< Histogram Reference array only */
nikapov 0:a1a69d32f310 208 #define VL53L0X_HISTOGRAMMODE_RETURN_ONLY ((VL53L0X_HistogramModes) 2)
Davidroid 2:d07edeaff6f1 209 /*!< Histogram Return array only */
nikapov 0:a1a69d32f310 210 #define VL53L0X_HISTOGRAMMODE_BOTH ((VL53L0X_HistogramModes) 3)
Davidroid 2:d07edeaff6f1 211 /*!< Histogram both Reference and Return Arrays */
Davidroid 2:d07edeaff6f1 212 /* ... Modes to be added depending on device */
nikapov 0:a1a69d32f310 213 /** @} VL53L0X_define_HistogramModes_group */
nikapov 0:a1a69d32f310 214
nikapov 0:a1a69d32f310 215
nikapov 0:a1a69d32f310 216 /** @defgroup VL53L0X_define_PowerModes_group List of available Power Modes
nikapov 0:a1a69d32f310 217 * List of available Power Modes
nikapov 0:a1a69d32f310 218 * @{
nikapov 0:a1a69d32f310 219 */
nikapov 0:a1a69d32f310 220
nikapov 0:a1a69d32f310 221 typedef uint8_t VL53L0X_PowerModes;
nikapov 0:a1a69d32f310 222
nikapov 0:a1a69d32f310 223 #define VL53L0X_POWERMODE_STANDBY_LEVEL1 ((VL53L0X_PowerModes) 0)
Davidroid 2:d07edeaff6f1 224 /*!< Standby level 1 */
nikapov 0:a1a69d32f310 225 #define VL53L0X_POWERMODE_STANDBY_LEVEL2 ((VL53L0X_PowerModes) 1)
Davidroid 2:d07edeaff6f1 226 /*!< Standby level 2 */
nikapov 0:a1a69d32f310 227 #define VL53L0X_POWERMODE_IDLE_LEVEL1 ((VL53L0X_PowerModes) 2)
Davidroid 2:d07edeaff6f1 228 /*!< Idle level 1 */
nikapov 0:a1a69d32f310 229 #define VL53L0X_POWERMODE_IDLE_LEVEL2 ((VL53L0X_PowerModes) 3)
Davidroid 2:d07edeaff6f1 230 /*!< Idle level 2 */
nikapov 0:a1a69d32f310 231
nikapov 0:a1a69d32f310 232 /** @} VL53L0X_define_PowerModes_group */
nikapov 0:a1a69d32f310 233
nikapov 0:a1a69d32f310 234 /** @brief Defines all parameters for the device
nikapov 0:a1a69d32f310 235 */
nikapov 0:a1a69d32f310 236 typedef struct {
Davidroid 2:d07edeaff6f1 237 VL53L0X_DeviceModes DeviceMode;
Davidroid 2:d07edeaff6f1 238 /*!< Defines type of measurement to be done for the next measure */
Davidroid 2:d07edeaff6f1 239 VL53L0X_HistogramModes HistogramMode;
Davidroid 2:d07edeaff6f1 240 /*!< Defines type of histogram measurement to be done for the next
Davidroid 2:d07edeaff6f1 241 * measure */
Davidroid 2:d07edeaff6f1 242 uint32_t MeasurementTimingBudgetMicroSeconds;
Davidroid 2:d07edeaff6f1 243 /*!< Defines the allowed total time for a single measurement */
Davidroid 2:d07edeaff6f1 244 uint32_t InterMeasurementPeriodMilliSeconds;
Davidroid 2:d07edeaff6f1 245 /*!< Defines time between two consecutive measurements (between two
Davidroid 2:d07edeaff6f1 246 * measurement starts). If set to 0 means back-to-back mode */
Davidroid 2:d07edeaff6f1 247 uint8_t XTalkCompensationEnable;
Davidroid 2:d07edeaff6f1 248 /*!< Tells if Crosstalk compensation shall be enable or not */
Davidroid 2:d07edeaff6f1 249 uint16_t XTalkCompensationRangeMilliMeter;
Davidroid 2:d07edeaff6f1 250 /*!< CrossTalk compensation range in millimeter */
Davidroid 2:d07edeaff6f1 251 FixPoint1616_t XTalkCompensationRateMegaCps;
Davidroid 2:d07edeaff6f1 252 /*!< CrossTalk compensation rate in Mega counts per seconds.
Davidroid 2:d07edeaff6f1 253 * Expressed in 16.16 fixed point format. */
Davidroid 2:d07edeaff6f1 254 int32_t RangeOffsetMicroMeters;
Davidroid 2:d07edeaff6f1 255 /*!< Range offset adjustment (mm). */
nikapov 0:a1a69d32f310 256
Davidroid 2:d07edeaff6f1 257 uint8_t LimitChecksEnable[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
Davidroid 2:d07edeaff6f1 258 /*!< This Array store all the Limit Check enable for this device. */
Davidroid 2:d07edeaff6f1 259 uint8_t LimitChecksStatus[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
Davidroid 2:d07edeaff6f1 260 /*!< This Array store all the Status of the check linked to last
Davidroid 2:d07edeaff6f1 261 * measurement. */
Davidroid 2:d07edeaff6f1 262 FixPoint1616_t LimitChecksValue[VL53L0X_CHECKENABLE_NUMBER_OF_CHECKS];
Davidroid 2:d07edeaff6f1 263 /*!< This Array store all the Limit Check value for this device */
nikapov 0:a1a69d32f310 264
Davidroid 2:d07edeaff6f1 265 uint8_t WrapAroundCheckEnable;
Davidroid 2:d07edeaff6f1 266 /*!< Tells if Wrap Around Check shall be enable or not */
nikapov 0:a1a69d32f310 267 } VL53L0X_DeviceParameters_t;
nikapov 0:a1a69d32f310 268
nikapov 0:a1a69d32f310 269
nikapov 0:a1a69d32f310 270 /** @defgroup VL53L0X_define_State_group Defines the current status of the device
nikapov 0:a1a69d32f310 271 * Defines the current status of the device
nikapov 0:a1a69d32f310 272 * @{
nikapov 0:a1a69d32f310 273 */
nikapov 0:a1a69d32f310 274
nikapov 0:a1a69d32f310 275 typedef uint8_t VL53L0X_State;
nikapov 0:a1a69d32f310 276
nikapov 0:a1a69d32f310 277 #define VL53L0X_STATE_POWERDOWN ((VL53L0X_State) 0)
Davidroid 2:d07edeaff6f1 278 /*!< Device is in HW reset */
nikapov 0:a1a69d32f310 279 #define VL53L0X_STATE_WAIT_STATICINIT ((VL53L0X_State) 1)
Davidroid 2:d07edeaff6f1 280 /*!< Device is initialized and wait for static initialization */
nikapov 0:a1a69d32f310 281 #define VL53L0X_STATE_STANDBY ((VL53L0X_State) 2)
Davidroid 2:d07edeaff6f1 282 /*!< Device is in Low power Standby mode */
nikapov 0:a1a69d32f310 283 #define VL53L0X_STATE_IDLE ((VL53L0X_State) 3)
Davidroid 2:d07edeaff6f1 284 /*!< Device has been initialized and ready to do measurements */
nikapov 0:a1a69d32f310 285 #define VL53L0X_STATE_RUNNING ((VL53L0X_State) 4)
Davidroid 2:d07edeaff6f1 286 /*!< Device is performing measurement */
nikapov 0:a1a69d32f310 287 #define VL53L0X_STATE_UNKNOWN ((VL53L0X_State) 98)
Davidroid 2:d07edeaff6f1 288 /*!< Device is in unknown state and need to be rebooted */
nikapov 0:a1a69d32f310 289 #define VL53L0X_STATE_ERROR ((VL53L0X_State) 99)
Davidroid 2:d07edeaff6f1 290 /*!< Device is in error state and need to be rebooted */
nikapov 0:a1a69d32f310 291
nikapov 0:a1a69d32f310 292 /** @} VL53L0X_define_State_group */
nikapov 0:a1a69d32f310 293
nikapov 0:a1a69d32f310 294
nikapov 0:a1a69d32f310 295 /** @brief Structure containing the Dmax computation parameters and data
nikapov 0:a1a69d32f310 296 */
nikapov 0:a1a69d32f310 297 typedef struct {
Davidroid 2:d07edeaff6f1 298 int32_t AmbTuningWindowFactor_K;
Davidroid 2:d07edeaff6f1 299 /*!< internal algo tuning (*1000) */
Davidroid 2:d07edeaff6f1 300 int32_t RetSignalAt0mm;
Davidroid 2:d07edeaff6f1 301 /*!< intermediate dmax computation value caching */
nikapov 0:a1a69d32f310 302 } VL53L0X_DMaxData_t;
nikapov 0:a1a69d32f310 303
nikapov 0:a1a69d32f310 304 /**
nikapov 0:a1a69d32f310 305 * @struct VL53L0X_RangeData_t
nikapov 0:a1a69d32f310 306 * @brief Range measurement data.
nikapov 0:a1a69d32f310 307 */
nikapov 0:a1a69d32f310 308 typedef struct {
Davidroid 2:d07edeaff6f1 309 uint32_t TimeStamp; /*!< 32-bit time stamp. */
Davidroid 2:d07edeaff6f1 310 uint32_t MeasurementTimeUsec;
Davidroid 2:d07edeaff6f1 311 /*!< Give the Measurement time needed by the device to do the
Davidroid 2:d07edeaff6f1 312 * measurement.*/
nikapov 0:a1a69d32f310 313
Davidroid 2:d07edeaff6f1 314 uint16_t RangeMilliMeter; /*!< range distance in millimeter. */
nikapov 0:a1a69d32f310 315
Davidroid 2:d07edeaff6f1 316 uint16_t RangeDMaxMilliMeter;
Davidroid 2:d07edeaff6f1 317 /*!< Tells what is the maximum detection distance of the device
Davidroid 2:d07edeaff6f1 318 * in current setup and environment conditions (Filled when
Davidroid 2:d07edeaff6f1 319 * applicable) */
nikapov 0:a1a69d32f310 320
Davidroid 2:d07edeaff6f1 321 FixPoint1616_t SignalRateRtnMegaCps;
Davidroid 2:d07edeaff6f1 322 /*!< Return signal rate (MCPS)\n these is a 16.16 fix point
Davidroid 2:d07edeaff6f1 323 * value, which is effectively a measure of target
Davidroid 2:d07edeaff6f1 324 * reflectance.*/
Davidroid 2:d07edeaff6f1 325 FixPoint1616_t AmbientRateRtnMegaCps;
Davidroid 2:d07edeaff6f1 326 /*!< Return ambient rate (MCPS)\n these is a 16.16 fix point
Davidroid 2:d07edeaff6f1 327 * value, which is effectively a measure of the ambien
Davidroid 2:d07edeaff6f1 328 * t light.*/
nikapov 0:a1a69d32f310 329
Davidroid 2:d07edeaff6f1 330 uint16_t EffectiveSpadRtnCount;
Davidroid 2:d07edeaff6f1 331 /*!< Return the effective SPAD count for the return signal.
Davidroid 2:d07edeaff6f1 332 * To obtain Real value it should be divided by 256 */
nikapov 0:a1a69d32f310 333
Davidroid 2:d07edeaff6f1 334 uint8_t ZoneId;
Davidroid 2:d07edeaff6f1 335 /*!< Denotes which zone and range scheduler stage the range
Davidroid 2:d07edeaff6f1 336 * data relates to. */
Davidroid 2:d07edeaff6f1 337 uint8_t RangeFractionalPart;
Davidroid 2:d07edeaff6f1 338 /*!< Fractional part of range distance. Final value is a
Davidroid 2:d07edeaff6f1 339 * FixPoint168 value. */
Davidroid 2:d07edeaff6f1 340 uint8_t RangeStatus;
Davidroid 2:d07edeaff6f1 341 /*!< Range Status for the current measurement. This is device
Davidroid 2:d07edeaff6f1 342 * dependent. Value = 0 means value is valid.
Davidroid 2:d07edeaff6f1 343 * See \ref RangeStatusPage */
nikapov 0:a1a69d32f310 344 } VL53L0X_RangingMeasurementData_t;
nikapov 0:a1a69d32f310 345
nikapov 0:a1a69d32f310 346
nikapov 0:a1a69d32f310 347 #define VL53L0X_HISTOGRAM_BUFFER_SIZE 24
nikapov 0:a1a69d32f310 348
nikapov 0:a1a69d32f310 349 /**
nikapov 0:a1a69d32f310 350 * @struct VL53L0X_HistogramData_t
nikapov 0:a1a69d32f310 351 * @brief Histogram measurement data.
nikapov 0:a1a69d32f310 352 */
nikapov 0:a1a69d32f310 353 typedef struct {
Davidroid 2:d07edeaff6f1 354 /* Histogram Measurement data */
Davidroid 2:d07edeaff6f1 355 uint32_t HistogramData[VL53L0X_HISTOGRAM_BUFFER_SIZE];
Davidroid 2:d07edeaff6f1 356 /*!< Histogram data */
Davidroid 2:d07edeaff6f1 357 uint8_t HistogramType; /*!< Indicate the types of histogram data :
nikapov 0:a1a69d32f310 358 Return only, Reference only, both Return and Reference */
Davidroid 2:d07edeaff6f1 359 uint8_t FirstBin; /*!< First Bin value */
Davidroid 2:d07edeaff6f1 360 uint8_t BufferSize; /*!< Buffer Size - Set by the user.*/
Davidroid 2:d07edeaff6f1 361 uint8_t NumberOfBins;
Davidroid 2:d07edeaff6f1 362 /*!< Number of bins filled by the histogram measurement */
nikapov 0:a1a69d32f310 363
Davidroid 2:d07edeaff6f1 364 VL53L0X_DeviceError ErrorStatus;
Davidroid 2:d07edeaff6f1 365 /*!< Error status of the current measurement. \n
Davidroid 2:d07edeaff6f1 366 see @a ::VL53L0X_DeviceError @a VL53L0X_GetStatusErrorString() */
nikapov 0:a1a69d32f310 367 } VL53L0X_HistogramMeasurementData_t;
nikapov 0:a1a69d32f310 368
nikapov 0:a1a69d32f310 369 #define VL53L0X_REF_SPAD_BUFFER_SIZE 6
nikapov 0:a1a69d32f310 370
nikapov 0:a1a69d32f310 371 /**
nikapov 0:a1a69d32f310 372 * @struct VL53L0X_SpadData_t
nikapov 0:a1a69d32f310 373 * @brief Spad Configuration Data.
nikapov 0:a1a69d32f310 374 */
nikapov 0:a1a69d32f310 375 typedef struct {
Davidroid 2:d07edeaff6f1 376 uint8_t RefSpadEnables[VL53L0X_REF_SPAD_BUFFER_SIZE];
Davidroid 2:d07edeaff6f1 377 /*!< Reference Spad Enables */
Davidroid 2:d07edeaff6f1 378 uint8_t RefGoodSpadMap[VL53L0X_REF_SPAD_BUFFER_SIZE];
Davidroid 2:d07edeaff6f1 379 /*!< Reference Spad Good Spad Map */
nikapov 0:a1a69d32f310 380 } VL53L0X_SpadData_t;
nikapov 0:a1a69d32f310 381
nikapov 0:a1a69d32f310 382 typedef struct {
Davidroid 2:d07edeaff6f1 383 FixPoint1616_t OscFrequencyMHz; /* Frequency used */
nikapov 0:a1a69d32f310 384
Davidroid 2:d07edeaff6f1 385 uint16_t LastEncodedTimeout;
Davidroid 2:d07edeaff6f1 386 /* last encoded Time out used for timing budget*/
nikapov 0:a1a69d32f310 387
Davidroid 2:d07edeaff6f1 388 VL53L0X_GpioFunctionality Pin0GpioFunctionality;
Davidroid 2:d07edeaff6f1 389 /* store the functionality of the GPIO: pin0 */
nikapov 0:a1a69d32f310 390
Davidroid 2:d07edeaff6f1 391 uint32_t FinalRangeTimeoutMicroSecs;
Davidroid 2:d07edeaff6f1 392 /*!< Execution time of the final range*/
Davidroid 2:d07edeaff6f1 393 uint8_t FinalRangeVcselPulsePeriod;
Davidroid 2:d07edeaff6f1 394 /*!< Vcsel pulse period (pll clocks) for the final range measurement*/
Davidroid 2:d07edeaff6f1 395 uint32_t PreRangeTimeoutMicroSecs;
Davidroid 2:d07edeaff6f1 396 /*!< Execution time of the final range*/
Davidroid 2:d07edeaff6f1 397 uint8_t PreRangeVcselPulsePeriod;
Davidroid 2:d07edeaff6f1 398 /*!< Vcsel pulse period (pll clocks) for the pre-range measurement*/
nikapov 0:a1a69d32f310 399
Davidroid 2:d07edeaff6f1 400 uint16_t SigmaEstRefArray;
Davidroid 2:d07edeaff6f1 401 /*!< Reference array sigma value in 1/100th of [mm] e.g. 100 = 1mm */
Davidroid 2:d07edeaff6f1 402 uint16_t SigmaEstEffPulseWidth;
Davidroid 2:d07edeaff6f1 403 /*!< Effective Pulse width for sigma estimate in 1/100th
Davidroid 2:d07edeaff6f1 404 * of ns e.g. 900 = 9.0ns */
Davidroid 2:d07edeaff6f1 405 uint16_t SigmaEstEffAmbWidth;
Davidroid 2:d07edeaff6f1 406 /*!< Effective Ambient width for sigma estimate in 1/100th of ns
Davidroid 2:d07edeaff6f1 407 * e.g. 500 = 5.0ns */
nikapov 0:a1a69d32f310 408
nikapov 0:a1a69d32f310 409
Davidroid 2:d07edeaff6f1 410 uint8_t ReadDataFromDeviceDone; /* Indicate if read from device has
nikapov 0:a1a69d32f310 411 been done (==1) or not (==0) */
Davidroid 2:d07edeaff6f1 412 uint8_t ModuleId; /* Module ID */
Davidroid 2:d07edeaff6f1 413 uint8_t Revision; /* test Revision */
Davidroid 2:d07edeaff6f1 414 char ProductId[VL53L0X_MAX_STRING_LENGTH];
Davidroid 2:d07edeaff6f1 415 /* Product Identifier String */
Davidroid 2:d07edeaff6f1 416 uint8_t ReferenceSpadCount; /* used for ref spad management */
Davidroid 2:d07edeaff6f1 417 uint8_t ReferenceSpadType; /* used for ref spad management */
Davidroid 2:d07edeaff6f1 418 uint8_t RefSpadsInitialised; /* reports if ref spads are initialised. */
Davidroid 2:d07edeaff6f1 419 uint32_t PartUIDUpper; /*!< Unique Part ID Upper */
Davidroid 2:d07edeaff6f1 420 uint32_t PartUIDLower; /*!< Unique Part ID Lower */
Davidroid 2:d07edeaff6f1 421 FixPoint1616_t SignalRateMeasFixed400mm; /*!< Peek Signal rate
nikapov 0:a1a69d32f310 422 at 400 mm*/
nikapov 0:a1a69d32f310 423
nikapov 0:a1a69d32f310 424 } VL53L0X_DeviceSpecificParameters_t;
nikapov 0:a1a69d32f310 425
nikapov 0:a1a69d32f310 426 /**
nikapov 0:a1a69d32f310 427 * @struct VL53L0X_DevData_t
nikapov 0:a1a69d32f310 428 *
nikapov 0:a1a69d32f310 429 * @brief VL53L0X PAL device ST private data structure \n
nikapov 0:a1a69d32f310 430 * End user should never access any of these field directly
nikapov 0:a1a69d32f310 431 *
sepp_nepp 5:b95f6951f7d5 432 * These must never be accessed directly, but only via macro
nikapov 0:a1a69d32f310 433 */
nikapov 0:a1a69d32f310 434 typedef struct {
Davidroid 2:d07edeaff6f1 435 VL53L0X_DMaxData_t DMaxData;
Davidroid 2:d07edeaff6f1 436 /*!< Dmax Data */
Davidroid 2:d07edeaff6f1 437 int32_t Part2PartOffsetNVMMicroMeter;
Davidroid 2:d07edeaff6f1 438 /*!< backed up NVM value */
Davidroid 2:d07edeaff6f1 439 int32_t Part2PartOffsetAdjustmentNVMMicroMeter;
Davidroid 2:d07edeaff6f1 440 /*!< backed up NVM value representing additional offset adjustment */
Davidroid 2:d07edeaff6f1 441 VL53L0X_DeviceParameters_t CurrentParameters;
Davidroid 2:d07edeaff6f1 442 /*!< Current Device Parameter */
Davidroid 2:d07edeaff6f1 443 VL53L0X_RangingMeasurementData_t LastRangeMeasure;
Davidroid 2:d07edeaff6f1 444 /*!< Ranging Data */
Davidroid 2:d07edeaff6f1 445 VL53L0X_HistogramMeasurementData_t LastHistogramMeasure;
Davidroid 2:d07edeaff6f1 446 /*!< Histogram Data */
Davidroid 2:d07edeaff6f1 447 VL53L0X_DeviceSpecificParameters_t DeviceSpecificParameters;
Davidroid 2:d07edeaff6f1 448 /*!< Parameters specific to the device */
Davidroid 2:d07edeaff6f1 449 VL53L0X_SpadData_t SpadData;
Davidroid 2:d07edeaff6f1 450 /*!< Spad Data */
Davidroid 2:d07edeaff6f1 451 uint8_t SequenceConfig;
Davidroid 2:d07edeaff6f1 452 /*!< Internal value for the sequence config */
Davidroid 2:d07edeaff6f1 453 uint8_t RangeFractionalEnable;
Davidroid 2:d07edeaff6f1 454 /*!< Enable/Disable fractional part of ranging data */
Davidroid 2:d07edeaff6f1 455 VL53L0X_State PalState;
Davidroid 2:d07edeaff6f1 456 /*!< Current state of the PAL for this device */
Davidroid 2:d07edeaff6f1 457 VL53L0X_PowerModes PowerMode;
Davidroid 2:d07edeaff6f1 458 /*!< Current Power Mode */
Davidroid 2:d07edeaff6f1 459 uint16_t SigmaEstRefArray;
Davidroid 2:d07edeaff6f1 460 /*!< Reference array sigma value in 1/100th of [mm] e.g. 100 = 1mm */
Davidroid 2:d07edeaff6f1 461 uint16_t SigmaEstEffPulseWidth;
Davidroid 2:d07edeaff6f1 462 /*!< Effective Pulse width for sigma estimate in 1/100th
Davidroid 2:d07edeaff6f1 463 * of ns e.g. 900 = 9.0ns */
Davidroid 2:d07edeaff6f1 464 uint16_t SigmaEstEffAmbWidth;
Davidroid 2:d07edeaff6f1 465 /*!< Effective Ambient width for sigma estimate in 1/100th of ns
Davidroid 2:d07edeaff6f1 466 * e.g. 500 = 5.0ns */
Davidroid 2:d07edeaff6f1 467 uint8_t StopVariable;
Davidroid 2:d07edeaff6f1 468 /*!< StopVariable used during the stop sequence */
Davidroid 2:d07edeaff6f1 469 uint16_t targetRefRate;
Davidroid 2:d07edeaff6f1 470 /*!< Target Ambient Rate for Ref spad management */
Davidroid 2:d07edeaff6f1 471 FixPoint1616_t SigmaEstimate;
Davidroid 2:d07edeaff6f1 472 /*!< Sigma Estimate - based on ambient & VCSEL rates and
Davidroid 2:d07edeaff6f1 473 * signal_total_events */
Davidroid 2:d07edeaff6f1 474 FixPoint1616_t SignalEstimate;
Davidroid 2:d07edeaff6f1 475 /*!< Signal Estimate - based on ambient & VCSEL rates and cross talk */
Davidroid 2:d07edeaff6f1 476 FixPoint1616_t LastSignalRefMcps;
Davidroid 2:d07edeaff6f1 477 /*!< Latest Signal ref in Mcps */
Davidroid 2:d07edeaff6f1 478 uint8_t *pTuningSettingsPointer;
Davidroid 2:d07edeaff6f1 479 /*!< Pointer for Tuning Settings table */
Davidroid 2:d07edeaff6f1 480 uint8_t UseInternalTuningSettings;
Davidroid 2:d07edeaff6f1 481 /*!< Indicate if we use Tuning Settings table */
Davidroid 2:d07edeaff6f1 482 uint16_t LinearityCorrectiveGain;
Davidroid 2:d07edeaff6f1 483 /*!< Linearity Corrective Gain value in x1000 */
Davidroid 2:d07edeaff6f1 484 uint16_t DmaxCalRangeMilliMeter;
Davidroid 2:d07edeaff6f1 485 /*!< Dmax Calibration Range millimeter */
Davidroid 2:d07edeaff6f1 486 FixPoint1616_t DmaxCalSignalRateRtnMegaCps;
Davidroid 2:d07edeaff6f1 487 /*!< Dmax Calibration Signal Rate Return MegaCps */
nikapov 0:a1a69d32f310 488
sepp_nepp 5:b95f6951f7d5 489 /* } VL53L0X_DevData_t; */
sepp_nepp 5:b95f6951f7d5 490
sepp_nepp 5:b95f6951f7d5 491 /**
sepp_nepp 5:b95f6951f7d5 492 * @struct VL53L0X_Dev_t
sepp_nepp 5:b95f6951f7d5 493 * @brief Generic PAL device type that does link between API and platform abstraction layer
sepp_nepp 5:b95f6951f7d5 494 *
sepp_nepp 5:b95f6951f7d5 495 */
sepp_nepp 5:b95f6951f7d5 496 /* typedef struct {
sepp_nepp 5:b95f6951f7d5 497 VL53L0X_DevData_t Data; */ /*!< embed ST FlightSense Dev data as "Data"*/
sepp_nepp 5:b95f6951f7d5 498
sepp_nepp 5:b95f6951f7d5 499 /*!< user specific field */
sepp_nepp 5:b95f6951f7d5 500 uint8_t I2cDevAddr; /*!< i2c device address user specific field */
sepp_nepp 5:b95f6951f7d5 501 uint8_t comms_type; /*!< Type of comms : VL53L0X_COMMS_I2C or VL53L0X_COMMS_SPI */
sepp_nepp 5:b95f6951f7d5 502 uint16_t comms_speed_khz; /*!< Comms speed [kHz] : typically 400kHz for I2C */
sepp_nepp 5:b95f6951f7d5 503
sepp_nepp 5:b95f6951f7d5 504 } VL53L0X_Dev_t;
sepp_nepp 5:b95f6951f7d5 505
sepp_nepp 5:b95f6951f7d5 506 /**
sepp_nepp 5:b95f6951f7d5 507 * @brief Declare the device Handle as a pointer of the structure @a VL53L0X_Dev_t.
sepp_nepp 5:b95f6951f7d5 508 */
sepp_nepp 5:b95f6951f7d5 509 typedef VL53L0X_Dev_t *VL53L0X_DEV;
nikapov 0:a1a69d32f310 510
sepp_nepp 5:b95f6951f7d5 511 // All the macros that access the above fields
sepp_nepp 5:b95f6951f7d5 512 /**
sepp_nepp 5:b95f6951f7d5 513 * @def PALDevDataGet
sepp_nepp 5:b95f6951f7d5 514 * @brief Get ST private structure @a VL53L0X_DevData_t data access
sepp_nepp 5:b95f6951f7d5 515 *
sepp_nepp 5:b95f6951f7d5 516 * @param Dev Device Handle
sepp_nepp 5:b95f6951f7d5 517 * @param field ST structure field name
sepp_nepp 5:b95f6951f7d5 518 * It maybe used and as real data "ref" not just as "get" for sub-structure item
sepp_nepp 5:b95f6951f7d5 519 * like PALDevDataGet(FilterData.field)[i] or PALDevDataGet(FilterData.MeasurementIndex)++
sepp_nepp 5:b95f6951f7d5 520 */
sepp_nepp 5:b95f6951f7d5 521 #define PALDevDataGet(Dev, field) (Dev->field)
nikapov 0:a1a69d32f310 522
sepp_nepp 5:b95f6951f7d5 523 /**
sepp_nepp 5:b95f6951f7d5 524 * @def PALDevDataSet(Dev, field, data)
sepp_nepp 5:b95f6951f7d5 525 * @brief Set ST private structure @a VL53L0X_DevData_t data field
sepp_nepp 5:b95f6951f7d5 526 * @param Dev Device Handle
sepp_nepp 5:b95f6951f7d5 527 * @param field ST structure field name
sepp_nepp 5:b95f6951f7d5 528 * @param data Data to be set
sepp_nepp 5:b95f6951f7d5 529 */
sepp_nepp 5:b95f6951f7d5 530 #define PALDevDataSet(Dev, field, data) (Dev->field)=(data)
sepp_nepp 5:b95f6951f7d5 531
sepp_nepp 5:b95f6951f7d5 532 #define VL53L0X_SETPARAMETERFIELD(Dev, field, value) \
sepp_nepp 5:b95f6951f7d5 533 PALDevDataSet(Dev, CurrentParameters.field, value)
sepp_nepp 5:b95f6951f7d5 534
sepp_nepp 5:b95f6951f7d5 535 #define VL53L0X_GETPARAMETERFIELD(Dev, field, variable) \
sepp_nepp 5:b95f6951f7d5 536 variable = PALDevDataGet(Dev, CurrentParameters).field
sepp_nepp 5:b95f6951f7d5 537
sepp_nepp 5:b95f6951f7d5 538 #define VL53L0X_SETARRAYPARAMETERFIELD(Dev, field, index, value) \
sepp_nepp 5:b95f6951f7d5 539 PALDevDataSet(Dev, CurrentParameters.field[index], value)
sepp_nepp 5:b95f6951f7d5 540
sepp_nepp 5:b95f6951f7d5 541 #define VL53L0X_GETARRAYPARAMETERFIELD(Dev, field, index, variable) \
sepp_nepp 5:b95f6951f7d5 542 variable = PALDevDataGet(Dev, CurrentParameters).field[index]
sepp_nepp 5:b95f6951f7d5 543
sepp_nepp 5:b95f6951f7d5 544 #define VL53L0X_SETDEVICESPECIFICPARAMETER(Dev, field, value) \
sepp_nepp 5:b95f6951f7d5 545 PALDevDataSet(Dev, DeviceSpecificParameters.field, value)
sepp_nepp 5:b95f6951f7d5 546
sepp_nepp 5:b95f6951f7d5 547 #define VL53L0X_GETDEVICESPECIFICPARAMETER(Dev, field) \
sepp_nepp 5:b95f6951f7d5 548 PALDevDataGet(Dev, DeviceSpecificParameters).field
sepp_nepp 5:b95f6951f7d5 549
sepp_nepp 5:b95f6951f7d5 550
nikapov 0:a1a69d32f310 551 /** @defgroup VL53L0X_define_InterruptPolarity_group Defines the Polarity
nikapov 0:a1a69d32f310 552 * of the Interrupt
nikapov 0:a1a69d32f310 553 * Defines the Polarity of the Interrupt
nikapov 0:a1a69d32f310 554 * @{
nikapov 0:a1a69d32f310 555 */
nikapov 0:a1a69d32f310 556 typedef uint8_t VL53L0X_InterruptPolarity;
nikapov 0:a1a69d32f310 557
nikapov 0:a1a69d32f310 558 #define VL53L0X_INTERRUPTPOLARITY_LOW ((VL53L0X_InterruptPolarity) 0)
nikapov 0:a1a69d32f310 559 /*!< Set active low polarity best setup for falling edge. */
nikapov 0:a1a69d32f310 560 #define VL53L0X_INTERRUPTPOLARITY_HIGH ((VL53L0X_InterruptPolarity) 1)
nikapov 0:a1a69d32f310 561 /*!< Set active high polarity best setup for rising edge. */
nikapov 0:a1a69d32f310 562
nikapov 0:a1a69d32f310 563 /** @} VL53L0X_define_InterruptPolarity_group */
nikapov 0:a1a69d32f310 564
nikapov 0:a1a69d32f310 565
nikapov 0:a1a69d32f310 566 /** @defgroup VL53L0X_define_VcselPeriod_group Vcsel Period Defines
nikapov 0:a1a69d32f310 567 * Defines the range measurement for which to access the vcsel period.
nikapov 0:a1a69d32f310 568 * @{
nikapov 0:a1a69d32f310 569 */
nikapov 0:a1a69d32f310 570 typedef uint8_t VL53L0X_VcselPeriod;
nikapov 0:a1a69d32f310 571
nikapov 0:a1a69d32f310 572 #define VL53L0X_VCSEL_PERIOD_PRE_RANGE ((VL53L0X_VcselPeriod) 0)
nikapov 0:a1a69d32f310 573 /*!<Identifies the pre-range vcsel period. */
nikapov 0:a1a69d32f310 574 #define VL53L0X_VCSEL_PERIOD_FINAL_RANGE ((VL53L0X_VcselPeriod) 1)
nikapov 0:a1a69d32f310 575 /*!<Identifies the final range vcsel period. */
nikapov 0:a1a69d32f310 576
nikapov 0:a1a69d32f310 577 /** @} VL53L0X_define_VcselPeriod_group */
nikapov 0:a1a69d32f310 578
nikapov 0:a1a69d32f310 579 /** @defgroup VL53L0X_define_SchedulerSequence_group Defines the steps
nikapov 0:a1a69d32f310 580 * carried out by the scheduler during a range measurement.
nikapov 0:a1a69d32f310 581 * @{
nikapov 0:a1a69d32f310 582 * Defines the states of all the steps in the scheduler
nikapov 0:a1a69d32f310 583 * i.e. enabled/disabled.
nikapov 0:a1a69d32f310 584 */
nikapov 0:a1a69d32f310 585 typedef struct {
Davidroid 2:d07edeaff6f1 586 uint8_t TccOn; /*!<Reports if Target Centre Check On */
Davidroid 2:d07edeaff6f1 587 uint8_t MsrcOn; /*!<Reports if MSRC On */
Davidroid 2:d07edeaff6f1 588 uint8_t DssOn; /*!<Reports if DSS On */
Davidroid 2:d07edeaff6f1 589 uint8_t PreRangeOn; /*!<Reports if Pre-Range On */
Davidroid 2:d07edeaff6f1 590 uint8_t FinalRangeOn; /*!<Reports if Final-Range On */
nikapov 0:a1a69d32f310 591 } VL53L0X_SchedulerSequenceSteps_t;
nikapov 0:a1a69d32f310 592
nikapov 0:a1a69d32f310 593 /** @} VL53L0X_define_SchedulerSequence_group */
nikapov 0:a1a69d32f310 594
nikapov 0:a1a69d32f310 595 /** @defgroup VL53L0X_define_SequenceStepId_group Defines the Polarity
nikapov 0:a1a69d32f310 596 * of the Interrupt
nikapov 0:a1a69d32f310 597 * Defines the the sequence steps performed during ranging..
nikapov 0:a1a69d32f310 598 * @{
nikapov 0:a1a69d32f310 599 */
nikapov 0:a1a69d32f310 600 typedef uint8_t VL53L0X_SequenceStepId;
nikapov 0:a1a69d32f310 601
nikapov 0:a1a69d32f310 602 #define VL53L0X_SEQUENCESTEP_TCC ((VL53L0X_VcselPeriod) 0)
nikapov 0:a1a69d32f310 603 /*!<Target CentreCheck identifier. */
nikapov 0:a1a69d32f310 604 #define VL53L0X_SEQUENCESTEP_DSS ((VL53L0X_VcselPeriod) 1)
nikapov 0:a1a69d32f310 605 /*!<Dynamic Spad Selection function Identifier. */
nikapov 0:a1a69d32f310 606 #define VL53L0X_SEQUENCESTEP_MSRC ((VL53L0X_VcselPeriod) 2)
nikapov 0:a1a69d32f310 607 /*!<Minimum Signal Rate Check function Identifier. */
nikapov 0:a1a69d32f310 608 #define VL53L0X_SEQUENCESTEP_PRE_RANGE ((VL53L0X_VcselPeriod) 3)
nikapov 0:a1a69d32f310 609 /*!<Pre-Range check Identifier. */
nikapov 0:a1a69d32f310 610 #define VL53L0X_SEQUENCESTEP_FINAL_RANGE ((VL53L0X_VcselPeriod) 4)
nikapov 0:a1a69d32f310 611 /*!<Final Range Check Identifier. */
nikapov 0:a1a69d32f310 612
nikapov 0:a1a69d32f310 613 #define VL53L0X_SEQUENCESTEP_NUMBER_OF_CHECKS 5
nikapov 0:a1a69d32f310 614 /*!<Number of Sequence Step Managed by the API. */
nikapov 0:a1a69d32f310 615
nikapov 0:a1a69d32f310 616 /** @} VL53L0X_define_SequenceStepId_group */
nikapov 0:a1a69d32f310 617
nikapov 0:a1a69d32f310 618 /* MACRO Definitions */
nikapov 0:a1a69d32f310 619 /** @defgroup VL53L0X_define_GeneralMacro_group General Macro Defines
nikapov 0:a1a69d32f310 620 * General Macro Defines
nikapov 0:a1a69d32f310 621 * @{
nikapov 0:a1a69d32f310 622 */
nikapov 0:a1a69d32f310 623
nikapov 0:a1a69d32f310 624 /* Defines */
nikapov 0:a1a69d32f310 625
nikapov 0:a1a69d32f310 626 #define VL53L0X_FIXPOINT1616TOFIXPOINT97(Value) \
nikapov 0:a1a69d32f310 627 (uint16_t)((Value>>9)&0xFFFF)
nikapov 0:a1a69d32f310 628 #define VL53L0X_FIXPOINT97TOFIXPOINT1616(Value) \
nikapov 0:a1a69d32f310 629 (FixPoint1616_t)(Value<<9)
nikapov 0:a1a69d32f310 630
nikapov 0:a1a69d32f310 631 #define VL53L0X_FIXPOINT1616TOFIXPOINT88(Value) \
nikapov 0:a1a69d32f310 632 (uint16_t)((Value>>8)&0xFFFF)
nikapov 0:a1a69d32f310 633 #define VL53L0X_FIXPOINT88TOFIXPOINT1616(Value) \
nikapov 0:a1a69d32f310 634 (FixPoint1616_t)(Value<<8)
nikapov 0:a1a69d32f310 635
nikapov 0:a1a69d32f310 636 #define VL53L0X_FIXPOINT1616TOFIXPOINT412(Value) \
nikapov 0:a1a69d32f310 637 (uint16_t)((Value>>4)&0xFFFF)
nikapov 0:a1a69d32f310 638 #define VL53L0X_FIXPOINT412TOFIXPOINT1616(Value) \
nikapov 0:a1a69d32f310 639 (FixPoint1616_t)(Value<<4)
nikapov 0:a1a69d32f310 640
nikapov 0:a1a69d32f310 641 #define VL53L0X_FIXPOINT1616TOFIXPOINT313(Value) \
nikapov 0:a1a69d32f310 642 (uint16_t)((Value>>3)&0xFFFF)
nikapov 0:a1a69d32f310 643 #define VL53L0X_FIXPOINT313TOFIXPOINT1616(Value) \
nikapov 0:a1a69d32f310 644 (FixPoint1616_t)(Value<<3)
nikapov 0:a1a69d32f310 645
nikapov 0:a1a69d32f310 646 #define VL53L0X_FIXPOINT1616TOFIXPOINT08(Value) \
nikapov 0:a1a69d32f310 647 (uint8_t)((Value>>8)&0x00FF)
nikapov 0:a1a69d32f310 648 #define VL53L0X_FIXPOINT08TOFIXPOINT1616(Value) \
nikapov 0:a1a69d32f310 649 (FixPoint1616_t)(Value<<8)
nikapov 0:a1a69d32f310 650
nikapov 0:a1a69d32f310 651 #define VL53L0X_FIXPOINT1616TOFIXPOINT53(Value) \
nikapov 0:a1a69d32f310 652 (uint8_t)((Value>>13)&0x00FF)
nikapov 0:a1a69d32f310 653 #define VL53L0X_FIXPOINT53TOFIXPOINT1616(Value) \
nikapov 0:a1a69d32f310 654 (FixPoint1616_t)(Value<<13)
nikapov 0:a1a69d32f310 655
nikapov 0:a1a69d32f310 656 #define VL53L0X_FIXPOINT1616TOFIXPOINT102(Value) \
nikapov 0:a1a69d32f310 657 (uint16_t)((Value>>14)&0x0FFF)
nikapov 0:a1a69d32f310 658 #define VL53L0X_FIXPOINT102TOFIXPOINT1616(Value) \
nikapov 0:a1a69d32f310 659 (FixPoint1616_t)(Value<<12)
nikapov 0:a1a69d32f310 660
nikapov 0:a1a69d32f310 661 #define VL53L0X_MAKEUINT16(lsb, msb) (uint16_t)((((uint16_t)msb)<<8) + \
nikapov 0:a1a69d32f310 662 (uint16_t)lsb)
nikapov 0:a1a69d32f310 663
nikapov 0:a1a69d32f310 664 /** @} VL53L0X_define_GeneralMacro_group */
nikapov 0:a1a69d32f310 665
nikapov 0:a1a69d32f310 666 /** @} VL53L0X_globaldefine_group */
nikapov 0:a1a69d32f310 667
nikapov 0:a1a69d32f310 668 #ifdef __cplusplus
nikapov 0:a1a69d32f310 669 }
nikapov 0:a1a69d32f310 670 #endif
nikapov 0:a1a69d32f310 671
nikapov 0:a1a69d32f310 672 #endif /* _VL53L0X_DEF_H_ */