charles macneill / VL53L1CB

Initial release. Mbed library for VL53L1CB

inc/vl53l1_hist_map.h@0:3d72bef69191, 2020-11-06 (annotated)

Committer:
charlesmn
Date:
Fri Nov 06 12:15:24 2020 +0000
Revision:
0:3d72bef69191
Initial release. Mbed library for VL53L1CB

Who changed what in which revision?

UserRevisionLine numberNew contents of line
charlesmn 0:3d72bef69191 1
charlesmn 0:3d72bef69191 2 /*******************************************************************************
charlesmn 0:3d72bef69191 3 * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
charlesmn 0:3d72bef69191 4
charlesmn 0:3d72bef69191 5 This file is part of VL53L1 Core and is dual licensed,
charlesmn 0:3d72bef69191 6 either 'STMicroelectronics
charlesmn 0:3d72bef69191 7 Proprietary license'
charlesmn 0:3d72bef69191 8 or 'BSD 3-clause "New" or "Revised" License' , at your option.
charlesmn 0:3d72bef69191 9
charlesmn 0:3d72bef69191 10 ********************************************************************************
charlesmn 0:3d72bef69191 11
charlesmn 0:3d72bef69191 12 'STMicroelectronics Proprietary license'
charlesmn 0:3d72bef69191 13
charlesmn 0:3d72bef69191 14 ********************************************************************************
charlesmn 0:3d72bef69191 15
charlesmn 0:3d72bef69191 16 License terms: STMicroelectronics Proprietary in accordance with licensing
charlesmn 0:3d72bef69191 17 terms at www.st.com/sla0081
charlesmn 0:3d72bef69191 18
charlesmn 0:3d72bef69191 19 STMicroelectronics confidential
charlesmn 0:3d72bef69191 20 Reproduction and Communication of this document is strictly prohibited unless
charlesmn 0:3d72bef69191 21 specifically authorized in writing by STMicroelectronics.
charlesmn 0:3d72bef69191 22
charlesmn 0:3d72bef69191 23
charlesmn 0:3d72bef69191 24 ********************************************************************************
charlesmn 0:3d72bef69191 25
charlesmn 0:3d72bef69191 26 Alternatively, VL53L1 Core may be distributed under the terms of
charlesmn 0:3d72bef69191 27 'BSD 3-clause "New" or "Revised" License', in which case the following
charlesmn 0:3d72bef69191 28 provisions apply instead of the ones
charlesmn 0:3d72bef69191 29 mentioned above :
charlesmn 0:3d72bef69191 30
charlesmn 0:3d72bef69191 31 ********************************************************************************
charlesmn 0:3d72bef69191 32
charlesmn 0:3d72bef69191 33 License terms: BSD 3-clause "New" or "Revised" License.
charlesmn 0:3d72bef69191 34
charlesmn 0:3d72bef69191 35 Redistribution and use in source and binary forms, with or without
charlesmn 0:3d72bef69191 36 modification, are permitted provided that the following conditions are met:
charlesmn 0:3d72bef69191 37
charlesmn 0:3d72bef69191 38 1. Redistributions of source code must retain the above copyright notice, this
charlesmn 0:3d72bef69191 39 list of conditions and the following disclaimer.
charlesmn 0:3d72bef69191 40
charlesmn 0:3d72bef69191 41 2. Redistributions in binary form must reproduce the above copyright notice,
charlesmn 0:3d72bef69191 42 this list of conditions and the following disclaimer in the documentation
charlesmn 0:3d72bef69191 43 and/or other materials provided with the distribution.
charlesmn 0:3d72bef69191 44
charlesmn 0:3d72bef69191 45 3. Neither the name of the copyright holder nor the names of its contributors
charlesmn 0:3d72bef69191 46 may be used to endorse or promote products derived from this software
charlesmn 0:3d72bef69191 47 without specific prior written permission.
charlesmn 0:3d72bef69191 48
charlesmn 0:3d72bef69191 49 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
charlesmn 0:3d72bef69191 50 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
charlesmn 0:3d72bef69191 51 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
charlesmn 0:3d72bef69191 52 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
charlesmn 0:3d72bef69191 53 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
charlesmn 0:3d72bef69191 54 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
charlesmn 0:3d72bef69191 55 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
charlesmn 0:3d72bef69191 56 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
charlesmn 0:3d72bef69191 57 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
charlesmn 0:3d72bef69191 58 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
charlesmn 0:3d72bef69191 59
charlesmn 0:3d72bef69191 60
charlesmn 0:3d72bef69191 61 ********************************************************************************
charlesmn 0:3d72bef69191 62
charlesmn 0:3d72bef69191 63 */
charlesmn 0:3d72bef69191 64
charlesmn 0:3d72bef69191 65
charlesmn 0:3d72bef69191 66
charlesmn 0:3d72bef69191 67
charlesmn 0:3d72bef69191 68
charlesmn 0:3d72bef69191 69 #ifndef _VL53L1_HIST_MAP_H_
charlesmn 0:3d72bef69191 70 #define _VL53L1_HIST_MAP_H_
charlesmn 0:3d72bef69191 71
charlesmn 0:3d72bef69191 72 #include "vl53l1_register_map.h"
charlesmn 0:3d72bef69191 73
charlesmn 0:3d72bef69191 74 #ifdef __cplusplus
charlesmn 0:3d72bef69191 75 extern "C"
charlesmn 0:3d72bef69191 76 {
charlesmn 0:3d72bef69191 77 #endif
charlesmn 0:3d72bef69191 78
charlesmn 0:3d72bef69191 79
charlesmn 0:3d72bef69191 80
charlesmn 0:3d72bef69191 81
charlesmn 0:3d72bef69191 82 #define VL53L1_HISTOGRAM_CONFIG__OPCODE_SEQUENCE_0 \
charlesmn 0:3d72bef69191 83 VL53L1_SIGMA_ESTIMATOR__EFFECTIVE_PULSE_WIDTH_NS
charlesmn 0:3d72bef69191 84
charlesmn 0:3d72bef69191 85 #define VL53L1_HISTOGRAM_CONFIG__OPCODE_SEQUENCE_1 \
charlesmn 0:3d72bef69191 86 VL53L1_SIGMA_ESTIMATOR__EFFECTIVE_AMBIENT_WIDTH_NS
charlesmn 0:3d72bef69191 87
charlesmn 0:3d72bef69191 88 #define VL53L1_HISTOGRAM_CONFIG__OPCODE_SEQUENCE_2 \
charlesmn 0:3d72bef69191 89 VL53L1_SIGMA_ESTIMATOR__SIGMA_REF_MM
charlesmn 0:3d72bef69191 90
charlesmn 0:3d72bef69191 91 #define VL53L1_HISTOGRAM_CONFIG__AMB_THRESH_HIGH \
charlesmn 0:3d72bef69191 92 VL53L1_ALGO__RANGE_IGNORE_THRESHOLD_MCPS
charlesmn 0:3d72bef69191 93
charlesmn 0:3d72bef69191 94
charlesmn 0:3d72bef69191 95
charlesmn 0:3d72bef69191 96
charlesmn 0:3d72bef69191 97 #define VL53L1_RESULT__HISTOGRAM_BIN_0_2 0x008E
charlesmn 0:3d72bef69191 98 #define VL53L1_RESULT__HISTOGRAM_BIN_0_1 0x008F
charlesmn 0:3d72bef69191 99 #define VL53L1_RESULT__HISTOGRAM_BIN_0_0 0x0090
charlesmn 0:3d72bef69191 100
charlesmn 0:3d72bef69191 101 #define VL53L1_RESULT__HISTOGRAM_BIN_23_2 0x00D3
charlesmn 0:3d72bef69191 102 #define VL53L1_RESULT__HISTOGRAM_BIN_23_1 0x00D4
charlesmn 0:3d72bef69191 103 #define VL53L1_RESULT__HISTOGRAM_BIN_23_0 0x00D5
charlesmn 0:3d72bef69191 104
charlesmn 0:3d72bef69191 105 #define VL53L1_RESULT__HISTOGRAM_BIN_23_0_MSB 0x00D9
charlesmn 0:3d72bef69191 106 #define VL53L1_RESULT__HISTOGRAM_BIN_23_0_LSB 0x00DA
charlesmn 0:3d72bef69191 107
charlesmn 0:3d72bef69191 108
charlesmn 0:3d72bef69191 109
charlesmn 0:3d72bef69191 110 #define VL53L1_HISTOGRAM_BIN_DATA_I2C_INDEX \
charlesmn 0:3d72bef69191 111 VL53L1_RESULT__INTERRUPT_STATUS
charlesmn 0:3d72bef69191 112 #define VL53L1_HISTOGRAM_BIN_DATA_I2C_SIZE_BYTES \
charlesmn 0:3d72bef69191 113 (VL53L1_RESULT__HISTOGRAM_BIN_23_0_LSB - \
charlesmn 0:3d72bef69191 114 VL53L1_RESULT__INTERRUPT_STATUS + 1)
charlesmn 0:3d72bef69191 115
charlesmn 0:3d72bef69191 116 #ifdef __cplusplus
charlesmn 0:3d72bef69191 117 }
charlesmn 0:3d72bef69191 118 #endif
charlesmn 0:3d72bef69191 119
charlesmn 0:3d72bef69191 120 #endif
charlesmn 0:3d72bef69191 121
charlesmn 0:3d72bef69191 122