VL53L1X sensor class, for ARM Mbed platform. Based on Ultra-lite, Mass-market C Driver.
Dependencies: X_NUCLEO_COMMON ST_INTERFACES
vl53l1x_error_codes.h@5:f16727052990, 2019-01-28 (annotated)
- Committer:
- JerrySzczurak
- Date:
- Mon Jan 28 10:14:03 2019 +0000
- Revision:
- 5:f16727052990
Initial Cpp mass market sensor class declaration
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
JerrySzczurak | 5:f16727052990 | 1 | /* |
JerrySzczurak | 5:f16727052990 | 2 | * Copyright (c) 2017, STMicroelectronics - All Rights Reserved |
JerrySzczurak | 5:f16727052990 | 3 | * |
JerrySzczurak | 5:f16727052990 | 4 | * This file is part of VL53L1 Core and is dual licensed, |
JerrySzczurak | 5:f16727052990 | 5 | * either 'STMicroelectronics |
JerrySzczurak | 5:f16727052990 | 6 | * Proprietary license' |
JerrySzczurak | 5:f16727052990 | 7 | * or 'BSD 3-clause "New" or "Revised" License' , at your option. |
JerrySzczurak | 5:f16727052990 | 8 | * |
JerrySzczurak | 5:f16727052990 | 9 | ******************************************************************************** |
JerrySzczurak | 5:f16727052990 | 10 | * |
JerrySzczurak | 5:f16727052990 | 11 | * 'STMicroelectronics Proprietary license' |
JerrySzczurak | 5:f16727052990 | 12 | * |
JerrySzczurak | 5:f16727052990 | 13 | ******************************************************************************** |
JerrySzczurak | 5:f16727052990 | 14 | * |
JerrySzczurak | 5:f16727052990 | 15 | * License terms: STMicroelectronics Proprietary in accordance with licensing |
JerrySzczurak | 5:f16727052990 | 16 | * terms at www.st.com/sla0081 |
JerrySzczurak | 5:f16727052990 | 17 | * |
JerrySzczurak | 5:f16727052990 | 18 | * STMicroelectronics confidential |
JerrySzczurak | 5:f16727052990 | 19 | * Reproduction and Communication of this document is strictly prohibited unless |
JerrySzczurak | 5:f16727052990 | 20 | * specifically authorized in writing by STMicroelectronics. |
JerrySzczurak | 5:f16727052990 | 21 | * |
JerrySzczurak | 5:f16727052990 | 22 | * |
JerrySzczurak | 5:f16727052990 | 23 | ******************************************************************************** |
JerrySzczurak | 5:f16727052990 | 24 | * |
JerrySzczurak | 5:f16727052990 | 25 | * Alternatively, VL53L1 Core may be distributed under the terms of |
JerrySzczurak | 5:f16727052990 | 26 | * 'BSD 3-clause "New" or "Revised" License', in which case the following |
JerrySzczurak | 5:f16727052990 | 27 | * provisions apply instead of the ones mentioned above : |
JerrySzczurak | 5:f16727052990 | 28 | * |
JerrySzczurak | 5:f16727052990 | 29 | ******************************************************************************** |
JerrySzczurak | 5:f16727052990 | 30 | * |
JerrySzczurak | 5:f16727052990 | 31 | * License terms: BSD 3-clause "New" or "Revised" License. |
JerrySzczurak | 5:f16727052990 | 32 | * |
JerrySzczurak | 5:f16727052990 | 33 | * Redistribution and use in source and binary forms, with or without |
JerrySzczurak | 5:f16727052990 | 34 | * modification, are permitted provided that the following conditions are met: |
JerrySzczurak | 5:f16727052990 | 35 | * |
JerrySzczurak | 5:f16727052990 | 36 | * 1. Redistributions of source code must retain the above copyright notice, this |
JerrySzczurak | 5:f16727052990 | 37 | * list of conditions and the following disclaimer. |
JerrySzczurak | 5:f16727052990 | 38 | * |
JerrySzczurak | 5:f16727052990 | 39 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
JerrySzczurak | 5:f16727052990 | 40 | * this list of conditions and the following disclaimer in the documentation |
JerrySzczurak | 5:f16727052990 | 41 | * and/or other materials provided with the distribution. |
JerrySzczurak | 5:f16727052990 | 42 | * |
JerrySzczurak | 5:f16727052990 | 43 | * 3. Neither the name of the copyright holder nor the names of its contributors |
JerrySzczurak | 5:f16727052990 | 44 | * may be used to endorse or promote products derived from this software |
JerrySzczurak | 5:f16727052990 | 45 | * without specific prior written permission. |
JerrySzczurak | 5:f16727052990 | 46 | * |
JerrySzczurak | 5:f16727052990 | 47 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
JerrySzczurak | 5:f16727052990 | 48 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
JerrySzczurak | 5:f16727052990 | 49 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
JerrySzczurak | 5:f16727052990 | 50 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
JerrySzczurak | 5:f16727052990 | 51 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
JerrySzczurak | 5:f16727052990 | 52 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
JerrySzczurak | 5:f16727052990 | 53 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
JerrySzczurak | 5:f16727052990 | 54 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
JerrySzczurak | 5:f16727052990 | 55 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
JerrySzczurak | 5:f16727052990 | 56 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
JerrySzczurak | 5:f16727052990 | 57 | * |
JerrySzczurak | 5:f16727052990 | 58 | * |
JerrySzczurak | 5:f16727052990 | 59 | ******************************************************************************** |
JerrySzczurak | 5:f16727052990 | 60 | * |
JerrySzczurak | 5:f16727052990 | 61 | */ |
JerrySzczurak | 5:f16727052990 | 62 | |
JerrySzczurak | 5:f16727052990 | 63 | /** |
JerrySzczurak | 5:f16727052990 | 64 | * @file vl53l1_error_codes.h |
JerrySzczurak | 5:f16727052990 | 65 | * |
JerrySzczurak | 5:f16727052990 | 66 | * @brief Error Code definitions for VL53L1 API. |
JerrySzczurak | 5:f16727052990 | 67 | * |
JerrySzczurak | 5:f16727052990 | 68 | */ |
JerrySzczurak | 5:f16727052990 | 69 | |
JerrySzczurak | 5:f16727052990 | 70 | #ifndef _VL53L1X_ERROR_CODES_H_ |
JerrySzczurak | 5:f16727052990 | 71 | #define _VL53L1X_ERROR_CODES_H_ |
JerrySzczurak | 5:f16727052990 | 72 | |
JerrySzczurak | 5:f16727052990 | 73 | #ifdef __cplusplus |
JerrySzczurak | 5:f16727052990 | 74 | extern "C" { |
JerrySzczurak | 5:f16727052990 | 75 | #endif |
JerrySzczurak | 5:f16727052990 | 76 | |
JerrySzczurak | 5:f16727052990 | 77 | |
JerrySzczurak | 5:f16727052990 | 78 | /**************************************** |
JerrySzczurak | 5:f16727052990 | 79 | * PRIVATE define do not edit |
JerrySzczurak | 5:f16727052990 | 80 | ****************************************/ |
JerrySzczurak | 5:f16727052990 | 81 | |
JerrySzczurak | 5:f16727052990 | 82 | /** @defgroup VL53L1_define_Error_group Error and Warning code returned by API |
JerrySzczurak | 5:f16727052990 | 83 | * The following DEFINE are used to identify the PAL ERROR |
JerrySzczurak | 5:f16727052990 | 84 | * @{ |
JerrySzczurak | 5:f16727052990 | 85 | */ |
JerrySzczurak | 5:f16727052990 | 86 | |
JerrySzczurak | 5:f16727052990 | 87 | typedef int8_t VL53L1_Error; |
JerrySzczurak | 5:f16727052990 | 88 | |
JerrySzczurak | 5:f16727052990 | 89 | #define VL53L1_ERROR_NONE ((VL53L1_Error) 0) |
JerrySzczurak | 5:f16727052990 | 90 | #define VL53L1_ERROR_CALIBRATION_WARNING ((VL53L1_Error) - 1) |
JerrySzczurak | 5:f16727052990 | 91 | /*!< Warning invalid calibration data may be in used |
JerrySzczurak | 5:f16727052990 | 92 | \a VL53L1_InitData() |
JerrySzczurak | 5:f16727052990 | 93 | \a VL53L1_GetOffsetCalibrationData |
JerrySzczurak | 5:f16727052990 | 94 | \a VL53L1_SetOffsetCalibrationData */ |
JerrySzczurak | 5:f16727052990 | 95 | #define VL53L1_ERROR_MIN_CLIPPED ((VL53L1_Error) - 2) |
JerrySzczurak | 5:f16727052990 | 96 | /*!< Warning parameter passed was clipped to min before to be applied */ |
JerrySzczurak | 5:f16727052990 | 97 | |
JerrySzczurak | 5:f16727052990 | 98 | #define VL53L1_ERROR_UNDEFINED ((VL53L1_Error) - 3) |
JerrySzczurak | 5:f16727052990 | 99 | /*!< Unqualified error */ |
JerrySzczurak | 5:f16727052990 | 100 | #define VL53L1_ERROR_INVALID_PARAMS ((VL53L1_Error) - 4) |
JerrySzczurak | 5:f16727052990 | 101 | /*!< Parameter passed is invalid or out of range */ |
JerrySzczurak | 5:f16727052990 | 102 | #define VL53L1_ERROR_NOT_SUPPORTED ((VL53L1_Error) - 5) |
JerrySzczurak | 5:f16727052990 | 103 | /*!< Function is not supported in current mode or configuration */ |
JerrySzczurak | 5:f16727052990 | 104 | #define VL53L1_ERROR_RANGE_ERROR ((VL53L1_Error) - 6) |
JerrySzczurak | 5:f16727052990 | 105 | /*!< Device report a ranging error interrupt status */ |
JerrySzczurak | 5:f16727052990 | 106 | #define VL53L1_ERROR_TIME_OUT ((VL53L1_Error) - 7) |
JerrySzczurak | 5:f16727052990 | 107 | /*!< Aborted due to time out */ |
JerrySzczurak | 5:f16727052990 | 108 | #define VL53L1_ERROR_MODE_NOT_SUPPORTED ((VL53L1_Error) - 8) |
JerrySzczurak | 5:f16727052990 | 109 | /*!< Asked mode is not supported by the device */ |
JerrySzczurak | 5:f16727052990 | 110 | #define VL53L1_ERROR_BUFFER_TOO_SMALL ((VL53L1_Error) - 9) |
JerrySzczurak | 5:f16727052990 | 111 | /*!< ... */ |
JerrySzczurak | 5:f16727052990 | 112 | #define VL53L1_ERROR_COMMS_BUFFER_TOO_SMALL ((VL53L1_Error) - 10) |
JerrySzczurak | 5:f16727052990 | 113 | /*!< Supplied buffer is larger than I2C supports */ |
JerrySzczurak | 5:f16727052990 | 114 | #define VL53L1_ERROR_GPIO_NOT_EXISTING ((VL53L1_Error) - 11) |
JerrySzczurak | 5:f16727052990 | 115 | /*!< User tried to setup a non-existing GPIO pin */ |
JerrySzczurak | 5:f16727052990 | 116 | #define VL53L1_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED ((VL53L1_Error) - 12) |
JerrySzczurak | 5:f16727052990 | 117 | /*!< unsupported GPIO functionality */ |
JerrySzczurak | 5:f16727052990 | 118 | #define VL53L1_ERROR_CONTROL_INTERFACE ((VL53L1_Error) - 13) |
JerrySzczurak | 5:f16727052990 | 119 | /*!< error reported from IO functions */ |
JerrySzczurak | 5:f16727052990 | 120 | #define VL53L1_ERROR_INVALID_COMMAND ((VL53L1_Error) - 14) |
JerrySzczurak | 5:f16727052990 | 121 | /*!< The command is not allowed in the current device state |
JerrySzczurak | 5:f16727052990 | 122 | * (power down) */ |
JerrySzczurak | 5:f16727052990 | 123 | #define VL53L1_ERROR_DIVISION_BY_ZERO ((VL53L1_Error) - 15) |
JerrySzczurak | 5:f16727052990 | 124 | /*!< In the function a division by zero occurs */ |
JerrySzczurak | 5:f16727052990 | 125 | #define VL53L1_ERROR_REF_SPAD_INIT ((VL53L1_Error) - 16) |
JerrySzczurak | 5:f16727052990 | 126 | /*!< Error during reference SPAD initialization */ |
JerrySzczurak | 5:f16727052990 | 127 | #define VL53L1_ERROR_GPH_SYNC_CHECK_FAIL ((VL53L1_Error) - 17) |
JerrySzczurak | 5:f16727052990 | 128 | /*!< GPH sync interrupt check fail - API out of sync with device*/ |
JerrySzczurak | 5:f16727052990 | 129 | #define VL53L1_ERROR_STREAM_COUNT_CHECK_FAIL ((VL53L1_Error) - 18) |
JerrySzczurak | 5:f16727052990 | 130 | /*!< Stream count check fail - API out of sync with device */ |
JerrySzczurak | 5:f16727052990 | 131 | #define VL53L1_ERROR_GPH_ID_CHECK_FAIL ((VL53L1_Error) - 19) |
JerrySzczurak | 5:f16727052990 | 132 | /*!< GPH ID check fail - API out of sync with device */ |
JerrySzczurak | 5:f16727052990 | 133 | #define VL53L1_ERROR_ZONE_STREAM_COUNT_CHECK_FAIL ((VL53L1_Error) - 20) |
JerrySzczurak | 5:f16727052990 | 134 | /*!< Zone dynamic config stream count check failed - API out of sync */ |
JerrySzczurak | 5:f16727052990 | 135 | #define VL53L1_ERROR_ZONE_GPH_ID_CHECK_FAIL ((VL53L1_Error) - 21) |
JerrySzczurak | 5:f16727052990 | 136 | /*!< Zone dynamic config GPH ID check failed - API out of sync */ |
JerrySzczurak | 5:f16727052990 | 137 | |
JerrySzczurak | 5:f16727052990 | 138 | #define VL53L1_ERROR_XTALK_EXTRACTION_NO_SAMPLE_FAIL ((VL53L1_Error) - 22) |
JerrySzczurak | 5:f16727052990 | 139 | /*!< Thrown when run_xtalk_extraction fn has 0 succesful samples |
JerrySzczurak | 5:f16727052990 | 140 | * when using the full array to sample the xtalk. In this case there is |
JerrySzczurak | 5:f16727052990 | 141 | * not enough information to generate new Xtalk parm info. The function |
JerrySzczurak | 5:f16727052990 | 142 | * will exit and leave the current xtalk parameters unaltered */ |
JerrySzczurak | 5:f16727052990 | 143 | #define VL53L1_ERROR_XTALK_EXTRACTION_SIGMA_LIMIT_FAIL ((VL53L1_Error) - 23) |
JerrySzczurak | 5:f16727052990 | 144 | /*!< Thrown when run_xtalk_extraction fn has found that the |
JerrySzczurak | 5:f16727052990 | 145 | * avg sigma estimate of the full array xtalk sample is > than the |
JerrySzczurak | 5:f16727052990 | 146 | * maximal limit allowed. In this case the xtalk sample is too noisy for |
JerrySzczurak | 5:f16727052990 | 147 | * measurement. The function will exit and leave the current xtalk parameters |
JerrySzczurak | 5:f16727052990 | 148 | * unaltered. */ |
JerrySzczurak | 5:f16727052990 | 149 | |
JerrySzczurak | 5:f16727052990 | 150 | |
JerrySzczurak | 5:f16727052990 | 151 | #define VL53L1_ERROR_OFFSET_CAL_NO_SAMPLE_FAIL ((VL53L1_Error) - 24) |
JerrySzczurak | 5:f16727052990 | 152 | /*!< Thrown if there one of stages has no valid offset calibration |
JerrySzczurak | 5:f16727052990 | 153 | * samples. A fatal error calibration not valid */ |
JerrySzczurak | 5:f16727052990 | 154 | #define VL53L1_ERROR_OFFSET_CAL_NO_SPADS_ENABLED_FAIL ((VL53L1_Error) - 25) |
JerrySzczurak | 5:f16727052990 | 155 | /*!< Thrown if there one of stages has zero effective SPADS |
JerrySzczurak | 5:f16727052990 | 156 | * Traps the case when MM1 SPADs is zero. |
JerrySzczurak | 5:f16727052990 | 157 | * A fatal error calibration not valid */ |
JerrySzczurak | 5:f16727052990 | 158 | #define VL53L1_ERROR_ZONE_CAL_NO_SAMPLE_FAIL ((VL53L1_Error) - 26) |
JerrySzczurak | 5:f16727052990 | 159 | /*!< Thrown if then some of the zones have no valid samples |
JerrySzczurak | 5:f16727052990 | 160 | * A fatal error calibration not valid */ |
JerrySzczurak | 5:f16727052990 | 161 | |
JerrySzczurak | 5:f16727052990 | 162 | #define VL53L1_ERROR_TUNING_PARM_KEY_MISMATCH ((VL53L1_Error) - 27) |
JerrySzczurak | 5:f16727052990 | 163 | /*!< Thrown if the tuning file key table version does not match with |
JerrySzczurak | 5:f16727052990 | 164 | * expected value. The driver expects the key table version to match |
JerrySzczurak | 5:f16727052990 | 165 | * the compiled default version number in the define |
JerrySzczurak | 5:f16727052990 | 166 | * #VL53L1_TUNINGPARM_KEY_TABLE_VERSION_DEFAULT |
JerrySzczurak | 5:f16727052990 | 167 | * */ |
JerrySzczurak | 5:f16727052990 | 168 | |
JerrySzczurak | 5:f16727052990 | 169 | #define VL53L1_WARNING_REF_SPAD_CHAR_NOT_ENOUGH_SPADS ((VL53L1_Error) - 28) |
JerrySzczurak | 5:f16727052990 | 170 | /*!< Thrown if there are less than 5 good SPADs are available. */ |
JerrySzczurak | 5:f16727052990 | 171 | #define VL53L1_WARNING_REF_SPAD_CHAR_RATE_TOO_HIGH ((VL53L1_Error) - 29) |
JerrySzczurak | 5:f16727052990 | 172 | /*!< Thrown if the final reference rate is greater than |
JerrySzczurak | 5:f16727052990 | 173 | the upper reference rate limit - default is 40 Mcps. |
JerrySzczurak | 5:f16727052990 | 174 | Implies a minimum Q3 (x10) SPAD (5) selected */ |
JerrySzczurak | 5:f16727052990 | 175 | #define VL53L1_WARNING_REF_SPAD_CHAR_RATE_TOO_LOW ((VL53L1_Error) - 30) |
JerrySzczurak | 5:f16727052990 | 176 | /*!< Thrown if the final reference rate is less than |
JerrySzczurak | 5:f16727052990 | 177 | the lower reference rate limit - default is 10 Mcps. |
JerrySzczurak | 5:f16727052990 | 178 | Implies maximum Q1 (x1) SPADs selected */ |
JerrySzczurak | 5:f16727052990 | 179 | |
JerrySzczurak | 5:f16727052990 | 180 | |
JerrySzczurak | 5:f16727052990 | 181 | #define VL53L1_WARNING_OFFSET_CAL_MISSING_SAMPLES ((VL53L1_Error) - 31) |
JerrySzczurak | 5:f16727052990 | 182 | /*!< Thrown if there is less than the requested number of |
JerrySzczurak | 5:f16727052990 | 183 | * valid samples. */ |
JerrySzczurak | 5:f16727052990 | 184 | #define VL53L1_WARNING_OFFSET_CAL_SIGMA_TOO_HIGH ((VL53L1_Error) - 32) |
JerrySzczurak | 5:f16727052990 | 185 | /*!< Thrown if the offset calibration range sigma estimate is greater |
JerrySzczurak | 5:f16727052990 | 186 | * than 8.0 mm. This is the recommended min value to yield a stable |
JerrySzczurak | 5:f16727052990 | 187 | * offset measurement */ |
JerrySzczurak | 5:f16727052990 | 188 | #define VL53L1_WARNING_OFFSET_CAL_RATE_TOO_HIGH ((VL53L1_Error) - 33) |
JerrySzczurak | 5:f16727052990 | 189 | /*!< Thrown when VL53L1_run_offset_calibration() peak rate is greater |
JerrySzczurak | 5:f16727052990 | 190 | than that 50.0Mcps. This is the recommended max rate to avoid |
JerrySzczurak | 5:f16727052990 | 191 | pile-up influencing the offset measurement */ |
JerrySzczurak | 5:f16727052990 | 192 | #define VL53L1_WARNING_OFFSET_CAL_SPAD_COUNT_TOO_LOW ((VL53L1_Error) - 34) |
JerrySzczurak | 5:f16727052990 | 193 | /*!< Thrown when VL53L1_run_offset_calibration() when one of stages |
JerrySzczurak | 5:f16727052990 | 194 | range has less that 5.0 effective SPADS. This is the recommended |
JerrySzczurak | 5:f16727052990 | 195 | min value to yield a stable offset */ |
JerrySzczurak | 5:f16727052990 | 196 | |
JerrySzczurak | 5:f16727052990 | 197 | |
JerrySzczurak | 5:f16727052990 | 198 | #define VL53L1_WARNING_ZONE_CAL_MISSING_SAMPLES ((VL53L1_Error) - 35) |
JerrySzczurak | 5:f16727052990 | 199 | /*!< Thrown if one of more of the zones have less than |
JerrySzczurak | 5:f16727052990 | 200 | the requested number of valid samples */ |
JerrySzczurak | 5:f16727052990 | 201 | #define VL53L1_WARNING_ZONE_CAL_SIGMA_TOO_HIGH ((VL53L1_Error) - 36) |
JerrySzczurak | 5:f16727052990 | 202 | /*!< Thrown if one or more zones have sigma estimate value greater |
JerrySzczurak | 5:f16727052990 | 203 | * than 8.0 mm. This is the recommended min value to yield a stable |
JerrySzczurak | 5:f16727052990 | 204 | * offset measurement */ |
JerrySzczurak | 5:f16727052990 | 205 | #define VL53L1_WARNING_ZONE_CAL_RATE_TOO_HIGH ((VL53L1_Error) - 37) |
JerrySzczurak | 5:f16727052990 | 206 | /*!< Thrown if one of more zones have peak rate higher than |
JerrySzczurak | 5:f16727052990 | 207 | that 50.0Mcps. This is the recommended max rate to avoid |
JerrySzczurak | 5:f16727052990 | 208 | pile-up influencing the offset measurement */ |
JerrySzczurak | 5:f16727052990 | 209 | |
JerrySzczurak | 5:f16727052990 | 210 | |
JerrySzczurak | 5:f16727052990 | 211 | #define VL53L1_WARNING_XTALK_MISSING_SAMPLES ((VL53L1_Error) - 38) |
JerrySzczurak | 5:f16727052990 | 212 | /*!< Thrown to notify that some of the xtalk samples did not yield |
JerrySzczurak | 5:f16727052990 | 213 | * valid ranging pulse data while attempting to measure |
JerrySzczurak | 5:f16727052990 | 214 | * the xtalk signal in vl53l1_run_xtalk_extract(). This can signify any of |
JerrySzczurak | 5:f16727052990 | 215 | * the zones are missing samples, for further debug information the |
JerrySzczurak | 5:f16727052990 | 216 | * xtalk_results struct should be referred to. This warning is for |
JerrySzczurak | 5:f16727052990 | 217 | * notification only, the xtalk pulse and shape have still been generated |
JerrySzczurak | 5:f16727052990 | 218 | */ |
JerrySzczurak | 5:f16727052990 | 219 | #define VL53L1_WARNING_XTALK_NO_SAMPLES_FOR_GRADIENT ((VL53L1_Error) - 39) |
JerrySzczurak | 5:f16727052990 | 220 | /*!< Thrown to notify that some of teh xtalk samples used for gradient |
JerrySzczurak | 5:f16727052990 | 221 | * generation did not yield valid ranging pulse data while attempting to |
JerrySzczurak | 5:f16727052990 | 222 | * measure the xtalk signal in vl53l1_run_xtalk_extract(). This can signify |
JerrySzczurak | 5:f16727052990 | 223 | * that any one of the zones 0-3 yielded no successful samples. The |
JerrySzczurak | 5:f16727052990 | 224 | * xtalk_results struct should be referred to for further debug info. |
JerrySzczurak | 5:f16727052990 | 225 | * This warning is for notification only, the xtalk pulse and shape |
JerrySzczurak | 5:f16727052990 | 226 | * have still been generated. |
JerrySzczurak | 5:f16727052990 | 227 | */ |
JerrySzczurak | 5:f16727052990 | 228 | #define VL53L1_WARNING_XTALK_SIGMA_LIMIT_FOR_GRADIENT ((VL53L1_Error) - 40) |
JerrySzczurak | 5:f16727052990 | 229 | /*!< Thrown to notify that some of the xtalk samples used for gradient |
JerrySzczurak | 5:f16727052990 | 230 | * generation did not pass the sigma limit check while attempting to |
JerrySzczurak | 5:f16727052990 | 231 | * measure the xtalk signal in vl53l1_run_xtalk_extract(). This can signify |
JerrySzczurak | 5:f16727052990 | 232 | * that any one of the zones 0-3 yielded an avg sigma_mm value > the limit. |
JerrySzczurak | 5:f16727052990 | 233 | * The xtalk_results struct should be referred to for further debug info. |
JerrySzczurak | 5:f16727052990 | 234 | * This warning is for notification only, the xtalk pulse and shape |
JerrySzczurak | 5:f16727052990 | 235 | * have still been generated. |
JerrySzczurak | 5:f16727052990 | 236 | */ |
JerrySzczurak | 5:f16727052990 | 237 | |
JerrySzczurak | 5:f16727052990 | 238 | #define VL53L1_ERROR_NOT_IMPLEMENTED ((VL53L1_Error) - 41) |
JerrySzczurak | 5:f16727052990 | 239 | /*!< Tells requested functionality has not been implemented yet or |
JerrySzczurak | 5:f16727052990 | 240 | * not compatible with the device */ |
JerrySzczurak | 5:f16727052990 | 241 | #define VL53L1_ERROR_PLATFORM_SPECIFIC_START ((VL53L1_Error) - 60) |
JerrySzczurak | 5:f16727052990 | 242 | /*!< Tells the starting code for platform */ |
JerrySzczurak | 5:f16727052990 | 243 | /** @} VL53L1_define_Error_group */ |
JerrySzczurak | 5:f16727052990 | 244 | |
JerrySzczurak | 5:f16727052990 | 245 | |
JerrySzczurak | 5:f16727052990 | 246 | #ifdef __cplusplus |
JerrySzczurak | 5:f16727052990 | 247 | } |
JerrySzczurak | 5:f16727052990 | 248 | #endif |
JerrySzczurak | 5:f16727052990 | 249 | |
JerrySzczurak | 5:f16727052990 | 250 | |
JerrySzczurak | 5:f16727052990 | 251 | #endif /* _VL53L1X_ERROR_CODES_H_ */ |