ST Expansion SW Team / VL53L1CB

The VL53L1CB proximity sensor, based on ST’s FlightSense™, Time-of-Flight technology.

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   VL53L1CB_noshield_1sensor_polls_auton VL53L1CB_noshield_1sensor_interrupt_auton X_NUCLEO_53L1A2

Based on VL53L1 library, this is a library for the VL53L1CB ToF chip.

src/vl53l1_hist_char.c@0:3ac96e360672, 2020-11-06 (annotated)

Committer:
charlesmn
Date:
Fri Nov 06 10:06:37 2020 +0000
Revision:
0:3ac96e360672
Child:
7:1add29d51e72
Library for ST Vl53L1A1 time of flight sensor.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
charlesmn 0:3ac96e360672 1
charlesmn 0:3ac96e360672 2 /*******************************************************************************
charlesmn 0:3ac96e360672 3 * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
charlesmn 0:3ac96e360672 4
charlesmn 0:3ac96e360672 5 This file is part of VL53L1 Core and is dual licensed,
charlesmn 0:3ac96e360672 6 either 'STMicroelectronics
charlesmn 0:3ac96e360672 7 Proprietary license'
charlesmn 0:3ac96e360672 8 or 'BSD 3-clause "New" or "Revised" License' , at your option.
charlesmn 0:3ac96e360672 9
charlesmn 0:3ac96e360672 10 ********************************************************************************
charlesmn 0:3ac96e360672 11
charlesmn 0:3ac96e360672 12 'STMicroelectronics Proprietary license'
charlesmn 0:3ac96e360672 13
charlesmn 0:3ac96e360672 14 ********************************************************************************
charlesmn 0:3ac96e360672 15
charlesmn 0:3ac96e360672 16 License terms: STMicroelectronics Proprietary in accordance with licensing
charlesmn 0:3ac96e360672 17 terms at www.st.com/sla0081
charlesmn 0:3ac96e360672 18
charlesmn 0:3ac96e360672 19 STMicroelectronics confidential
charlesmn 0:3ac96e360672 20 Reproduction and Communication of this document is strictly prohibited unless
charlesmn 0:3ac96e360672 21 specifically authorized in writing by STMicroelectronics.
charlesmn 0:3ac96e360672 22
charlesmn 0:3ac96e360672 23
charlesmn 0:3ac96e360672 24 ********************************************************************************
charlesmn 0:3ac96e360672 25
charlesmn 0:3ac96e360672 26 Alternatively, VL53L1 Core may be distributed under the terms of
charlesmn 0:3ac96e360672 27 'BSD 3-clause "New" or "Revised" License', in which case the following
charlesmn 0:3ac96e360672 28 provisions apply instead of the ones
charlesmn 0:3ac96e360672 29 mentioned above :
charlesmn 0:3ac96e360672 30
charlesmn 0:3ac96e360672 31 ********************************************************************************
charlesmn 0:3ac96e360672 32
charlesmn 0:3ac96e360672 33 License terms: BSD 3-clause "New" or "Revised" License.
charlesmn 0:3ac96e360672 34
charlesmn 0:3ac96e360672 35 Redistribution and use in source and binary forms, with or without
charlesmn 0:3ac96e360672 36 modification, are permitted provided that the following conditions are met:
charlesmn 0:3ac96e360672 37
charlesmn 0:3ac96e360672 38 1. Redistributions of source code must retain the above copyright notice, this
charlesmn 0:3ac96e360672 39 list of conditions and the following disclaimer.
charlesmn 0:3ac96e360672 40
charlesmn 0:3ac96e360672 41 2. Redistributions in binary form must reproduce the above copyright notice,
charlesmn 0:3ac96e360672 42 this list of conditions and the following disclaimer in the documentation
charlesmn 0:3ac96e360672 43 and/or other materials provided with the distribution.
charlesmn 0:3ac96e360672 44
charlesmn 0:3ac96e360672 45 3. Neither the name of the copyright holder nor the names of its contributors
charlesmn 0:3ac96e360672 46 may be used to endorse or promote products derived from this software
charlesmn 0:3ac96e360672 47 without specific prior written permission.
charlesmn 0:3ac96e360672 48
charlesmn 0:3ac96e360672 49 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
charlesmn 0:3ac96e360672 50 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
charlesmn 0:3ac96e360672 51 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
charlesmn 0:3ac96e360672 52 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
charlesmn 0:3ac96e360672 53 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
charlesmn 0:3ac96e360672 54 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
charlesmn 0:3ac96e360672 55 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
charlesmn 0:3ac96e360672 56 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
charlesmn 0:3ac96e360672 57 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
charlesmn 0:3ac96e360672 58 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
charlesmn 0:3ac96e360672 59
charlesmn 0:3ac96e360672 60
charlesmn 0:3ac96e360672 61 ********************************************************************************
charlesmn 0:3ac96e360672 62
charlesmn 0:3ac96e360672 63 */
charlesmn 0:3ac96e360672 64
charlesmn 0:3ac96e360672 65
charlesmn 0:3ac96e360672 66
charlesmn 0:3ac96e360672 67
charlesmn 0:3ac96e360672 68
charlesmn 0:3ac96e360672 69 #include <stdio.h>
charlesmn 0:3ac96e360672 70 #include <stdlib.h>
charlesmn 0:3ac96e360672 71
charlesmn 0:3ac96e360672 72
charlesmn 0:3ac96e360672 73
charlesmn 0:3ac96e360672 74 #include "vl53l1_core.h"
charlesmn 0:3ac96e360672 75 #include "vl53l1_register_settings.h"
charlesmn 0:3ac96e360672 76 #include "vl53l1_hist_char.h"
charlesmn 0:3ac96e360672 77
charlesmn 0:3ac96e360672 78 #define LOG_FUNCTION_START(fmt, ...) \
charlesmn 0:3ac96e360672 79 _LOG_FUNCTION_START(VL53L1_TRACE_MODULE_HISTOGRAM, fmt, ##__VA_ARGS__)
charlesmn 0:3ac96e360672 80 #define LOG_FUNCTION_END(status, ...) \
charlesmn 0:3ac96e360672 81 _LOG_FUNCTION_END(VL53L1_TRACE_MODULE_HISTOGRAM, status, ##__VA_ARGS__)
charlesmn 0:3ac96e360672 82 #define LOG_FUNCTION_END_FMT(status, fmt, ...) \
charlesmn 0:3ac96e360672 83 _LOG_FUNCTION_END_FMT(VL53L1_TRACE_MODULE_HISTOGRAM,\
charlesmn 0:3ac96e360672 84 status, fmt, ##__VA_ARGS__)
charlesmn 0:3ac96e360672 85
charlesmn 0:3ac96e360672 86
charlesmn 0:3ac96e360672 87 VL53L1_Error VL53L1_set_calib_config(
charlesmn 0:3ac96e360672 88 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 89 uint8_t vcsel_delay__a0,
charlesmn 0:3ac96e360672 90 uint8_t calib_1,
charlesmn 0:3ac96e360672 91 uint8_t calib_2,
charlesmn 0:3ac96e360672 92 uint8_t calib_3,
charlesmn 0:3ac96e360672 93 uint8_t calib_2__a0,
charlesmn 0:3ac96e360672 94 uint8_t spad_readout)
charlesmn 0:3ac96e360672 95 {
charlesmn 0:3ac96e360672 96
charlesmn 0:3ac96e360672 97
charlesmn 0:3ac96e360672 98 VL53L1_Error status = VL53L1_ERROR_NONE;
charlesmn 0:3ac96e360672 99 uint8_t comms_buffer[3];
charlesmn 0:3ac96e360672 100
charlesmn 0:3ac96e360672 101 LOG_FUNCTION_START("");
charlesmn 0:3ac96e360672 102
charlesmn 0:3ac96e360672 103
charlesmn 0:3ac96e360672 104
charlesmn 0:3ac96e360672 105 status = VL53L1_enable_powerforce(Dev);
charlesmn 0:3ac96e360672 106
charlesmn 0:3ac96e360672 107
charlesmn 0:3ac96e360672 108 if (status == VL53L1_ERROR_NONE)
charlesmn 0:3ac96e360672 109 status = VL53L1_disable_firmware(Dev);
charlesmn 0:3ac96e360672 110
charlesmn 0:3ac96e360672 111
charlesmn 0:3ac96e360672 112
charlesmn 0:3ac96e360672 113
charlesmn 0:3ac96e360672 114 if (status == VL53L1_ERROR_NONE) {
charlesmn 0:3ac96e360672 115 status = VL53L1_WrByte(
charlesmn 0:3ac96e360672 116 Dev,
charlesmn 0:3ac96e360672 117 VL53L1_RANGING_CORE__VCSEL_DELAY__A0,
charlesmn 0:3ac96e360672 118 vcsel_delay__a0);
charlesmn 0:3ac96e360672 119 }
charlesmn 0:3ac96e360672 120
charlesmn 0:3ac96e360672 121
charlesmn 0:3ac96e360672 122
charlesmn 0:3ac96e360672 123 if (status == VL53L1_ERROR_NONE) {
charlesmn 0:3ac96e360672 124
charlesmn 0:3ac96e360672 125
charlesmn 0:3ac96e360672 126 comms_buffer[0] = calib_1;
charlesmn 0:3ac96e360672 127 comms_buffer[1] = calib_2;
charlesmn 0:3ac96e360672 128 comms_buffer[2] = calib_3;
charlesmn 0:3ac96e360672 129
charlesmn 0:3ac96e360672 130 status = VL53L1_WriteMulti(
charlesmn 0:3ac96e360672 131 Dev,
charlesmn 0:3ac96e360672 132 VL53L1_RANGING_CORE__CALIB_1,
charlesmn 0:3ac96e360672 133 comms_buffer,
charlesmn 0:3ac96e360672 134 3);
charlesmn 0:3ac96e360672 135 }
charlesmn 0:3ac96e360672 136
charlesmn 0:3ac96e360672 137
charlesmn 0:3ac96e360672 138
charlesmn 0:3ac96e360672 139 if (status == VL53L1_ERROR_NONE)
charlesmn 0:3ac96e360672 140 status = VL53L1_WrByte(
charlesmn 0:3ac96e360672 141 Dev,
charlesmn 0:3ac96e360672 142 VL53L1_RANGING_CORE__CALIB_2__A0,
charlesmn 0:3ac96e360672 143 calib_2__a0);
charlesmn 0:3ac96e360672 144
charlesmn 0:3ac96e360672 145
charlesmn 0:3ac96e360672 146
charlesmn 0:3ac96e360672 147 if (status == VL53L1_ERROR_NONE)
charlesmn 0:3ac96e360672 148 status = VL53L1_WrByte(
charlesmn 0:3ac96e360672 149 Dev,
charlesmn 0:3ac96e360672 150 VL53L1_RANGING_CORE__SPAD_READOUT,
charlesmn 0:3ac96e360672 151 spad_readout);
charlesmn 0:3ac96e360672 152
charlesmn 0:3ac96e360672 153
charlesmn 0:3ac96e360672 154
charlesmn 0:3ac96e360672 155 if (status == VL53L1_ERROR_NONE)
charlesmn 0:3ac96e360672 156 status = VL53L1_enable_firmware(Dev);
charlesmn 0:3ac96e360672 157
charlesmn 0:3ac96e360672 158 LOG_FUNCTION_END(status);
charlesmn 0:3ac96e360672 159
charlesmn 0:3ac96e360672 160 return status;
charlesmn 0:3ac96e360672 161 }
charlesmn 0:3ac96e360672 162
charlesmn 0:3ac96e360672 163
charlesmn 0:3ac96e360672 164
charlesmn 0:3ac96e360672 165 VL53L1_Error VL53L1_set_hist_calib_pulse_delay(
charlesmn 0:3ac96e360672 166 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 167 uint8_t calib_delay)
charlesmn 0:3ac96e360672 168 {
charlesmn 0:3ac96e360672 169
charlesmn 0:3ac96e360672 170
charlesmn 0:3ac96e360672 171 VL53L1_Error status = VL53L1_ERROR_NONE;
charlesmn 0:3ac96e360672 172
charlesmn 0:3ac96e360672 173 LOG_FUNCTION_START("");
charlesmn 0:3ac96e360672 174
charlesmn 0:3ac96e360672 175 status =
charlesmn 0:3ac96e360672 176 VL53L1_set_calib_config(
charlesmn 0:3ac96e360672 177 Dev,
charlesmn 0:3ac96e360672 178 0x01,
charlesmn 0:3ac96e360672 179 calib_delay,
charlesmn 0:3ac96e360672 180 0x04,
charlesmn 0:3ac96e360672 181 0x08,
charlesmn 0:3ac96e360672 182 0x14,
charlesmn 0:3ac96e360672 183 VL53L1_RANGING_CORE__SPAD_READOUT__CALIB_PULSES);
charlesmn 0:3ac96e360672 184
charlesmn 0:3ac96e360672 185 LOG_FUNCTION_END(status);
charlesmn 0:3ac96e360672 186
charlesmn 0:3ac96e360672 187 return status;
charlesmn 0:3ac96e360672 188 }
charlesmn 0:3ac96e360672 189
charlesmn 0:3ac96e360672 190
charlesmn 0:3ac96e360672 191 VL53L1_Error VL53L1_disable_calib_pulse_delay(
charlesmn 0:3ac96e360672 192 VL53L1_DEV Dev)
charlesmn 0:3ac96e360672 193 {
charlesmn 0:3ac96e360672 194
charlesmn 0:3ac96e360672 195
charlesmn 0:3ac96e360672 196 VL53L1_Error status = VL53L1_ERROR_NONE;
charlesmn 0:3ac96e360672 197
charlesmn 0:3ac96e360672 198 LOG_FUNCTION_START("");
charlesmn 0:3ac96e360672 199
charlesmn 0:3ac96e360672 200 status =
charlesmn 0:3ac96e360672 201 VL53L1_set_calib_config(
charlesmn 0:3ac96e360672 202 Dev,
charlesmn 0:3ac96e360672 203 0x00,
charlesmn 0:3ac96e360672 204 0x00,
charlesmn 0:3ac96e360672 205 0x00,
charlesmn 0:3ac96e360672 206 0x00,
charlesmn 0:3ac96e360672 207 0x00,
charlesmn 0:3ac96e360672 208 VL53L1_RANGING_CORE__SPAD_READOUT__STANDARD);
charlesmn 0:3ac96e360672 209
charlesmn 0:3ac96e360672 210 LOG_FUNCTION_END(status);
charlesmn 0:3ac96e360672 211
charlesmn 0:3ac96e360672 212 return status;
charlesmn 0:3ac96e360672 213 }
charlesmn 0:3ac96e360672 214
charlesmn 0:3ac96e360672 215
charlesmn 0:3ac96e360672 216