Detailed Description

Collaboration diagram for VL53L0X:

VL53L0X data structures and types.
enum	vl53l0x_sad_t { VL53L0X_SAD_DEFAULT = 0x29 }
	VL53L0X slave address. More...
enum	vl53l0x_state_t { VL53L0X_UNINIT = 0 , VL53L0X_STOP = 1 , VL53L0X_READY = 2 }
	Driver state machine possible states. More...
typedef struct VL53L0XDriver	VL53L0XDriver
	Structure representing a VL53L0X driver.
#define	_vl53l0x_methods_alone
	`VL53L0X` specific methods.
#define	_vl53l0x_methods
	`VL53L0X` specific methods with inherited ones.
#define	_vl53l0x_data
	`VL53L0XDriver` specific data.

Version identification
#define	EX_VL53L0X_VERSION "1.0.0"
	VL53L0X driver version string.
#define	EX_VL53L0X_MAJOR 1
	VL53L0X driver version major number.
#define	EX_VL53L0X_MINOR 0
	VL53L0X driver version minor number.
#define	EX_VL53L0X_PATCH 0
	VL53L0X driver version patch number.
#define	VL53L0X_RANGE_NUMBER_OF_AXES 1U
	VL53L0X rangefinder subsystem characteristics.
#define	VL53L0X_RANGE_SENS 0.00024414f
#define	VL53L0X_RANGE_BIAS 0.0f

VL53L0X register addresses
#define	VL53L0X_REG_SYSRANGE_START 0x00
#define	VL53L0X_REG_SYSTEM_SEQUENCE_CONFIG 0x01
#define	VL53L0X_REG_SYSTEM_INTERMEASUREMENT_PERIOD 0x04
#define	VL53L0X_REG_SYSTEM_RANGE_CONFIG 0x09
#define	VL53L0X_REG_SYSTEM_INTERRUPT_CONFIG_GPIO 0x0A
#define	VL53L0X_REG_SYSTEM_INTERRUPT_CLEAR 0x0B
#define	VL53L0X_REG_SYSTEM_THRESH_HIGH 0x0C
#define	VL53L0X_REG_SYSTEM_THRESH_LOW 0x0E
#define	VL53L0X_REG_RESULT_INTERRUPT_STATUS 0x13
#define	VL53L0X_REG_RESULT_RANGE_STATUS 0x14
#define	VL53L0X_REG_CROSSTALK_COMPENSATION_PEAK_RATE_MCPS 0x20
#define	VL53L0X_REG_PRE_RANGE_CONFIG_MIN_SNR 0x27
#define	VL53L0X_REG_ALGO_PART_TO_PART_RANGE_OFFSET_MM 0x28
#define	VL53L0X_REG_ALGO_PHASECAL_LIM 0x30
#define	VL53L0X_REG_ALGO_PHASECAL_CONFIG_TIMEOUT 0x30
#define	VL53L0X_REG_GLOBAL_CONFIG_VCSEL_WIDTH 0x32
#define	VL53L0X_REG_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT 0x33
#define	VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT 0x44
#define	VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_LOW 0x47
#define	VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH 0x48
#define	VL53L0X_REG_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD 0x4E
#define	VL53L0X_REG_DYNAMIC_SPAD_REF_EN_START_OFFSET 0x4F
#define	VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD 0x50
#define	VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI 0x51
#define	VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO 0x52
#define	VL53L0X_REG_HISTOGRAM_CONFIG_READOUT_CTRL 0x55
#define	VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_LOW 0x56
#define	VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_HIGH 0x57
#define	VL53L0X_REG_MSRC_CONFIG_CONTROL 0x60
#define	VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_HI 0x61
#define	VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_LO 0x62
#define	VL53L0X_REG_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT 0x64
#define	VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_SNR 0x67
#define	VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD 0x70
#define	VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI 0x71
#define	VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO 0x72
#define	VL53L0X_REG_POWER_MANAGEMENT_GO1_POWER_FORCE 0x80
#define	VL53L0X_REG_SYSTEM_HISTOGRAM_BIN 0x81
#define	VL53L0X_REG_GPIO_HV_MUX_ACTIVE_HIGH 0x84
#define	VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV 0x89
#define	VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS 0x8A
#define	VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_0 0xB0
#define	VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_1 0xB1
#define	VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_2 0xB2
#define	VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_3 0xB3
#define	VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_4 0xB4
#define	VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_5 0xB5
#define	VL53L0X_REG_GLOBAL_CONFIG_REF_EN_START_SELECT 0xB6
#define	VL53L0X_REG_RESULT_PEAK_SIGNAL_RATE_REF 0xB6
#define	VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN 0xBC
#define	VL53L0X_REG_SOFT_RESET_GO2_SOFT_RESET_N 0xBF
#define	VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN 0xC0
#define	VL53L0X_REG_IDENTIFICATION_MODEL_ID 0xC0
#define	VL53L0X_REG_IDENTIFICATION_REVISION_ID 0xC2
#define	VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF 0xD0
#define	VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_REF 0xD4
#define	VL53L0X_REG_OSC_CALIBRATE_VAL 0xF8

VL53L0X_INT_CFG register bits definitions
#define	VL53L0X_INT_CFG_MASK 0xFF
#define	VL53L0X_INT_CFG_PHE (1 << 0)
#define	VL53L0X_INT_CFG_PLE (1 << 1)
#define	VL53L0X_INT_CFG_LIR (1 << 2)
#define	VL53L0X_INT_CFG_DIFF_EN (1 << 3)
#define	VL53L0X_INT_CFG_RESET_AZ (1 << 4)
#define	VL53L0X_INT_CFG_AUTOZERO (1 << 5)
#define	VL53L0X_INT_CFG_RESET_ARP (1 << 6)
#define	VL53L0X_INT_CFG_AUTORIFP (1 << 7)

VL53L0X_CTRL_REG1 register bits definitions
#define	VL53L0X_CTRL_REG1_MASK 0x7F
#define	VL53L0X_CTRL_REG1_SIM (1 << 0)
#define	VL53L0X_CTRL_REG1_BDU (1 << 1)
#define	VL53L0X_CTRL_REG1_LPFP_CFG (1 << 2)
#define	VL53L0X_CTRL_REG1_LPFP_EN (1 << 3)
#define	VL53L0X_CTRL_REG1_ODR0 (1 << 4)
#define	VL53L0X_CTRL_REG1_ODR1 (1 << 5)
#define	VL53L0X_CTRL_REG1_ODR2 (1 << 6)

VL53L0X_CTRL_REG2 register bits definitions
#define	VL53L0X_CTRL_REG2_MASK 0xFD
#define	VL53L0X_CTRL_REG2_ONE_SHOT (1 << 0)
#define	VL53L0X_CTRL_REG2_SWRESET (1 << 2)
#define	VL53L0X_CTRL_REG2_I2C_DIS (1 << 3)
#define	VL53L0X_CTRL_REG2_IF_ADD_INC (1 << 4)
#define	VL53L0X_CTRL_REG2_STOP_ON_FTH (1 << 5)
#define	VL53L0X_CTRL_REG2_FIFO_EN (1 << 6)
#define	VL53L0X_CTRL_REG2_BOOT (1 << 7)

VL53L0X_CTRL_REG3 register bits definitions
#define	VL53L0X_CTRL_REG3_MASK 0xFF
#define	VL53L0X_CTRL_REG3_INT_S1 (1 << 0)
#define	VL53L0X_CTRL_REG3_INT_S2 (1 << 1)
#define	VL53L0X_CTRL_REG3_DRDY (1 << 2)
#define	VL53L0X_CTRL_REG3_F_OVR (1 << 3)
#define	VL53L0X_CTRL_REG3_F_FTH (1 << 4)
#define	VL53L0X_CTRL_REG3_F_FSS5 (1 << 5)
#define	VL53L0X_CTRL_REG3_PP_OD (1 << 6)
#define	VL53L0X_CTRL_REG3_INT_H_L (1 << 7)

VL53L0X_INT_SRC register bits definitions
#define	VL53L0X_INT_SRC_MASK 0x87
#define	VL53L0X_INT_SRC_PH (1 << 0)
#define	VL53L0X_INT_SRC_PL (1 << 1)
#define	VL53L0X_INT_SRC_IA (1 << 2)
#define	VL53L0X_INT_SRC_BOOT_STATUS (1 << 8)

Configuration options
#define	VL53L0X_USE_I2C TRUE
	VL53L0X I2C interface switch.
#define	VL53L0X_SHARED_I2C FALSE
	VL53L0X shared I2C switch.
#define	VL53L0X_USE_ADVANCED FALSE
	VL53L0X advanced configurations switch.

Data Structures
struct	VL53L0XConfig
	VL53L0X configuration structure. More...
struct	VL53L0XVMT
	`VL53L0X` virtual methods table. More...
struct	VL53L0XDriver
	VL53L0X 2-axis rangemeter/thermometer class. More...

Macros
#define	vl53l0xRangeFinderGetAxesNumber(devp)
	Return the number of axes of the BaseRangeFinder.
#define	vl53l0xRangeFinderReadRaw(devp, axes)
	Retrieves raw data from the BaseRangeFinder.
#define	vl53l0xRangeFinderReadCooked(devp, axes)
	Retrieves cooked data from the BaseRangeFinder.

Functions
void	vl53l0xObjectInit (VL53L0XDriver *devp)
void	vl53l0xStart (VL53L0XDriver devp, const VL53L0XConfig config)
void	vl53l0xStop (VL53L0XDriver *devp)

Macro Definition Documentation

◆ EX_VL53L0X_VERSION

#define EX_VL53L0X_VERSION "1.0.0"

VL53L0X driver version string.

Definition at line 45 of file vl53l0x.h.

◆ EX_VL53L0X_MAJOR

#define EX_VL53L0X_MAJOR 1

VL53L0X driver version major number.

Definition at line 50 of file vl53l0x.h.

◆ EX_VL53L0X_MINOR

#define EX_VL53L0X_MINOR 0

VL53L0X driver version minor number.

Definition at line 55 of file vl53l0x.h.

◆ EX_VL53L0X_PATCH

#define EX_VL53L0X_PATCH 0

VL53L0X driver version patch number.

Definition at line 60 of file vl53l0x.h.

◆ VL53L0X_RANGE_NUMBER_OF_AXES

#define VL53L0X_RANGE_NUMBER_OF_AXES 1U

VL53L0X rangefinder subsystem characteristics.

Note: Sensitivity is expressed as hPa/LSB whereas hPa stand for hectopascal.; Bias is expressed as hPa.

Definition at line 71 of file vl53l0x.h.

◆ VL53L0X_RANGE_SENS

#define VL53L0X_RANGE_SENS 0.00024414f

Definition at line 74 of file vl53l0x.h.

◆ VL53L0X_RANGE_BIAS

#define VL53L0X_RANGE_BIAS 0.0f

Definition at line 75 of file vl53l0x.h.

◆ VL53L0X_REG_SYSRANGE_START

#define VL53L0X_REG_SYSRANGE_START 0x00

Definition at line 82 of file vl53l0x.h.

◆ VL53L0X_REG_SYSTEM_SEQUENCE_CONFIG

#define VL53L0X_REG_SYSTEM_SEQUENCE_CONFIG 0x01

Definition at line 83 of file vl53l0x.h.

◆ VL53L0X_REG_SYSTEM_INTERMEASUREMENT_PERIOD

#define VL53L0X_REG_SYSTEM_INTERMEASUREMENT_PERIOD 0x04

Definition at line 84 of file vl53l0x.h.

◆ VL53L0X_REG_SYSTEM_RANGE_CONFIG

#define VL53L0X_REG_SYSTEM_RANGE_CONFIG 0x09

Definition at line 85 of file vl53l0x.h.

◆ VL53L0X_REG_SYSTEM_INTERRUPT_CONFIG_GPIO

#define VL53L0X_REG_SYSTEM_INTERRUPT_CONFIG_GPIO 0x0A

Definition at line 86 of file vl53l0x.h.

◆ VL53L0X_REG_SYSTEM_INTERRUPT_CLEAR

#define VL53L0X_REG_SYSTEM_INTERRUPT_CLEAR 0x0B

Definition at line 87 of file vl53l0x.h.

◆ VL53L0X_REG_SYSTEM_THRESH_HIGH

#define VL53L0X_REG_SYSTEM_THRESH_HIGH 0x0C

Definition at line 88 of file vl53l0x.h.

◆ VL53L0X_REG_SYSTEM_THRESH_LOW

#define VL53L0X_REG_SYSTEM_THRESH_LOW 0x0E

Definition at line 89 of file vl53l0x.h.

◆ VL53L0X_REG_RESULT_INTERRUPT_STATUS

#define VL53L0X_REG_RESULT_INTERRUPT_STATUS 0x13

Definition at line 91 of file vl53l0x.h.

◆ VL53L0X_REG_RESULT_RANGE_STATUS

#define VL53L0X_REG_RESULT_RANGE_STATUS 0x14

Definition at line 92 of file vl53l0x.h.

◆ VL53L0X_REG_CROSSTALK_COMPENSATION_PEAK_RATE_MCPS

#define VL53L0X_REG_CROSSTALK_COMPENSATION_PEAK_RATE_MCPS 0x20

Definition at line 94 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_CONFIG_MIN_SNR

#define VL53L0X_REG_PRE_RANGE_CONFIG_MIN_SNR 0x27

Definition at line 95 of file vl53l0x.h.

◆ VL53L0X_REG_ALGO_PART_TO_PART_RANGE_OFFSET_MM

#define VL53L0X_REG_ALGO_PART_TO_PART_RANGE_OFFSET_MM 0x28

Definition at line 96 of file vl53l0x.h.

◆ VL53L0X_REG_ALGO_PHASECAL_LIM

#define VL53L0X_REG_ALGO_PHASECAL_LIM 0x30

Definition at line 97 of file vl53l0x.h.

◆ VL53L0X_REG_ALGO_PHASECAL_CONFIG_TIMEOUT

#define VL53L0X_REG_ALGO_PHASECAL_CONFIG_TIMEOUT 0x30

Definition at line 98 of file vl53l0x.h.

◆ VL53L0X_REG_GLOBAL_CONFIG_VCSEL_WIDTH

#define VL53L0X_REG_GLOBAL_CONFIG_VCSEL_WIDTH 0x32

Definition at line 99 of file vl53l0x.h.

◆ VL53L0X_REG_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT

#define VL53L0X_REG_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT 0x33

Definition at line 100 of file vl53l0x.h.

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT

#define VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT 0x44

Definition at line 102 of file vl53l0x.h.

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_LOW

#define VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_LOW 0x47

Definition at line 103 of file vl53l0x.h.

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH

#define VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH 0x48

Definition at line 104 of file vl53l0x.h.

◆ VL53L0X_REG_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD

#define VL53L0X_REG_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD 0x4E

Definition at line 105 of file vl53l0x.h.

◆ VL53L0X_REG_DYNAMIC_SPAD_REF_EN_START_OFFSET

#define VL53L0X_REG_DYNAMIC_SPAD_REF_EN_START_OFFSET 0x4F

Definition at line 106 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD

#define VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD 0x50

Definition at line 108 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI

#define VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI 0x51

Definition at line 109 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO

#define VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO 0x52

Definition at line 110 of file vl53l0x.h.

◆ VL53L0X_REG_HISTOGRAM_CONFIG_READOUT_CTRL

#define VL53L0X_REG_HISTOGRAM_CONFIG_READOUT_CTRL 0x55

Definition at line 111 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_LOW

#define VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_LOW 0x56

Definition at line 112 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_HIGH

#define VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_HIGH 0x57

Definition at line 113 of file vl53l0x.h.

◆ VL53L0X_REG_MSRC_CONFIG_CONTROL

#define VL53L0X_REG_MSRC_CONFIG_CONTROL 0x60

Definition at line 115 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_HI

#define VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_HI 0x61

Definition at line 116 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_LO

#define VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_LO 0x62

Definition at line 117 of file vl53l0x.h.

◆ VL53L0X_REG_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT

#define VL53L0X_REG_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT 0x64

Definition at line 118 of file vl53l0x.h.

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_SNR

#define VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_SNR 0x67

Definition at line 119 of file vl53l0x.h.

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD

#define VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD 0x70

Definition at line 121 of file vl53l0x.h.

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI

#define VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI 0x71

Definition at line 122 of file vl53l0x.h.

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO

#define VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO 0x72

Definition at line 123 of file vl53l0x.h.

◆ VL53L0X_REG_POWER_MANAGEMENT_GO1_POWER_FORCE

#define VL53L0X_REG_POWER_MANAGEMENT_GO1_POWER_FORCE 0x80

Definition at line 125 of file vl53l0x.h.

◆ VL53L0X_REG_SYSTEM_HISTOGRAM_BIN

#define VL53L0X_REG_SYSTEM_HISTOGRAM_BIN 0x81

Definition at line 126 of file vl53l0x.h.

◆ VL53L0X_REG_GPIO_HV_MUX_ACTIVE_HIGH

#define VL53L0X_REG_GPIO_HV_MUX_ACTIVE_HIGH 0x84

Definition at line 127 of file vl53l0x.h.

◆ VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV

#define VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV 0x89

Definition at line 128 of file vl53l0x.h.

◆ VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS

#define VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS 0x8A

Definition at line 129 of file vl53l0x.h.

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_0

#define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_0 0xB0

Definition at line 131 of file vl53l0x.h.

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_1

#define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_1 0xB1

Definition at line 132 of file vl53l0x.h.

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_2

#define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_2 0xB2

Definition at line 133 of file vl53l0x.h.

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_3

#define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_3 0xB3

Definition at line 134 of file vl53l0x.h.

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_4

#define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_4 0xB4

Definition at line 135 of file vl53l0x.h.

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_5

#define VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_5 0xB5

Definition at line 136 of file vl53l0x.h.

◆ VL53L0X_REG_GLOBAL_CONFIG_REF_EN_START_SELECT

#define VL53L0X_REG_GLOBAL_CONFIG_REF_EN_START_SELECT 0xB6

Definition at line 137 of file vl53l0x.h.

◆ VL53L0X_REG_RESULT_PEAK_SIGNAL_RATE_REF

#define VL53L0X_REG_RESULT_PEAK_SIGNAL_RATE_REF 0xB6

Definition at line 138 of file vl53l0x.h.

◆ VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN

#define VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN 0xBC

Definition at line 139 of file vl53l0x.h.

◆ VL53L0X_REG_SOFT_RESET_GO2_SOFT_RESET_N

#define VL53L0X_REG_SOFT_RESET_GO2_SOFT_RESET_N 0xBF

Definition at line 140 of file vl53l0x.h.

◆ VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN

#define VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN 0xC0

Definition at line 142 of file vl53l0x.h.

◆ VL53L0X_REG_IDENTIFICATION_MODEL_ID

#define VL53L0X_REG_IDENTIFICATION_MODEL_ID 0xC0

Definition at line 143 of file vl53l0x.h.

◆ VL53L0X_REG_IDENTIFICATION_REVISION_ID

#define VL53L0X_REG_IDENTIFICATION_REVISION_ID 0xC2

Definition at line 144 of file vl53l0x.h.

◆ VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF

#define VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF 0xD0

Definition at line 146 of file vl53l0x.h.

◆ VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_REF

#define VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_REF 0xD4

Definition at line 147 of file vl53l0x.h.

◆ VL53L0X_REG_OSC_CALIBRATE_VAL

#define VL53L0X_REG_OSC_CALIBRATE_VAL 0xF8

Definition at line 149 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_MASK

#define VL53L0X_INT_CFG_MASK 0xFF

Definition at line 156 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_PHE

#define VL53L0X_INT_CFG_PHE (1 << 0)

Definition at line 157 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_PLE

#define VL53L0X_INT_CFG_PLE (1 << 1)

Definition at line 158 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_LIR

#define VL53L0X_INT_CFG_LIR (1 << 2)

Definition at line 159 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_DIFF_EN

#define VL53L0X_INT_CFG_DIFF_EN (1 << 3)

Definition at line 160 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_RESET_AZ

#define VL53L0X_INT_CFG_RESET_AZ (1 << 4)

Definition at line 161 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_AUTOZERO

#define VL53L0X_INT_CFG_AUTOZERO (1 << 5)

Definition at line 162 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_RESET_ARP

#define VL53L0X_INT_CFG_RESET_ARP (1 << 6)

Definition at line 163 of file vl53l0x.h.

◆ VL53L0X_INT_CFG_AUTORIFP

#define VL53L0X_INT_CFG_AUTORIFP (1 << 7)

Definition at line 164 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG1_MASK

#define VL53L0X_CTRL_REG1_MASK 0x7F

Definition at line 171 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG1_SIM

#define VL53L0X_CTRL_REG1_SIM (1 << 0)

Definition at line 172 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG1_BDU

#define VL53L0X_CTRL_REG1_BDU (1 << 1)

Definition at line 173 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG1_LPFP_CFG

#define VL53L0X_CTRL_REG1_LPFP_CFG (1 << 2)

Definition at line 174 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG1_LPFP_EN

#define VL53L0X_CTRL_REG1_LPFP_EN (1 << 3)

Definition at line 175 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG1_ODR0

#define VL53L0X_CTRL_REG1_ODR0 (1 << 4)

Definition at line 176 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG1_ODR1

#define VL53L0X_CTRL_REG1_ODR1 (1 << 5)

Definition at line 177 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG1_ODR2

#define VL53L0X_CTRL_REG1_ODR2 (1 << 6)

Definition at line 178 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG2_MASK

#define VL53L0X_CTRL_REG2_MASK 0xFD

Definition at line 185 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG2_ONE_SHOT

#define VL53L0X_CTRL_REG2_ONE_SHOT (1 << 0)

Definition at line 186 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG2_SWRESET

#define VL53L0X_CTRL_REG2_SWRESET (1 << 2)

Definition at line 187 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG2_I2C_DIS

#define VL53L0X_CTRL_REG2_I2C_DIS (1 << 3)

Definition at line 188 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG2_IF_ADD_INC

#define VL53L0X_CTRL_REG2_IF_ADD_INC (1 << 4)

Definition at line 189 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG2_STOP_ON_FTH

#define VL53L0X_CTRL_REG2_STOP_ON_FTH (1 << 5)

Definition at line 190 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG2_FIFO_EN

#define VL53L0X_CTRL_REG2_FIFO_EN (1 << 6)

Definition at line 191 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG2_BOOT

#define VL53L0X_CTRL_REG2_BOOT (1 << 7)

Definition at line 192 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_MASK

#define VL53L0X_CTRL_REG3_MASK 0xFF

Definition at line 199 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_INT_S1

#define VL53L0X_CTRL_REG3_INT_S1 (1 << 0)

Definition at line 200 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_INT_S2

#define VL53L0X_CTRL_REG3_INT_S2 (1 << 1)

Definition at line 201 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_DRDY

#define VL53L0X_CTRL_REG3_DRDY (1 << 2)

Definition at line 202 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_F_OVR

#define VL53L0X_CTRL_REG3_F_OVR (1 << 3)

Definition at line 203 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_F_FTH

#define VL53L0X_CTRL_REG3_F_FTH (1 << 4)

Definition at line 204 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_F_FSS5

#define VL53L0X_CTRL_REG3_F_FSS5 (1 << 5)

Definition at line 205 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_PP_OD

#define VL53L0X_CTRL_REG3_PP_OD (1 << 6)

Definition at line 206 of file vl53l0x.h.

◆ VL53L0X_CTRL_REG3_INT_H_L

#define VL53L0X_CTRL_REG3_INT_H_L (1 << 7)

Definition at line 207 of file vl53l0x.h.

◆ VL53L0X_INT_SRC_MASK

#define VL53L0X_INT_SRC_MASK 0x87

Definition at line 214 of file vl53l0x.h.

◆ VL53L0X_INT_SRC_PH

#define VL53L0X_INT_SRC_PH (1 << 0)

Definition at line 215 of file vl53l0x.h.

◆ VL53L0X_INT_SRC_PL

#define VL53L0X_INT_SRC_PL (1 << 1)

Definition at line 216 of file vl53l0x.h.

◆ VL53L0X_INT_SRC_IA

#define VL53L0X_INT_SRC_IA (1 << 2)

Definition at line 217 of file vl53l0x.h.

◆ VL53L0X_INT_SRC_BOOT_STATUS

#define VL53L0X_INT_SRC_BOOT_STATUS (1 << 8)

Definition at line 218 of file vl53l0x.h.

◆ VL53L0X_USE_I2C

#define VL53L0X_USE_I2C TRUE

VL53L0X I2C interface switch.

If set to TRUE the support for I2C is included.

Note: The default is TRUE.

Definition at line 235 of file vl53l0x.h.

◆ VL53L0X_SHARED_I2C

#define VL53L0X_SHARED_I2C FALSE

VL53L0X shared I2C switch.

If set to TRUE the device acquires I2C bus ownership on each transaction.

Note: The default is FALSE. Requires I2C_USE_MUTUAL_EXCLUSION.

Definition at line 245 of file vl53l0x.h.

◆ VL53L0X_USE_ADVANCED

#define VL53L0X_USE_ADVANCED FALSE

VL53L0X advanced configurations switch.

If set to TRUE more configurations are available.

Note: The default is FALSE.

Definition at line 254 of file vl53l0x.h.

◆ _vl53l0x_methods_alone

#define _vl53l0x_methods_alone

VL53L0X specific methods.

Note: No methods so far, just a common ancestor interface.

Definition at line 328 of file vl53l0x.h.

◆ _vl53l0x_methods

#define _vl53l0x_methods

Value:

_base_object_methods \

_vl53l0x_methods_alone

VL53L0X specific methods with inherited ones.

Definition at line 333 of file vl53l0x.h.

◆ _vl53l0x_data

#define _vl53l0x_data

Value:

  /* Driver state.*/                                                        \
  vl53l0x_state_t           state;                                          \
  /* Current configuration data.*/                                          \
  const VL53L0XConfig       *config;                                        \
  /* RangeFinder subsystem axes number.*/                                   \
  size_t                    rangeaxes;

VL53L0XDriver specific data.

Definition at line 349 of file vl53l0x.h.

◆ vl53l0xRangeFinderGetAxesNumber

#define vl53l0xRangeFinderGetAxesNumber ( devp )

Value:

rangemeterGetAxesNumber(&((devp)->range_if))

Return the number of axes of the BaseRangeFinder.

Parameters

[in] devp pointer to VL53L0XDriver.

Returns: the number of axes.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 382 of file vl53l0x.h.

◆ vl53l0xRangeFinderReadRaw

#define vl53l0xRangeFinderReadRaw	(		devp,
			axes )

Value:

rangemeterReadRaw(&((devp)->range_if), axes)

Retrieves raw data from the BaseRangeFinder.

Note: This data is retrieved from MEMS register without any algebraical manipulation.; The axes array must be at least the same size of the BaseRangeFinder axes number.

Parameters

[in]	devp	pointer to `VL53L0XDriver`.
[out]	axes	a buffer which would be filled with raw data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 403 of file vl53l0x.h.

◆ vl53l0xRangeFinderReadCooked

#define vl53l0xRangeFinderReadCooked	(		devp,
			axes )

Value:

rangemeterReadCooked(&((devp)->range_if), axes)

Retrieves cooked data from the BaseRangeFinder.

Note: Final data is expressed as mm.; The axes array must be at least the same size of the BaseRangeFinder axes number.

Parameters

[in]	devp	pointer to `VL53L0XDriver`.
[out]	axes	a buffer which would be filled with cooked data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 423 of file vl53l0x.h.

Typedef Documentation

◆ VL53L0XDriver

typedef struct VL53L0XDriver VL53L0XDriver

Structure representing a VL53L0X driver.

Definition at line 281 of file vl53l0x.h.

Enumeration Type Documentation

◆ vl53l0x_sad_t

enum vl53l0x_sad_t

VL53L0X slave address.

Enumerator
VL53L0X_SAD_DEFAULT	Default slave address

Definition at line 286 of file vl53l0x.h.

◆ vl53l0x_state_t

enum vl53l0x_state_t

Driver state machine possible states.

Enumerator
VL53L0X_UNINIT	Not initialized.
VL53L0X_STOP	Stopped.
VL53L0X_READY	Ready.

Definition at line 293 of file vl53l0x.h.

Function Documentation

◆ vl53l0xObjectInit()

void vl53l0xObjectInit ( VL53L0XDriver * devp )

◆ vl53l0xStart()

void vl53l0xStart	(	VL53L0XDriver *	devp,
		const VL53L0XConfig *	config )

◆ vl53l0xStop()

void vl53l0xStop ( VL53L0XDriver * devp )

Detailed Description

VL53L0X data structures and types.

Version identification

VL53L0X register addresses

VL53L0X_INT_CFG register bits definitions

VL53L0X_CTRL_REG1 register bits definitions

VL53L0X_CTRL_REG2 register bits definitions

VL53L0X_CTRL_REG3 register bits definitions

VL53L0X_INT_SRC register bits definitions

Configuration options

Data Structures

Macros

Functions

Macro Definition Documentation

◆ EX_VL53L0X_VERSION

◆ EX_VL53L0X_MAJOR

◆ EX_VL53L0X_MINOR

◆ EX_VL53L0X_PATCH

◆ VL53L0X_RANGE_NUMBER_OF_AXES

◆ VL53L0X_RANGE_SENS

◆ VL53L0X_RANGE_BIAS

◆ VL53L0X_REG_SYSRANGE_START

◆ VL53L0X_REG_SYSTEM_SEQUENCE_CONFIG

◆ VL53L0X_REG_SYSTEM_INTERMEASUREMENT_PERIOD

◆ VL53L0X_REG_SYSTEM_RANGE_CONFIG

◆ VL53L0X_REG_SYSTEM_INTERRUPT_CONFIG_GPIO

◆ VL53L0X_REG_SYSTEM_INTERRUPT_CLEAR

◆ VL53L0X_REG_SYSTEM_THRESH_HIGH

◆ VL53L0X_REG_SYSTEM_THRESH_LOW

◆ VL53L0X_REG_RESULT_INTERRUPT_STATUS

◆ VL53L0X_REG_RESULT_RANGE_STATUS

◆ VL53L0X_REG_CROSSTALK_COMPENSATION_PEAK_RATE_MCPS

◆ VL53L0X_REG_PRE_RANGE_CONFIG_MIN_SNR

◆ VL53L0X_REG_ALGO_PART_TO_PART_RANGE_OFFSET_MM

◆ VL53L0X_REG_ALGO_PHASECAL_LIM

◆ VL53L0X_REG_ALGO_PHASECAL_CONFIG_TIMEOUT

◆ VL53L0X_REG_GLOBAL_CONFIG_VCSEL_WIDTH

◆ VL53L0X_REG_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_LOW

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH

◆ VL53L0X_REG_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD

◆ VL53L0X_REG_DYNAMIC_SPAD_REF_EN_START_OFFSET

◆ VL53L0X_REG_PRE_RANGE_CONFIG_VCSEL_PERIOD

◆ VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI

◆ VL53L0X_REG_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO

◆ VL53L0X_REG_HISTOGRAM_CONFIG_READOUT_CTRL

◆ VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_LOW

◆ VL53L0X_REG_PRE_RANGE_CONFIG_VALID_PHASE_HIGH

◆ VL53L0X_REG_MSRC_CONFIG_CONTROL

◆ VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_HI

◆ VL53L0X_REG_PRE_RANGE_CONFIG_SIGMA_THRESH_LO

◆ VL53L0X_REG_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_MIN_SNR

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_VCSEL_PERIOD

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI

◆ VL53L0X_REG_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO

◆ VL53L0X_REG_POWER_MANAGEMENT_GO1_POWER_FORCE

◆ VL53L0X_REG_SYSTEM_HISTOGRAM_BIN

◆ VL53L0X_REG_GPIO_HV_MUX_ACTIVE_HIGH

◆ VL53L0X_REG_VHV_CONFIG_PAD_SCL_SDA__EXTSUP_HV

◆ VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_0

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_1

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_2

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_3

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_4

◆ VL53L0X_REG_GLOBAL_CONFIG_SPAD_ENABLES_REF_5

◆ VL53L0X_REG_GLOBAL_CONFIG_REF_EN_START_SELECT

◆ VL53L0X_REG_RESULT_PEAK_SIGNAL_RATE_REF

◆ VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN

◆ VL53L0X_REG_SOFT_RESET_GO2_SOFT_RESET_N

◆ VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN

◆ VL53L0X_REG_IDENTIFICATION_MODEL_ID

◆ VL53L0X_REG_IDENTIFICATION_REVISION_ID

◆ VL53L0X_REG_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF

◆ VL53L0X_REG_RESULT_CORE_RANGING_TOTAL_EVENTS_REF

◆ VL53L0X_REG_OSC_CALIBRATE_VAL

◆ VL53L0X_INT_CFG_MASK

◆ VL53L0X_INT_CFG_PHE