ST Expansion SW Team / VL53L1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   X_NUCLEO_53L1CB

inc/vl53l1_core_support.h@13:3f1b341901dd, 2021-06-11 (annotated)

Committer:
Charles MacNeill
Date:
Fri Jun 11 17:08:27 2021 +0100
Revision:
13:3f1b341901dd
Parent:
7:1add29d51e72 
changing case of vl53l1cb.* so it works in linux

Who changed what in which revision?

UserRevisionLine numberNew contents of line
charlesmn 0:3ac96e360672 1
Charles MacNeill 7:1add29d51e72 2 /* SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause */
Charles MacNeill 7:1add29d51e72 3 /******************************************************************************
charlesmn 0:3ac96e360672 4 * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
charlesmn 0:3ac96e360672 5
Charles MacNeill 7:1add29d51e72 6 This file is part of VL53L1 and is dual licensed,
Charles MacNeill 7:1add29d51e72 7 either GPL-2.0+
charlesmn 0:3ac96e360672 8 or 'BSD 3-clause "New" or "Revised" License' , at your option.
Charles MacNeill 7:1add29d51e72 9 ******************************************************************************
Charles MacNeill 7:1add29d51e72 10 */
charlesmn 0:3ac96e360672 11
charlesmn 0:3ac96e360672 12
charlesmn 0:3ac96e360672 13
charlesmn 0:3ac96e360672 14
charlesmn 0:3ac96e360672 15 #ifndef _VL53L1_CORE_SUPPORT_H_
charlesmn 0:3ac96e360672 16 #define _VL53L1_CORE_SUPPORT_H_
charlesmn 0:3ac96e360672 17
charlesmn 0:3ac96e360672 18 #include "vl53l1_types.h"
charlesmn 0:3ac96e360672 19 #include "vl53l1_hist_structs.h"
charlesmn 0:3ac96e360672 20
charlesmn 0:3ac96e360672 21 #ifdef __cplusplus
charlesmn 0:3ac96e360672 22 extern "C" {
charlesmn 0:3ac96e360672 23 #endif
charlesmn 0:3ac96e360672 24
charlesmn 0:3ac96e360672 25
charlesmn 0:3ac96e360672 26
charlesmn 0:3ac96e360672 27
charlesmn 0:3ac96e360672 28 uint32_t VL53L1_calc_pll_period_us(
charlesmn 0:3ac96e360672 29 uint16_t fast_osc_frequency);
charlesmn 0:3ac96e360672 30
charlesmn 0:3ac96e360672 31
charlesmn 0:3ac96e360672 32
charlesmn 0:3ac96e360672 33
charlesmn 0:3ac96e360672 34
charlesmn 0:3ac96e360672 35 uint32_t VL53L1_duration_maths(
charlesmn 0:3ac96e360672 36 uint32_t pll_period_us,
charlesmn 0:3ac96e360672 37 uint32_t vcsel_parm_pclks,
charlesmn 0:3ac96e360672 38 uint32_t window_vclks,
charlesmn 0:3ac96e360672 39 uint32_t periods_elapsed_mclks);
charlesmn 0:3ac96e360672 40
charlesmn 0:3ac96e360672 41
charlesmn 0:3ac96e360672 42
charlesmn 0:3ac96e360672 43 uint32_t VL53L1_events_per_spad_maths(
charlesmn 0:3ac96e360672 44 int32_t VL53L1_p_013,
charlesmn 0:3ac96e360672 45 uint16_t num_spads,
charlesmn 0:3ac96e360672 46 uint32_t duration);
charlesmn 0:3ac96e360672 47
charlesmn 0:3ac96e360672 48
charlesmn 0:3ac96e360672 49
charlesmn 0:3ac96e360672 50
charlesmn 0:3ac96e360672 51 uint32_t VL53L1_isqrt(
charlesmn 0:3ac96e360672 52 uint32_t num);
charlesmn 0:3ac96e360672 53
charlesmn 0:3ac96e360672 54
charlesmn 0:3ac96e360672 55
charlesmn 0:3ac96e360672 56
charlesmn 0:3ac96e360672 57 void VL53L1_hist_calc_zero_distance_phase(
charlesmn 0:3ac96e360672 58 VL53L1_histogram_bin_data_t *pdata);
charlesmn 0:3ac96e360672 59
charlesmn 0:3ac96e360672 60
charlesmn 0:3ac96e360672 61
charlesmn 0:3ac96e360672 62
charlesmn 0:3ac96e360672 63 void VL53L1_hist_estimate_ambient_from_thresholded_bins(
charlesmn 0:3ac96e360672 64 int32_t ambient_threshold_sigma,
charlesmn 0:3ac96e360672 65 VL53L1_histogram_bin_data_t *pdata);
charlesmn 0:3ac96e360672 66
charlesmn 0:3ac96e360672 67
charlesmn 0:3ac96e360672 68
charlesmn 0:3ac96e360672 69
charlesmn 0:3ac96e360672 70 void VL53L1_hist_remove_ambient_bins(
charlesmn 0:3ac96e360672 71 VL53L1_histogram_bin_data_t *pdata);
charlesmn 0:3ac96e360672 72
charlesmn 0:3ac96e360672 73
charlesmn 0:3ac96e360672 74
charlesmn 0:3ac96e360672 75
charlesmn 0:3ac96e360672 76 uint32_t VL53L1_calc_pll_period_mm(
charlesmn 0:3ac96e360672 77 uint16_t fast_osc_frequency);
charlesmn 0:3ac96e360672 78
charlesmn 0:3ac96e360672 79
charlesmn 0:3ac96e360672 80
charlesmn 0:3ac96e360672 81
charlesmn 0:3ac96e360672 82 uint16_t VL53L1_rate_maths(
charlesmn 0:3ac96e360672 83 int32_t VL53L1_p_008,
charlesmn 0:3ac96e360672 84 uint32_t time_us);
charlesmn 0:3ac96e360672 85
charlesmn 0:3ac96e360672 86
charlesmn 0:3ac96e360672 87
charlesmn 0:3ac96e360672 88
charlesmn 0:3ac96e360672 89 uint16_t VL53L1_rate_per_spad_maths(
charlesmn 0:3ac96e360672 90 uint32_t frac_bits,
charlesmn 0:3ac96e360672 91 uint32_t peak_count_rate,
charlesmn 0:3ac96e360672 92 uint16_t num_spads,
charlesmn 0:3ac96e360672 93 uint32_t max_output_value);
charlesmn 0:3ac96e360672 94
charlesmn 0:3ac96e360672 95
charlesmn 0:3ac96e360672 96
charlesmn 0:3ac96e360672 97
charlesmn 0:3ac96e360672 98 int32_t VL53L1_range_maths(
charlesmn 0:3ac96e360672 99 uint16_t fast_osc_frequency,
charlesmn 0:3ac96e360672 100 uint16_t VL53L1_p_017,
charlesmn 0:3ac96e360672 101 uint16_t zero_distance_phase,
charlesmn 0:3ac96e360672 102 uint8_t fractional_bits,
charlesmn 0:3ac96e360672 103 int32_t gain_factor,
charlesmn 0:3ac96e360672 104 int32_t range_offset_mm);
charlesmn 0:3ac96e360672 105
charlesmn 0:3ac96e360672 106
charlesmn 0:3ac96e360672 107
charlesmn 0:3ac96e360672 108
charlesmn 0:3ac96e360672 109 uint8_t VL53L1_decode_vcsel_period(
charlesmn 0:3ac96e360672 110 uint8_t vcsel_period_reg);
charlesmn 0:3ac96e360672 111
charlesmn 0:3ac96e360672 112
charlesmn 0:3ac96e360672 113
charlesmn 0:3ac96e360672 114 void VL53L1_copy_xtalk_bin_data_to_histogram_data_struct(
charlesmn 0:3ac96e360672 115 VL53L1_xtalk_histogram_shape_t *pxtalk,
charlesmn 0:3ac96e360672 116 VL53L1_histogram_bin_data_t *phist);
charlesmn 0:3ac96e360672 117
charlesmn 0:3ac96e360672 118
charlesmn 0:3ac96e360672 119
charlesmn 0:3ac96e360672 120
charlesmn 0:3ac96e360672 121 void VL53L1_init_histogram_bin_data_struct(
charlesmn 0:3ac96e360672 122 int32_t bin_value,
charlesmn 0:3ac96e360672 123 uint16_t VL53L1_p_024,
charlesmn 0:3ac96e360672 124 VL53L1_histogram_bin_data_t *pdata);
charlesmn 0:3ac96e360672 125
charlesmn 0:3ac96e360672 126
charlesmn 0:3ac96e360672 127
charlesmn 0:3ac96e360672 128
charlesmn 0:3ac96e360672 129 void VL53L1_decode_row_col(
charlesmn 0:3ac96e360672 130 uint8_t spad_number,
charlesmn 0:3ac96e360672 131 uint8_t *prow,
charlesmn 0:3ac96e360672 132 uint8_t *pcol);
charlesmn 0:3ac96e360672 133
charlesmn 0:3ac96e360672 134
charlesmn 0:3ac96e360672 135
charlesmn 0:3ac96e360672 136
charlesmn 0:3ac96e360672 137 void VL53L1_hist_find_min_max_bin_values(
charlesmn 0:3ac96e360672 138 VL53L1_histogram_bin_data_t *pdata);
charlesmn 0:3ac96e360672 139
charlesmn 0:3ac96e360672 140
charlesmn 0:3ac96e360672 141
charlesmn 0:3ac96e360672 142
charlesmn 0:3ac96e360672 143 void VL53L1_hist_estimate_ambient_from_ambient_bins(
charlesmn 0:3ac96e360672 144 VL53L1_histogram_bin_data_t *pdata);
charlesmn 0:3ac96e360672 145
charlesmn 0:3ac96e360672 146
charlesmn 0:3ac96e360672 147 #ifdef __cplusplus
charlesmn 0:3ac96e360672 148 }
charlesmn 0:3ac96e360672 149 #endif
charlesmn 0:3ac96e360672 150
charlesmn 0:3ac96e360672 151 #endif
charlesmn 0:3ac96e360672 152