Rename library
Dependencies: X_NUCLEO_COMMON ST_INTERFACES
Dependents: VL53L3CX_NoShield_1Sensor_poll_Mb06x VL53L3_NoShield_1Sensor_polling_Mb63 X_NUCLEO_53L3A2 53L3A2_Ranging
Diff: modules/vl53lx_preset_setup.h
- Revision:
- 5:89031b2f5316
diff -r 39a9cd3c85f2 -r 89031b2f5316 modules/vl53lx_preset_setup.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/vl53lx_preset_setup.h Wed Jul 14 12:45:49 2021 +0100 @@ -0,0 +1,75 @@ + +/* SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause */ +/****************************************************************************** + * Copyright (c) 2020, STMicroelectronics - All Rights Reserved + + This file is part of VL53LX and is dual licensed, + either GPL-2.0+ + or 'BSD 3-clause "New" or "Revised" License' , at your option. + ****************************************************************************** + */ + +#ifndef _VL53LX_PRESET_SETUP_H_ +#define _VL53LX_PRESET_SETUP_H_ + +#ifdef __cplusplus +extern "C" +{ +#endif + +/* indexes for the bare driver tuning setting API function */ +enum VL53LX_Tuning_t { + VL53LX_TUNING_VERSION = 0, + VL53LX_TUNING_PROXY_MIN, + VL53LX_TUNING_SINGLE_TARGET_XTALK_TARGET_DISTANCE_MM, + VL53LX_TUNING_SINGLE_TARGET_XTALK_SAMPLE_NUMBER, + VL53LX_TUNING_MIN_AMBIENT_DMAX_VALID, + VL53LX_TUNING_MAX_SIMPLE_OFFSET_CALIBRATION_SAMPLE_NUMBER, + VL53LX_TUNING_XTALK_FULL_ROI_TARGET_DISTANCE_MM, + VL53LX_TUNING_SIMPLE_OFFSET_CALIBRATION_REPEAT, + VL53LX_TUNING_XTALK_FULL_ROI_BIN_SUM_MARGIN, + VL53LX_TUNING_XTALK_FULL_ROI_DEFAULT_OFFSET, + VL53LX_TUNING_ZERO_DISTANCE_OFFSET_NON_LINEAR_FACTOR, + VL53LX_TUNING_MAX_TUNABLE_KEY +}; + +/* default values for the tuning settings parameters */ +#define TUNING_VERSION 0x0007 + +#define TUNING_PROXY_MIN -30 /* min distance in mm */ +#define TUNING_SINGLE_TARGET_XTALK_TARGET_DISTANCE_MM 600 +/* Target distance in mm for single target Xtalk */ +#define TUNING_SINGLE_TARGET_XTALK_SAMPLE_NUMBER 50 +/* Number of sample used for single target Xtalk */ +#define TUNING_MIN_AMBIENT_DMAX_VALID 8 +/* Minimum ambient level to state the Dmax returned by the device is valid */ +#ifdef SMALL_FOOTPRINT +#define TUNING_MAX_SIMPLE_OFFSET_CALIBRATION_SAMPLE_NUMBER 50 +#else +#define TUNING_MAX_SIMPLE_OFFSET_CALIBRATION_SAMPLE_NUMBER 10 +#endif +/* Maximum loops to perform simple offset calibration */ +#define TUNING_XTALK_FULL_ROI_TARGET_DISTANCE_MM 600 +/* Target distance in mm for target Xtalk from Bins method*/ +#ifdef SMALL_FOOTPRINT +#define TUNING_SIMPLE_OFFSET_CALIBRATION_REPEAT 1 +#else +#define TUNING_SIMPLE_OFFSET_CALIBRATION_REPEAT 3 +#endif +/* Number of loops done during the simple offset calibration*/ +#define TUNING_ZERO_DISTANCE_OFFSET_NON_LINEAR_FACTOR_DEFAULT 9 +/* zero distance offset calibration non linear compensation default value */ + +/* The following settings are related to the fix for ticket EwokP #558410 */ +#define TUNING_XTALK_FULL_ROI_BIN_SUM_MARGIN 24 +/* Acceptance margin for the xtalk_shape bin_data sum computation */ +#define TUNING_XTALK_FULL_ROI_DEFAULT_OFFSET 50 +/* Recovery value for Xtalk compensation plane offset in kcps */ +/* 50 stands for ~0.10 kcps cover glass in 7.9 format */ +/* End of settings related to the fix for ticket EwokP #558410 */ + +#ifdef __cplusplus +} +#endif + +#endif /* _VL53LX_PRESET_SETUP_H_ */