Go to the documentation of this file.
78 #define LOG_FUNCTION_START(fmt, ...) \
79 _LOG_FUNCTION_START(VL53L1_TRACE_MODULE_API, fmt, ##__VA_ARGS__)
80 #define LOG_FUNCTION_END(status, ...) \
81 _LOG_FUNCTION_END(VL53L1_TRACE_MODULE_API, status, ##__VA_ARGS__)
82 #define LOG_FUNCTION_END_FMT(status, fmt, ...) \
83 _LOG_FUNCTION_END_FMT(VL53L1_TRACE_MODULE_API, status, fmt, ##__VA_ARGS__)
86 #ifndef VL53L1_NOCALIB
127 #ifndef VL53L1_NOCALIB
248 #ifndef VL53L1_NOCALIB
445 VL53L1_DEVICEINTERRUPTPOLARITY_ACTIVE_LOW | \
446 VL53L1_DEVICEGPIOMODE_OUTPUT_RANGE_AND_ERROR_INTERRUPTS;
627 VL53L1_SEQUENCE_VHV_EN | \
628 VL53L1_SEQUENCE_PHASECAL_EN | \
629 VL53L1_SEQUENCE_DSS1_EN | \
630 VL53L1_SEQUENCE_DSS2_EN | \
631 VL53L1_SEQUENCE_MM2_EN | \
632 VL53L1_SEQUENCE_RANGE_EN;
642 VL53L1_CLEAR_RANGE_INT;
645 VL53L1_DEVICESCHEDULERMODE_STREAMING | \
646 VL53L1_DEVICEREADOUTMODE_SINGLE_SD | \
647 VL53L1_DEVICEMEASUREMENTMODE_BACKTOBACK;
807 #ifndef VL53L1_NOCALIB
849 VL53L1_SEQUENCE_VHV_EN | \
850 VL53L1_SEQUENCE_PHASECAL_EN | \
851 VL53L1_SEQUENCE_DSS1_EN | \
852 VL53L1_SEQUENCE_DSS2_EN | \
853 VL53L1_SEQUENCE_MM1_EN;
903 VL53L1_SEQUENCE_VHV_EN | \
904 VL53L1_SEQUENCE_PHASECAL_EN | \
905 VL53L1_SEQUENCE_DSS1_EN | \
906 VL53L1_SEQUENCE_DSS2_EN | \
907 VL53L1_SEQUENCE_MM2_EN;
980 VL53L1_DEVICEREADOUTMODE_SINGLE_SD | \
981 VL53L1_DEVICEMEASUREMENTMODE_TIMED;
1053 VL53L1_DEVICEREADOUTMODE_SINGLE_SD | \
1054 VL53L1_DEVICEMEASUREMENTMODE_TIMED;
1126 VL53L1_DEVICEREADOUTMODE_SINGLE_SD | \
1127 VL53L1_DEVICEMEASUREMENTMODE_TIMED;
1356 VL53L1_DEVICESCHEDULERMODE_PSEUDO_SOLO | \
1357 VL53L1_DEVICEREADOUTMODE_SINGLE_SD | \
1358 VL53L1_DEVICEMEASUREMENTMODE_SINGLESHOT;
uint8_t system__stream_count_ctrl
uint16_t system__thresh_rate_high
#define VL53L1_DEVICEDSSMODE__REQUESTED_EFFFECTIVE_SPADS
uint8_t tp_lite_sigma_est_amb_width_ns
#define VL53L1_TUNINGPARM_LLD_VERSION_DEFAULT
uint8_t mm_config__timeout_macrop_b_lo
uint8_t crosstalk_range_ignore_threshold_mult
Structure to hold state, tuning and output variables for the low power auto mode (Presence)
#define VL53L1_TUNINGPARM_INITIAL_PHASE_REF_LITE_SHORT_RANGE_DEFAULT
uint32_t tp_range_timeout_lite_us
Type definitions for VL53L1 LL Driver.
uint16_t system__thresh_low
uint8_t pre_num_of_samples
unsigned int uint32_t
Typedef defining 32 bit unsigned int type. The developer should modify this to suit the platform bein...
uint8_t mm_config__timeout_macrop_a_lo
uint8_t sd_config__woi_sd1
uint8_t ana_config__vcsel_pulse_width_offset
#define VL53L1_TUNINGPARM_OFFSET_CAL_MM_TIMEOUT_US_DEFAULT
VL53L1_DeviceSscArray array_select
uint32_t tp_mm_timeout_lite_us
uint16_t tp_lite_short_min_count_rate_rtn_mcps
VL53L1_Error VL53L1_preset_mode_standard_ranging_short_range(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDAR...
uint16_t tp_dss_target_timed_mcps
#define VL53L1_TUNINGPARM_LITE_CAL_REPEAT_RATE_DEFAULT
uint8_t roi_config__user_roi_centre_spad
uint8_t sigma_estimator__effective_pulse_width_ns
uint8_t pad_i2c_hv__config
#define VL53L1_TUNINGPARM_LITE_QUANTIFIER_DEFAULT
#define VL53L1_TUNINGPARM_LITE_PHASECAL_CONFIG_TIMEOUT_US
uint16_t system__thresh_high
VL53L1_Error VL53L1_preset_mode_standard_ranging_mm2_cal(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDAR...
#define VL53L1_TUNINGPARM_VERSION_DEFAULT
uint16_t range_config__sigma_thresh
uint8_t system__mode_start
uint8_t range_config__vcsel_period_a
VL53L1_Error VL53L1_preset_mode_olt(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_OLT.
uint8_t sd_config__initial_phase_sd0
uint8_t tp_init_phase_ref_lite_med
uint16_t tp_tuning_parm_lld_version
#define VL53L1_TUNINGPARM_TIMED_MM_CONFIG_TIMEOUT_US_DEFAULT
#define VL53L1_TUNINGPARM_REFSPADCHAR_MIN_COUNTRATE_LIMIT_MCPS_DEFAULT
#define VL53L1_TUNINGPARM_TIMED_RANGE_CONFIG_TIMEOUT_US_DEFAULT
#define VL53L1_TUNINGPARM_OFFSET_CAL_RANGE_TIMEOUT_US_DEFAULT
#define VL53L1_TUNINGPARM_SPADMAP_VCSEL_PERIOD_DEFAULT
uint16_t dss_config__manual_effective_spads_select
#define VL53L1_TUNINGPARM_LITE_XTALK_MARGIN_KCPS_DEFAULT
uint8_t algo__range_ignore_valid_height_mm
uint8_t system__interrupt_config_gpio
uint8_t dss_config__max_spads_limit
uint8_t range_config__timeout_macrop_a_lo
uint8_t tp_timed_seed_cfg
uint16_t dss_config__target_total_rate_mcps
uint8_t range_config__timeout_macrop_a_hi
uint32_t mm_config_timeout_us
uint8_t dss_config__roi_mode_control
#define VL53L1_TUNINGPARM_INITIAL_PHASE_RTN_LITE_LONG_RANGE_DEFAULT
Device register setting defines.
#define VL53L1_TUNINGPARM_INITIAL_PHASE_RTN_LITE_MED_RANGE_DEFAULT
EwokPlus25 API core function definition.
uint32_t algo__crosstalk_compensation_plane_offset_kcps
uint8_t global_config__stream_divider
uint16_t range_config__min_count_rate_rtn_limit_mcps
uint8_t algo__range_min_clip
#define VL53L1_TUNINGPARM_KEY_TABLE_VERSION_DEFAULT
uint8_t sd_config__first_order_select
#define VL53L1_TUNINGPARM_LITE_MM_CONFIG_TIMEOUT_US_DEFAULT
uint8_t sd_config__quantifier
#define VL53L1_TUNINGPARM_LITE_SEED_CONFIG_DEFAULT
#define VL53L1_TUNINGPARM_REFSPADCHAR_DEVICE_TEST_MODE_DEFAULT
uint16_t tp_lite_short_sigma_thresh_mm
uint8_t pad_i2c_hv__extsup_config
uint8_t dss_config__min_spads_limit
#define VL53L1_TUNINGPARM_TIMED_PHASECAL_CONFIG_TIMEOUT_US_DEFAULT
#define VL53L1_TUNINGPARM_OFFSET_CAL_MM1_SAMPLES_DEFAULT
uint32_t phasecal_config_timeout_us
uint8_t gpio_hv_pad__ctrl
uint8_t tp_init_phase_rtn_lite_short
int16_t algo__crosstalk_compensation_x_plane_gradient_kcps
uint8_t spare_host_config__static_config_spare_0
uint8_t phasecal_config__override
#define VL53L1_TUNINGPARM_INITIAL_PHASE_REF_LITE_LONG_RANGE_DEFAULT
SPAD Self Check (SSC) Config data structure.
#define VL53L1_TUNINGPARM_LITE_LONG_MIN_COUNT_RATE_RTN_MCPS_DEFAULT
VL53L1_Error VL53L1_init_refspadchar_config_struct(VL53L1_refspadchar_config_t *pdata)
Initializes Ref SPAD Char Configuration Parameters.
uint8_t system__grouped_parameter_hold_1
#define VL53L1_TUNINGPARM_OFFSET_CAL_PHASECAL_TIMEOUT_US_DEFAULT
EwokPlus25 core function definitions.
uint8_t spare_host_config__static_config_spare_2
#define VL53L1_TUNINGPARM_LITE_SHORT_MIN_COUNT_RATE_RTN_MCPS_DEFAULT
#define VL53L1_TUNINGPARM_LITE_RANGE_CONFIG_TIMEOUT_US_DEFAULT
uint16_t tp_lite_med_sigma_thresh_mm
uint8_t ana_config__spad_sel_pswidth
uint8_t sd_config__initial_phase_sd1
uint8_t sigma_estimator__sigma_ref_mm
uint8_t mm1_num_of_samples
uint16_t target_count_rate_mcps
uint32_t nvm_default__crosstalk_compensation_plane_offset_kcps
uint16_t tp_dss_target_lite_mcps
uint8_t tp_phasecal_target
#define VL53L1_TUNINGPARM_LITE_DSS_CONFIG_TARGET_TOTAL_RATE_MCPS_DEFAULT
uint8_t sigma_estimator__effective_ambient_width_ns
#define VL53L1_TUNINGPARM_REFSPADCHAR_PHASECAL_TIMEOUT_US_DEFAULT
uint16_t crosstalk_range_ignore_threshold_rate_mcps
VL53L1_Error VL53L1_init_offset_cal_config_struct(VL53L1_offsetcal_config_t *pdata)
Initializes Offset Calibration Configuration Parameters.
#define VL53L1_TUNINGPARM_SPADMAP_RATE_LIMIT_MCPS_DEFAULT
uint8_t gpio__fio_hv_status
uint32_t tp_mm_timeout_lpa_us
uint8_t system__interrupt_clear
uint8_t dss_config__aperture_attenuation
#define VL53L1_TUNINGPARM_LITE_RIT_MULT_DEFAULT
#define VL53L1_TUNINGPARM_TIMED_DSS_CONFIG_TARGET_TOTAL_RATE_MCPS_DEFAULT
uint8_t nvm_bist__num_nvm_words
uint8_t tp_lite_first_order_select
uint8_t system__enable_xtalk_per_quadrant
uint8_t gph_config__stream_count_update_value
uint8_t range_config__timeout_macrop_b_hi
uint8_t tp_init_phase_ref_lite_short
#define VL53L1_TUNINGPARM_OFFSET_CAL_DSS_RATE_MCPS_DEFAULT
#define VL53L1_TUNINGPARM_OFFSET_CAL_MM2_SAMPLES_DEFAULT
uint8_t nvm_bist__start_address
uint8_t tp_init_phase_ref_lite_long
uint8_t dss_config__manual_block_select
uint16_t tp_tuning_parm_key_table_version
uint16_t tp_tuning_parm_version
uint16_t tp_cal_repeat_rate
#define VL53L1_TUNINGPARM_CONSISTENCY_LITE_PHASE_TOLERANCE_DEFAULT
uint8_t cal_config__vcsel_start
#define VL53L1_TUNINGPARM_TIMED_SEED_CONFIG_DEFAULT
#define LOG_FUNCTION_END(status,...)
#define VL53L1_TUNINGPARM_LITE_MED_MIN_COUNT_RATE_RTN_MCPS_DEFAULT
VL53L1 Register Structure definitions.
VL53L1_Error VL53L1_preset_mode_standard_ranging_long_range(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDAR...
#define VL53L1_DEVICEDSSMODE__TARGET_RATE
#define VL53L1_TUNINGPARM_SPADMAP_VCSEL_START_DEFAULT
uint8_t global_config__vcsel_width
VL53L1_Error VL53L1_preset_mode_standard_ranging(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDAR...
uint32_t range_config_timeout_us
uint8_t tp_lite_sigma_est_pulse_width_ns
int16_t lite_mode_crosstalk_margin_kcps
uint8_t system__grouped_parameter_hold_0
uint8_t phasecal_config__target
uint8_t range_config__timeout_macrop_b_lo
#define VL53L1_TUNINGPARM_LITE_MIN_CLIP_MM_DEFAULT
#define VL53L1_TUNINGPARM_LITE_LONG_SIGMA_THRESH_MM_DEFAULT
uint8_t system__sequence_config
#define VL53L1_TUNINGPARM_PHASECAL_TARGET_DEFAULT
uint32_t system__intermeasurement_period
int16_t algo__crosstalk_compensation_y_plane_gradient_kcps
#define LOG_FUNCTION_START(fmt,...)
#define VL53L1_ERROR_NONE
uint8_t roi_config__user_roi_requested_global_xy_size
uint16_t tp_lite_long_min_count_rate_rtn_mcps
uint16_t algo__range_ignore_threshold_mcps
VL53L1_Error VL53L1_preset_mode_low_power_auto_long_ranging(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms, VL53L1_low_power_auto_data_t *plpadata)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_LOWPOWE...
uint16_t system__thresh_rate_low
uint8_t tp_lite_sigma_ref_mm
int16_t algo__crosstalk_compensation_x_plane_gradient_kcps
#define VL53L1_DEVICESCHEDULERMODE_PSEUDO_SOLO
uint8_t mm_config__timeout_macrop_b_hi
Define defaults for tuning parm list.
uint16_t algo__crosstalk_compensation_plane_offset_kcps
uint16_t cal_config__repeat_rate
#define VL53L1_TUNINGPARM_LITE_FIRST_ORDER_SELECT_DEFAULT
#define VL53L1_TUNINGPARM_LOWPOWERAUTO_RANGE_CONFIG_TIMEOUT_US_DEFAULT
uint8_t system__grouped_parameter_hold
uint32_t tp_phasecal_timeout_lite_us
int16_t nvm_default__crosstalk_compensation_x_plane_gradient_kcps
Xtalk Extraction and Paramter Config.
Reference SPAD Characterization (RefSpadChar) Config.
VL53L1_Error VL53L1_config_low_power_auto_mode(VL53L1_general_config_t *pgeneral, VL53L1_dynamic_config_t *pdynamic, VL53L1_low_power_auto_data_t *plpadata)
Initialize the config strcutures when low power auto preset modes are selected.
uint32_t tp_mm_timeout_timed_us
VL53L1_Error VL53L1_preset_mode_singleshot_ranging(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_SINGLES...
uint8_t spare_host_config__static_config_spare_1
uint16_t tp_lite_long_sigma_thresh_mm
uint8_t system__seed_config
uint16_t VL53L1_calc_range_ignore_threshold(uint32_t central_rate, int16_t x_gradient, int16_t y_gradient, uint8_t rate_mult)
Calculates the Xtalk Range Ignore Threshold rate per spad in 3.13Mcps.
int16_t nvm_default__crosstalk_compensation_y_plane_gradient_kcps
#define VL53L1_TUNINGPARM_REFSPADCHAR_TARGET_COUNT_RATE_MCPS_DEFAULT
#define VL53L1_TUNINGPARM_LITE_SHORT_SIGMA_THRESH_MM_DEFAULT
VL53L1_Error VL53L1_preset_mode_low_power_auto_short_ranging(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms, VL53L1_low_power_auto_data_t *plpadata)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_LOWPOWE...
uint8_t sd_config__reset_stages_lsb
uint8_t tp_init_phase_rtn_lite_long
uint8_t gpio__tio_hv_status
VL53L1_Error VL53L1_preset_mode_timed_ranging_short_range(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_TIMED_R...
#define VL53L1_INTERRUPT_CONFIG_NEW_SAMPLE_READY
uint8_t mm2_num_of_samples
uint16_t dss_config__target_total_rate_mcps
uint8_t system__fractional_enable
#define VL53L1_TUNINGPARM_LITE_MED_SIGMA_THRESH_MM_DEFAULT
uint8_t global_crosstalk_compensation_enable
#define VL53L1_TUNINGPARM_LITE_SIGMA_EST_PULSE_WIDTH_DEFAULT
uint8_t range_config__valid_phase_low
uint8_t sd_config__woi_sd0
#define VL53L1_TUNINGPARM_LITE_SIGMA_EST_AMB_WIDTH_NS_DEFAULT
VL53L1_Error VL53L1_init_ssc_config_struct(VL53L1_ssc_config_t *pdata)
Initializes SPAD Self Check (SSC) Configuration Parameters.
Run Offset Cal Function (offsetcal) Config.
#define VL53L1_TUNINGPARM_INITIAL_PHASE_RTN_LITE_SHORT_RANGE_DEFAULT
VL53L1_Error VL53L1_init_tuning_parm_storage_struct(VL53L1_tuning_parm_storage_t *pdata)
Initializes Tuning Parameter Storage Values.
#define VL53L1_TUNINGPARM_OFFSET_CAL_PRE_SAMPLES_DEFAULT
#define VL53L1_DEVICESSCARRAY_RTN
uint8_t phasecal_config__timeout_macrop
VL53L1_Error VL53L1_preset_mode_low_power_auto_ranging(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms, VL53L1_low_power_auto_data_t *plpadata)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_LOWPOWE...
uint8_t sd_config__reset_stages_msb
#define VL53L1_TUNINGPARM_REFSPADCHAR_MAX_COUNTRATE_LIMIT_MCPS_DEFAULT
uint8_t ana_config__fast_osc__config_ctrl
#define VL53L1_TUNINGPARM_LOWPOWERAUTO_MM_CONFIG_TIMEOUT_US_DEFAULT
VL53L1_Error VL53L1_preset_mode_timed_ranging_long_range(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_TIMED_R...
uint8_t range_config__vcsel_period_b
uint8_t tp_consistency_lite_phase_tolerance
VL53L1_Error VL53L1_init_xtalk_config_struct(VL53L1_customer_nvm_managed_t *pnvm, VL53L1_xtalk_config_t *pdata)
Initializes Xtalk Configuration Parameters.
uint8_t algo__crosstalk_compensation_valid_height_mm
uint8_t gpio_hv_mux__ctrl
uint16_t tp_lite_med_min_count_rate_rtn_mcps
uint16_t max_count_rate_limit_mcps
VL53L1_Error VL53L1_preset_mode_timed_ranging(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_TIMED_R...
uint32_t tp_range_timeout_timed_us
uint32_t tp_phasecal_timeout_timed_us
#define VL53L1_TUNINGPARM_REFSPADCHAR_VCSEL_PERIOD_DEFAULT
uint8_t tp_lite_quantifier
#define VL53L1_TUNINGPARM_INITIAL_PHASE_REF_LITE_MED_RANGE_DEFAULT
VL53L1_Error VL53L1_preset_mode_standard_ranging_mm1_cal(VL53L1_static_config_t *pstatic, VL53L1_general_config_t *pgeneral, VL53L1_timing_config_t *ptiming, VL53L1_dynamic_config_t *pdynamic, VL53L1_system_control_t *psystem, VL53L1_tuning_parm_storage_t *ptuning_parms)
Initializes static and dynamic configuration settings for preset mode VL53L1_DEVICEPRESETMODE_STANDAR...
uint8_t range_config__valid_phase_high
#define VL53L1_TUNINGPARM_LITE_SIGMA_REF_MM_DEFAULT
uint16_t min_count_rate_limit_mcps
uint8_t tp_init_phase_rtn_lite_med
int16_t algo__crosstalk_compensation_y_plane_gradient_kcps
uint32_t tp_range_timeout_lpa_us
uint8_t algo__consistency_check__tolerance
uint8_t mm_config__timeout_macrop_a_hi
vl53l1x
Author(s):
autogenerated on Fri Aug 2 2024 08:35:54