ST Expansion SW Team / VL53L1

Fork, renaming of VL53L1CB-2

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   X_NUCLEO_53L1CB

inc/vl53l1_api_calibration.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_API_CALIBRATION_H_
charlesmn 0:3ac96e360672 16 #define _VL53L1_API_CALIBRATION_H_
charlesmn 0:3ac96e360672 17
charlesmn 0:3ac96e360672 18 #include "vl53l1_platform.h"
charlesmn 0:3ac96e360672 19
charlesmn 0:3ac96e360672 20 #ifdef __cplusplus
charlesmn 0:3ac96e360672 21 extern "C" {
charlesmn 0:3ac96e360672 22 #endif
charlesmn 0:3ac96e360672 23
charlesmn 0:3ac96e360672 24
charlesmn 0:3ac96e360672 25
charlesmn 0:3ac96e360672 26
charlesmn 0:3ac96e360672 27 VL53L1_Error VL53L1_run_ref_spad_char(VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 28 VL53L1_Error * pcal_status);
charlesmn 0:3ac96e360672 29
charlesmn 0:3ac96e360672 30
charlesmn 0:3ac96e360672 31
charlesmn 0:3ac96e360672 32
charlesmn 0:3ac96e360672 33 VL53L1_Error VL53L1_run_device_test(
charlesmn 0:3ac96e360672 34 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 35 VL53L1_DeviceTestMode device_test_mode);
charlesmn 0:3ac96e360672 36
charlesmn 0:3ac96e360672 37
charlesmn 0:3ac96e360672 38
charlesmn 0:3ac96e360672 39
charlesmn 0:3ac96e360672 40 VL53L1_Error VL53L1_run_spad_rate_map(
charlesmn 0:3ac96e360672 41 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 42 VL53L1_DeviceTestMode device_test_mode,
charlesmn 0:3ac96e360672 43 VL53L1_DeviceSscArray array_select,
charlesmn 0:3ac96e360672 44 uint32_t ssc_config_timeout_us,
charlesmn 0:3ac96e360672 45 VL53L1_spad_rate_data_t *pspad_rate_data);
charlesmn 0:3ac96e360672 46
charlesmn 0:3ac96e360672 47
charlesmn 0:3ac96e360672 48
charlesmn 0:3ac96e360672 49
charlesmn 0:3ac96e360672 50 VL53L1_Error VL53L1_run_xtalk_extraction(
charlesmn 0:3ac96e360672 51 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 52 VL53L1_Error *pcal_status);
charlesmn 0:3ac96e360672 53
charlesmn 0:3ac96e360672 54
charlesmn 0:3ac96e360672 55
charlesmn 0:3ac96e360672 56 VL53L1_Error VL53L1_get_and_avg_xtalk_samples(
charlesmn 0:3ac96e360672 57 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 58 uint8_t num_of_samples,
charlesmn 0:3ac96e360672 59 uint8_t measurement_mode,
charlesmn 0:3ac96e360672 60 int16_t xtalk_filter_thresh_max_mm,
charlesmn 0:3ac96e360672 61 int16_t xtalk_filter_thresh_min_mm,
charlesmn 0:3ac96e360672 62 uint16_t xtalk_max_valid_rate_kcps,
charlesmn 0:3ac96e360672 63 uint8_t xtalk_result_id,
charlesmn 0:3ac96e360672 64 uint8_t xtalk_histo_id,
charlesmn 0:3ac96e360672 65 VL53L1_xtalk_range_results_t *pxtalk_results,
charlesmn 0:3ac96e360672 66 VL53L1_histogram_bin_data_t *psum_histo,
charlesmn 0:3ac96e360672 67 VL53L1_histogram_bin_data_t *pavg_histo);
charlesmn 0:3ac96e360672 68
charlesmn 0:3ac96e360672 69
charlesmn 0:3ac96e360672 70
charlesmn 0:3ac96e360672 71 VL53L1_Error VL53L1_run_offset_calibration(
charlesmn 0:3ac96e360672 72 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 73 int16_t cal_distance_mm,
charlesmn 0:3ac96e360672 74 uint16_t cal_reflectance_pc,
charlesmn 0:3ac96e360672 75 VL53L1_Error *pcal_status);
charlesmn 0:3ac96e360672 76
charlesmn 0:3ac96e360672 77
charlesmn 0:3ac96e360672 78
charlesmn 0:3ac96e360672 79
charlesmn 0:3ac96e360672 80 VL53L1_Error VL53L1_run_phasecal_average(
charlesmn 0:3ac96e360672 81 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 82 uint8_t measurement_mode,
charlesmn 0:3ac96e360672 83 uint8_t phasecal_result__vcsel_start,
charlesmn 0:3ac96e360672 84 uint16_t phasecal_num_of_samples,
charlesmn 0:3ac96e360672 85 VL53L1_range_results_t *prange_results,
charlesmn 0:3ac96e360672 86 uint16_t *pphasecal_result__reference_phase,
charlesmn 0:3ac96e360672 87 uint16_t *pzero_distance_phase);
charlesmn 0:3ac96e360672 88
charlesmn 0:3ac96e360672 89
charlesmn 0:3ac96e360672 90
charlesmn 0:3ac96e360672 91
charlesmn 0:3ac96e360672 92 VL53L1_Error VL53L1_run_zone_calibration(
charlesmn 0:3ac96e360672 93 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 94 VL53L1_DevicePresetModes device_preset_mode,
charlesmn 0:3ac96e360672 95 VL53L1_DeviceZonePreset zone_preset,
charlesmn 0:3ac96e360672 96 VL53L1_zone_config_t *pzone_cfg,
charlesmn 0:3ac96e360672 97 int16_t cal_distance_mm,
charlesmn 0:3ac96e360672 98 uint16_t cal_reflectance_pc,
charlesmn 0:3ac96e360672 99 VL53L1_Error *pcal_status);
charlesmn 0:3ac96e360672 100
charlesmn 0:3ac96e360672 101
charlesmn 0:3ac96e360672 102
charlesmn 0:3ac96e360672 103
charlesmn 0:3ac96e360672 104 void VL53L1_hist_xtalk_extract_data_init(
charlesmn 0:3ac96e360672 105 VL53L1_hist_xtalk_extract_data_t *pxtalk_data);
charlesmn 0:3ac96e360672 106
charlesmn 0:3ac96e360672 107
charlesmn 0:3ac96e360672 108
charlesmn 0:3ac96e360672 109 VL53L1_Error VL53L1_hist_xtalk_extract_update(
charlesmn 0:3ac96e360672 110 int16_t target_distance_mm,
charlesmn 0:3ac96e360672 111 uint16_t target_width_oversize,
charlesmn 0:3ac96e360672 112 VL53L1_histogram_bin_data_t *phist_bins,
charlesmn 0:3ac96e360672 113 VL53L1_hist_xtalk_extract_data_t *pxtalk_data);
charlesmn 0:3ac96e360672 114
charlesmn 0:3ac96e360672 115
charlesmn 0:3ac96e360672 116
charlesmn 0:3ac96e360672 117 VL53L1_Error VL53L1_hist_xtalk_extract_fini(
charlesmn 0:3ac96e360672 118 VL53L1_histogram_bin_data_t *phist_bins,
charlesmn 0:3ac96e360672 119 VL53L1_hist_xtalk_extract_data_t *pxtalk_data,
charlesmn 0:3ac96e360672 120 VL53L1_xtalk_calibration_results_t *pxtalk_cal,
charlesmn 0:3ac96e360672 121 VL53L1_xtalk_histogram_shape_t *pxtalk_shape);
charlesmn 0:3ac96e360672 122
charlesmn 0:3ac96e360672 123
charlesmn 0:3ac96e360672 124
charlesmn 0:3ac96e360672 125
charlesmn 0:3ac96e360672 126 VL53L1_Error VL53L1_run_hist_xtalk_extraction(
charlesmn 0:3ac96e360672 127 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 128 int16_t cal_distance_mm,
charlesmn 0:3ac96e360672 129 VL53L1_Error *pcal_status);
charlesmn 0:3ac96e360672 130
charlesmn 0:3ac96e360672 131
charlesmn 0:3ac96e360672 132 #ifdef __cplusplus
charlesmn 0:3ac96e360672 133 }
charlesmn 0:3ac96e360672 134 #endif
charlesmn 0:3ac96e360672 135
charlesmn 0:3ac96e360672 136 #endif
charlesmn 0:3ac96e360672 137