mohamed achour / vl53l0x_api

hh

Dependents:   VL53L0X-mbedOS-master VL53L0X-mbedOS-masterbb

vl53l0x_api_calibration.h@0:e6fcdb78a136, 2016-08-23 (annotated)

Committer:
mjarvisal
Date:
Tue Aug 23 05:14:05 2016 +0000
Revision:
0:e6fcdb78a136
Initial release

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mjarvisal 0:e6fcdb78a136 1 /*******************************************************************************
mjarvisal 0:e6fcdb78a136 2 Copyright © 2016, STMicroelectronics International N.V.
mjarvisal 0:e6fcdb78a136 3 All rights reserved.
mjarvisal 0:e6fcdb78a136 4
mjarvisal 0:e6fcdb78a136 5 Redistribution and use in source and binary forms, with or without
mjarvisal 0:e6fcdb78a136 6 modification, are permitted provided that the following conditions are met:
mjarvisal 0:e6fcdb78a136 7 * Redistributions of source code must retain the above copyright
mjarvisal 0:e6fcdb78a136 8 notice, this list of conditions and the following disclaimer.
mjarvisal 0:e6fcdb78a136 9 * Redistributions in binary form must reproduce the above copyright
mjarvisal 0:e6fcdb78a136 10 notice, this list of conditions and the following disclaimer in the
mjarvisal 0:e6fcdb78a136 11 documentation and/or other materials provided with the distribution.
mjarvisal 0:e6fcdb78a136 12 * Neither the name of STMicroelectronics nor the
mjarvisal 0:e6fcdb78a136 13 names of its contributors may be used to endorse or promote products
mjarvisal 0:e6fcdb78a136 14 derived from this software without specific prior written permission.
mjarvisal 0:e6fcdb78a136 15
mjarvisal 0:e6fcdb78a136 16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
mjarvisal 0:e6fcdb78a136 17 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
mjarvisal 0:e6fcdb78a136 18 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
mjarvisal 0:e6fcdb78a136 19 NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.
mjarvisal 0:e6fcdb78a136 20 IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY
mjarvisal 0:e6fcdb78a136 21 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
mjarvisal 0:e6fcdb78a136 22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
mjarvisal 0:e6fcdb78a136 23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
mjarvisal 0:e6fcdb78a136 24 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
mjarvisal 0:e6fcdb78a136 25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
mjarvisal 0:e6fcdb78a136 26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mjarvisal 0:e6fcdb78a136 27 *******************************************************************************/
mjarvisal 0:e6fcdb78a136 28
mjarvisal 0:e6fcdb78a136 29 #ifndef _VL53L0X_API_CALIBRATION_H_
mjarvisal 0:e6fcdb78a136 30 #define _VL53L0X_API_CALIBRATION_H_
mjarvisal 0:e6fcdb78a136 31
mjarvisal 0:e6fcdb78a136 32 #include "vl53l0x_def.h"
mjarvisal 0:e6fcdb78a136 33 #include "vl53l0x_platform.h"
mjarvisal 0:e6fcdb78a136 34
mjarvisal 0:e6fcdb78a136 35
mjarvisal 0:e6fcdb78a136 36 #ifdef __cplusplus
mjarvisal 0:e6fcdb78a136 37 extern "C" {
mjarvisal 0:e6fcdb78a136 38 #endif
mjarvisal 0:e6fcdb78a136 39
mjarvisal 0:e6fcdb78a136 40 VL53L0X_Error VL53L0X_perform_xtalk_calibration(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 41 FixPoint1616_t XTalkCalDistance,
mjarvisal 0:e6fcdb78a136 42 FixPoint1616_t *pXTalkCompensationRateMegaCps);
mjarvisal 0:e6fcdb78a136 43
mjarvisal 0:e6fcdb78a136 44 VL53L0X_Error VL53L0X_perform_offset_calibration(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 45 FixPoint1616_t CalDistanceMilliMeter,
mjarvisal 0:e6fcdb78a136 46 int32_t *pOffsetMicroMeter);
mjarvisal 0:e6fcdb78a136 47
mjarvisal 0:e6fcdb78a136 48 VL53L0X_Error VL53L0X_set_offset_calibration_data_micro_meter(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 49 int32_t OffsetCalibrationDataMicroMeter);
mjarvisal 0:e6fcdb78a136 50
mjarvisal 0:e6fcdb78a136 51 VL53L0X_Error VL53L0X_get_offset_calibration_data_micro_meter(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 52 int32_t *pOffsetCalibrationDataMicroMeter);
mjarvisal 0:e6fcdb78a136 53
mjarvisal 0:e6fcdb78a136 54 VL53L0X_Error VL53L0X_apply_offset_adjustment(VL53L0X_DEV Dev);
mjarvisal 0:e6fcdb78a136 55
mjarvisal 0:e6fcdb78a136 56 VL53L0X_Error VL53L0X_perform_ref_spad_management(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 57 uint32_t *refSpadCount, uint8_t *isApertureSpads);
mjarvisal 0:e6fcdb78a136 58
mjarvisal 0:e6fcdb78a136 59 VL53L0X_Error VL53L0X_set_reference_spads(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 60 uint32_t count, uint8_t isApertureSpads);
mjarvisal 0:e6fcdb78a136 61
mjarvisal 0:e6fcdb78a136 62 VL53L0X_Error VL53L0X_get_reference_spads(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 63 uint32_t *pSpadCount, uint8_t *pIsApertureSpads);
mjarvisal 0:e6fcdb78a136 64
mjarvisal 0:e6fcdb78a136 65 VL53L0X_Error VL53L0X_perform_phase_calibration(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 66 uint8_t *pPhaseCal, const uint8_t get_data_enable,
mjarvisal 0:e6fcdb78a136 67 const uint8_t restore_config);
mjarvisal 0:e6fcdb78a136 68
mjarvisal 0:e6fcdb78a136 69 VL53L0X_Error VL53L0X_perform_ref_calibration(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 70 uint8_t *pVhvSettings, uint8_t *pPhaseCal, uint8_t get_data_enable);
mjarvisal 0:e6fcdb78a136 71
mjarvisal 0:e6fcdb78a136 72 VL53L0X_Error VL53L0X_set_ref_calibration(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 73 uint8_t VhvSettings, uint8_t PhaseCal);
mjarvisal 0:e6fcdb78a136 74
mjarvisal 0:e6fcdb78a136 75 VL53L0X_Error VL53L0X_get_ref_calibration(VL53L0X_DEV Dev,
mjarvisal 0:e6fcdb78a136 76 uint8_t *pVhvSettings, uint8_t *pPhaseCal);
mjarvisal 0:e6fcdb78a136 77
mjarvisal 0:e6fcdb78a136 78
mjarvisal 0:e6fcdb78a136 79
mjarvisal 0:e6fcdb78a136 80
mjarvisal 0:e6fcdb78a136 81 #ifdef __cplusplus
mjarvisal 0:e6fcdb78a136 82 }
mjarvisal 0:e6fcdb78a136 83 #endif
mjarvisal 0:e6fcdb78a136 84
mjarvisal 0:e6fcdb78a136 85 #endif /* _VL53L0X_API_CALIBRATION_H_ */