VL53L0X Interrupt Functions
[VL53L0X cut1.1 Function Definition]

Clear given system interrupt condition.

Function Description

Clear given interrupt(s).

Note:

This function Access to the device

Parameters:

Dev	Device Handle
InterruptMask	Mask of interrupts to clear

Returns:

VL53L0X_ERROR_NONE Success

VL53L0X_ERROR_INTERRUPT_NOT_CLEARED Cannot clear interrupts

"Other error code" See VL53L0X_Error

Definition at line 2674 of file vl53l0x_api.cpp.

Configure ranging interrupt reported to system.

Note:

This function is not Implemented

Parameters:

Dev	Device Handle
InterruptMask	Mask of interrupt to Enable/disable (0:interrupt disabled or 1: interrupt enabled)

Returns:

VL53L0X_ERROR_NOT_IMPLEMENTED Not implemented

Definition at line 2716 of file vl53l0x_api.cpp.

Get current configuration for GPIO pin for a given device.

Note:

This function Access to the device

Parameters:

Dev	Device Handle
Pin	ID of the GPIO Pin
pDeviceMode	Pointer to Device Mode associated to the Gpio.
pFunctionality	Pointer to Pin functionality. Refer to VL53L0X_GpioFunctionality
pPolarity	Pointer to interrupt polarity. Active high or active low see VL53L0X_InterruptPolarity

Returns:

VL53L0X_ERROR_NONE Success

VL53L0X_ERROR_GPIO_NOT_EXISTING Only Pin=0 is accepted.

VL53L0X_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED This error occurs when Functionality programmed is not in the supported list: Supported value are: VL53L0X_GPIOFUNCTIONALITY_OFF, VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_LOW, VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_HIGH, VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_OUT, VL53L0X_GPIOFUNCTIONALITY_NEW_MEASURE_READY

"Other error code" See VL53L0X_Error

Definition at line 2528 of file vl53l0x_api.cpp.

Return device interrupt status.

Function Description

Returns currently raised interrupts by the device. User shall be able to activate/deactivate interrupts through VL53L0X_SetGpioConfig()

Note:

This function Access to the device

Parameters:

Dev	Device Handle
pInterruptMaskStatus	Pointer to status variable to update

Returns:

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Definition at line 2701 of file vl53l0x_api.cpp.

Get high and low Interrupt thresholds for a given mode (ranging, ALS, ...) for a given device.

Function Description

Get high and low Interrupt thresholds for a given mode (ranging, ALS, ...) for a given device

Note:

This function Access to the device

DeviceMode is ignored for the current device

Parameters:

Dev	Device Handle
DeviceMode	Device Mode from which read thresholds
pThresholdLow	Low threshold (mm, lux ..., depending on the mode)
pThresholdHigh	High threshold (mm, lux ..., depending on the mode)

Returns:

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Definition at line 2619 of file vl53l0x_api.cpp.

Return device stop completion status.

Function Description

Returns stop completiob status. User shall call this function after a stop command

Note:

This function Access to the device

Parameters:

Dev	Device Handle
pStopStatus	Pointer to status variable to update

Returns:

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Definition at line 2643 of file vl53l0x_api.cpp.

Set the configuration of GPIO pin for a given device.

Note:

This function Access to the device

Parameters:

Dev	Device Handle
Pin	ID of the GPIO Pin
Functionality	Select Pin functionality. Refer to VL53L0X_GpioFunctionality
DeviceMode	Device Mode associated to the Gpio.
Polarity	Set interrupt polarity. Active high or active low see VL53L0X_InterruptPolarity

Returns:

VL53L0X_ERROR_NONE Success

VL53L0X_ERROR_GPIO_NOT_EXISTING Only Pin=0 is accepted.

VL53L0X_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED This error occurs when Functionality programmed is not in the supported list: Supported value are: VL53L0X_GPIOFUNCTIONALITY_OFF, VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_LOW, VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_HIGH, VL53L0X_GPIOFUNCTIONALITY_THRESHOLD_CROSSED_OUT, VL53L0X_GPIOFUNCTIONALITY_NEW_MEASURE_READY

"Other error code" See VL53L0X_Error

Definition at line 2435 of file vl53l0x_api.cpp.

Set low and high Interrupt thresholds for a given mode (ranging, ALS, ...) for a given device.

Function Description

Set low and high Interrupt thresholds for a given mode (ranging, ALS, ...) for a given device

Note:

This function Access to the device

DeviceMode is ignored for the current device

Parameters:

Dev	Device Handle
DeviceMode	Device Mode for which change thresholds
ThresholdLow	Low threshold (mm, lux ..., depending on the mode)
ThresholdHigh	High threshold (mm, lux ..., depending on the mode)

Returns:

VL53L0X_ERROR_NONE Success

"Other error code" See VL53L0X_Error

Definition at line 2597 of file vl53l0x_api.cpp.