Jim Carver / Mbed OS pelion-workshop

Workshop example

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

sensors/VL53L0X/VL53L0X_def.h@35:42b3fba640b1, 2019-05-21 (annotated)

Committer:
JimCarver
Date:
Tue May 21 21:16:24 2019 +0000
Revision:
35:42b3fba640b1
Parent:
18:a15bfe7aaebd 
Simple version for workshop

Who changed what in which revision?

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