Macros

API core specific definitions. More...

Collaboration diagram for Misc Functionality:

Macros

#define VL53L1_AMBIENT_WINDOW_VCSEL_PERIODS   256
 
#define VL53L1_COUNT_RATE_INTERNAL_MAX   ((0x01 << 24) - 1)
 
#define VL53L1_ENABLE_POWERFORCE_SETTLING_TIME_US   250
 
#define VL53L1_FIRMWARE_BOOT_TIME_US   1200
 
#define VL53L1_MACRO_PERIOD_VCSEL_PERIODS   (VL53L1_AMBIENT_WINDOW_VCSEL_PERIODS + VL53L1_RANGING_WINDOW_VCSEL_PERIODS)
 
#define VL53L1_MAX_ALLOWED_PHASE   0xFFFF
 
#define VL53L1_NO_OF_SPAD_ENABLES   256
 
#define VL53L1_NVM_SIZE_IN_BYTES   512
 
#define VL53L1_POLLING_DELAY_US   1000
 
#define VL53L1_RANGING_WINDOW_VCSEL_PERIODS   2048
 
#define VL53L1_REF_SPAD_BUFFER_SIZE   6
 
#define VL53L1_RTN_SPAD_APERTURE_TRANSMISSION   0x0038
 
#define VL53L1_RTN_SPAD_BUFFER_SIZE   32
 
#define VL53L1_RTN_SPAD_UNITY_TRANSMISSION   0x0100
 
#define VL53L1_SOFTWARE_RESET_DURATION_US   100
 
#define VL53L1_SPAD_ARRAY_HEIGHT   16
 
#define VL53L1_SPAD_ARRAY_WIDTH   16
 
#define VL53L1_SPAD_TOTAL_COUNT_MAX   ((0x01 << 29) - 1)
 
#define VL53L1_SPAD_TOTAL_COUNT_RES_THRES   (0x01 << 24)
 
#define VL53L1_SPEED_OF_LIGHT_IN_AIR   299704
 
#define VL53L1_SPEED_OF_LIGHT_IN_AIR_DIV_8   (299704 >> 3)
 

Detailed Description

API core specific definitions.

Macro Definition Documentation

◆ VL53L1_AMBIENT_WINDOW_VCSEL_PERIODS

#define VL53L1_AMBIENT_WINDOW_VCSEL_PERIODS   256

Sigma Delta Ambient window in VCSEL Periods

Definition at line 502 of file vl53l1_ll_device.h.

◆ VL53L1_COUNT_RATE_INTERNAL_MAX

#define VL53L1_COUNT_RATE_INTERNAL_MAX   ((0x01 << 24) - 1)

Maximum internal count rate is a 17.7 (24-b) value

Definition at line 523 of file vl53l1_ll_device.h.

◆ VL53L1_ENABLE_POWERFORCE_SETTLING_TIME_US

#define VL53L1_ENABLE_POWERFORCE_SETTLING_TIME_US   250

After enabling power force a delay is required to bring regulator, bandgap, oscillator time to power up and settle

Definition at line 486 of file vl53l1_ll_device.h.

◆ VL53L1_FIRMWARE_BOOT_TIME_US

#define VL53L1_FIRMWARE_BOOT_TIME_US   1200

Duration of firmware boot time for which I2C access is blocked. Real Device 1ms, FPGA 15ms

Definition at line 483 of file vl53l1_ll_device.h.

◆ VL53L1_MACRO_PERIOD_VCSEL_PERIODS

#define VL53L1_MACRO_PERIOD_VCSEL_PERIODS   (VL53L1_AMBIENT_WINDOW_VCSEL_PERIODS + VL53L1_RANGING_WINDOW_VCSEL_PERIODS)

Macro Period in VCSEL periods

Definition at line 506 of file vl53l1_ll_device.h.

◆ VL53L1_MAX_ALLOWED_PHASE

#define VL53L1_MAX_ALLOWED_PHASE   0xFFFF

Maximum Allowed phase 0xFFFF means 31.999 PLL Clocks

Definition at line 509 of file vl53l1_ll_device.h.

◆ VL53L1_NO_OF_SPAD_ENABLES

#define VL53L1_NO_OF_SPAD_ENABLES   256

Number of SPADs each SPAD array

Definition at line 496 of file vl53l1_ll_device.h.

◆ VL53L1_NVM_SIZE_IN_BYTES

#define VL53L1_NVM_SIZE_IN_BYTES   512

NVM (OTP) size in bytes

Definition at line 494 of file vl53l1_ll_device.h.

◆ VL53L1_POLLING_DELAY_US

#define VL53L1_POLLING_DELAY_US   1000

1000us delay for register polling

Definition at line 479 of file vl53l1_ll_device.h.

◆ VL53L1_RANGING_WINDOW_VCSEL_PERIODS

#define VL53L1_RANGING_WINDOW_VCSEL_PERIODS   2048

Sigma Delta Ranging window in VCSEL periods

Definition at line 504 of file vl53l1_ll_device.h.

◆ VL53L1_REF_SPAD_BUFFER_SIZE

#define VL53L1_REF_SPAD_BUFFER_SIZE   6

Number of Reference SPAD enable registers (bytes)

Definition at line 500 of file vl53l1_ll_device.h.

◆ VL53L1_RTN_SPAD_APERTURE_TRANSMISSION

#define VL53L1_RTN_SPAD_APERTURE_TRANSMISSION   0x0038

Apertured SPAD transmission value - 8.8 format Nominal: 5x -> 0.200000 * 256 = 51 = 0x33 Measured: 4.6x -> 0.217391 * 256 = 56 = 0x38

Definition at line 514 of file vl53l1_ll_device.h.

◆ VL53L1_RTN_SPAD_BUFFER_SIZE

#define VL53L1_RTN_SPAD_BUFFER_SIZE   32

Number of Return SPAD enable registers (bytes)

Definition at line 498 of file vl53l1_ll_device.h.

◆ VL53L1_RTN_SPAD_UNITY_TRANSMISSION

#define VL53L1_RTN_SPAD_UNITY_TRANSMISSION   0x0100

SPAD unity transmission value - 1.0 in 8.8 format

Definition at line 512 of file vl53l1_ll_device.h.

◆ VL53L1_SOFTWARE_RESET_DURATION_US

#define VL53L1_SOFTWARE_RESET_DURATION_US   100

100us software reset duration

Definition at line 481 of file vl53l1_ll_device.h.

◆ VL53L1_SPAD_ARRAY_HEIGHT

#define VL53L1_SPAD_ARRAY_HEIGHT   16

SPAD array height

Definition at line 492 of file vl53l1_ll_device.h.

◆ VL53L1_SPAD_ARRAY_WIDTH

#define VL53L1_SPAD_ARRAY_WIDTH   16

SPAD array width

Definition at line 490 of file vl53l1_ll_device.h.

◆ VL53L1_SPAD_TOTAL_COUNT_MAX

#define VL53L1_SPAD_TOTAL_COUNT_MAX   ((0x01 << 29) - 1)

Maximum SPAD count - 512Mcps * 1sec = 29bits)

Definition at line 519 of file vl53l1_ll_device.h.

◆ VL53L1_SPAD_TOTAL_COUNT_RES_THRES

#define VL53L1_SPAD_TOTAL_COUNT_RES_THRES   (0x01 << 24)

SPAD count threshold for reduced 3-bit fractional resolution

Definition at line 521 of file vl53l1_ll_device.h.

◆ VL53L1_SPEED_OF_LIGHT_IN_AIR

#define VL53L1_SPEED_OF_LIGHT_IN_AIR   299704

Speed of light in air in mm/sec

Definition at line 525 of file vl53l1_ll_device.h.

◆ VL53L1_SPEED_OF_LIGHT_IN_AIR_DIV_8

#define VL53L1_SPEED_OF_LIGHT_IN_AIR_DIV_8   (299704 >> 3)

Speed of light in air in divided by 8, 2 for round trip and 4 as an additional scaling factor

Definition at line 527 of file vl53l1_ll_device.h.



vl53l1x
Author(s):
autogenerated on Fri Aug 2 2024 08:35:55