vl53l1_preset_setup.h

00001 
00002 /* SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause */
00003 /******************************************************************************
00004  * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
00005 
00006  This file is part of VL53L1 and is dual licensed,
00007  either GPL-2.0+
00008  or 'BSD 3-clause "New" or "Revised" License' , at your option.
00009  ******************************************************************************
00010  */
00011 
00012 #ifndef _VL53L1_PRESET_SETUP_H_
00013 #define _VL53L1_PRESET_SETUP_H_
00014 
00015 #ifdef __cplusplus
00016 extern "C"
00017 {
00018 #endif
00019 
00020 /* indexes for the bare driver tuning setting API function */
00021 enum VL53L1_Tuning_t {
00022     VL53L1_TUNING_VERSION = 0,
00023     VL53L1_TUNING_PROXY_MIN,
00024     VL53L1_TUNING_SINGLE_TARGET_XTALK_TARGET_DISTANCE_MM,
00025     VL53L1_TUNING_SINGLE_TARGET_XTALK_SAMPLE_NUMBER,
00026     VL53L1_TUNING_MIN_AMBIENT_DMAX_VALID,
00027     VL53L1_TUNING_MAX_SIMPLE_OFFSET_CALIBRATION_SAMPLE_NUMBER,
00028     VL53L1_TUNING_XTALK_FULL_ROI_TARGET_DISTANCE_MM,
00029     VL53L1_TUNING_SIMPLE_OFFSET_CALIBRATION_REPEAT,
00030     VL53L1_TUNING_XTALK_FULL_ROI_BIN_SUM_MARGIN,
00031     VL53L1_TUNING_XTALK_FULL_ROI_DEFAULT_OFFSET,
00032     VL53L1_TUNING_ZERO_DISTANCE_OFFSET_NON_LINEAR_FACTOR,
00033     VL53L1_TUNING_MAX_TUNABLE_KEY
00034 };
00035 
00036 /* default values for the tuning settings parameters */
00037 #define TUNING_VERSION  0x0007
00038 
00039 #define TUNING_PROXY_MIN -30 /* min distance in mm */
00040 #define TUNING_SINGLE_TARGET_XTALK_TARGET_DISTANCE_MM 600
00041 /* Target distance in mm for single target Xtalk */
00042 #define TUNING_SINGLE_TARGET_XTALK_SAMPLE_NUMBER 50
00043 /* Number of sample used for single target Xtalk */
00044 #define TUNING_MIN_AMBIENT_DMAX_VALID 8
00045 /* Minimum ambient level to state the Dmax returned by the device is valid */
00046 #define TUNING_MAX_SIMPLE_OFFSET_CALIBRATION_SAMPLE_NUMBER 10
00047 /* Maximum loops to perform simple offset calibration */
00048 #define TUNING_XTALK_FULL_ROI_TARGET_DISTANCE_MM 600
00049 /* Target distance in mm for target Xtalk from Bins method*/
00050 #define TUNING_SIMPLE_OFFSET_CALIBRATION_REPEAT 3
00051 /* Number of loops done during the simple offset calibration*/
00052 #define TUNING_ZERO_DISTANCE_OFFSET_NON_LINEAR_FACTOR_DEFAULT 9
00053 /* zero distance offset calibration non linear compensation default value */
00054 
00055 /* The following settings are related to the fix for ticket EwokP #558410 */
00056 #define TUNING_XTALK_FULL_ROI_BIN_SUM_MARGIN 24
00057 /* Acceptance margin for the xtalk_shape bin_data sum computation */
00058 #define TUNING_XTALK_FULL_ROI_DEFAULT_OFFSET 50
00059 /* Recovery value for Xtalk compensation plane offset in kcps */
00060 /* 50 stands for ~0.10 kcps cover glass in 7.9 format */
00061 /* End of settings related to the fix for ticket EwokP #558410 */
00062 
00063 #ifdef __cplusplus
00064 }
00065 #endif
00066 
00067 #endif /* _VL53L1_PRESET_SETUP_H_ */