vl53l1_dmax_structs.h

00001 
00002 /*******************************************************************************
00003  * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
00004 
00005  This file is part of VL53L1 Core and is dual licensed,
00006  either 'STMicroelectronics
00007  Proprietary license'
00008  or 'BSD 3-clause "New" or "Revised" License' , at your option.
00009 
00010 ********************************************************************************
00011 
00012  'STMicroelectronics Proprietary license'
00013 
00014 ********************************************************************************
00015 
00016  License terms: STMicroelectronics Proprietary in accordance with licensing
00017  terms at www.st.com/sla0081
00018 
00019  STMicroelectronics confidential
00020  Reproduction and Communication of this document is strictly prohibited unless
00021  specifically authorized in writing by STMicroelectronics.
00022 
00023 
00024 ********************************************************************************
00025 
00026  Alternatively, VL53L1 Core may be distributed under the terms of
00027  'BSD 3-clause "New" or "Revised" License', in which case the following
00028  provisions apply instead of the ones
00029  mentioned above :
00030 
00031 ********************************************************************************
00032 
00033  License terms: BSD 3-clause "New" or "Revised" License.
00034 
00035  Redistribution and use in source and binary forms, with or without
00036  modification, are permitted provided that the following conditions are met:
00037 
00038  1. Redistributions of source code must retain the above copyright notice, this
00039  list of conditions and the following disclaimer.
00040 
00041  2. Redistributions in binary form must reproduce the above copyright notice,
00042  this list of conditions and the following disclaimer in the documentation
00043  and/or other materials provided with the distribution.
00044 
00045  3. Neither the name of the copyright holder nor the names of its contributors
00046  may be used to endorse or promote products derived from this software
00047  without specific prior written permission.
00048 
00049  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00050  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00051  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00052  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00053  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00054  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00055  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00056  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00057  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00058  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00059 
00060 
00061 ********************************************************************************
00062 
00063 */
00064 
00065 
00066 
00067 
00068 
00069 
00070 
00071 #ifndef _VL53L1_DMAX_STRUCTS_H_
00072 #define _VL53L1_DMAX_STRUCTS_H_
00073 
00074 #include "vl53l1_types.h"
00075 
00076 #ifdef __cplusplus
00077 extern "C"
00078 {
00079 #endif
00080 
00081 
00082 #define VL53L1_MAX_AMBIENT_DMAX_VALUES        5
00083 
00084 
00085 
00086 
00087 
00088 typedef struct {
00089 
00090 
00091 
00092     uint16_t  ref__actual_effective_spads;
00093 
00094     uint16_t  ref__peak_signal_count_rate_mcps;
00095 
00096     uint16_t  ref__distance_mm;
00097 
00098     uint16_t   ref_reflectance_pc;
00099 
00100 
00101 
00102 
00103     uint16_t   coverglass_transmission;
00104 
00105 
00106 } VL53L1_dmax_calibration_data_t;
00107 
00108 
00109 
00110 
00111 typedef struct {
00112 
00113 
00114 
00115     uint8_t   signal_thresh_sigma;
00116 
00117     uint8_t   ambient_thresh_sigma;
00118 
00119     int32_t   min_ambient_thresh_events;
00120 
00121     int32_t   signal_total_events_limit;
00122 
00123 
00124     uint16_t  target_reflectance_for_dmax_calc[
00125             VL53L1_MAX_AMBIENT_DMAX_VALUES];
00126 
00127     uint16_t  max_effective_spads;
00128 
00129 
00130 
00131 
00132     uint16_t  dss_config__target_total_rate_mcps;
00133 
00134     uint8_t   dss_config__aperture_attenuation;
00135 
00136 
00137 } VL53L1_hist_gen3_dmax_config_t;
00138 
00139 
00140 #ifdef __cplusplus
00141 }
00142 #endif
00143 
00144 #endif
00145 
00146