VL53L1 Init Functions. More...

Collaboration diagram for VL53L1 Init Functions:

Functions
VL53L1_Error	VL53L1_DataInit (VL53L1_DEV Dev)
	One time device initialization. More...

VL53L1_Error	VL53L1_SetDeviceAddress (VL53L1_DEV Dev, uint8_t DeviceAddress)
	Set new device address. More...

VL53L1_Error	VL53L1_StaticInit (VL53L1_DEV Dev)
	Do basic device init (and eventually patch loading) This function will change the VL53L1_State from VL53L1_STATE_WAIT_STATICINIT to VL53L1_STATE_IDLE. In this stage all default setting will be applied. More...

VL53L1_Error	VL53L1_WaitDeviceBooted (VL53L1_DEV Dev)
	Wait for device booted after chip enable (hardware standby) This function can be run only when VL53L1_State is VL53L1_STATE_POWERDOWN. More...

Detailed Description

VL53L1 Init Functions.

Function Documentation

◆ VL53L1_DataInit()

VL53L1_Error VL53L1_DataInit ( VL53L1_DEV Dev )

One time device initialization.

To be called once and only once after device is brought out of reset (Chip enable) and booted see VL53L1_WaitDeviceBooted()

Function Description: When not used after a fresh device "power up" or reset, it may return VL53L1_ERROR_CALIBRATION_WARNING meaning wrong calibration data may have been fetched from device that can result in ranging offset error
If application cannot execute device reset or need to run VL53L1_DataInit multiple time then it must ensure proper offset calibration saving and restore on its own by using VL53L1_GetOffsetCalibrationData() on first power up and then VL53L1_SetOffsetCalibrationData() in all subsequent init This function will change the VL53L1_State from VL53L1_STATE_POWERDOWN to VL53L1_STATE_WAIT_STATICINIT.

Note: This function Access to the device

Parameters

Dev	Device Handle

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 758 of file vl53l1_api.c.

◆ VL53L1_SetDeviceAddress()

VL53L1_Error VL53L1_SetDeviceAddress	(	VL53L1_DEV	Dev,
		uint8_t	DeviceAddress
	)

Set new device address.

After completion the device will answer to the new address programmed. This function should be called when several devices are used in parallel before start programming the sensor. When a single device us used, there is no need to call this function.

When it is requested for multi devices system this function MUST be called prior to VL53L1_DataInit()

Note: This function Access to the device

Parameters

Dev	Device Handle
DeviceAddress	The new Device address

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 745 of file vl53l1_api.c.

◆ VL53L1_StaticInit()

VL53L1_Error VL53L1_StaticInit ( VL53L1_DEV Dev )

Do basic device init (and eventually patch loading) This function will change the VL53L1_State from VL53L1_STATE_WAIT_STATICINIT to VL53L1_STATE_IDLE. In this stage all default setting will be applied.

Note: This function Access to the device

Parameters

Dev	Device Handle

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 811 of file vl53l1_api.c.

◆ VL53L1_WaitDeviceBooted()

VL53L1_Error VL53L1_WaitDeviceBooted ( VL53L1_DEV Dev )

Wait for device booted after chip enable (hardware standby) This function can be run only when VL53L1_State is VL53L1_STATE_POWERDOWN.

Parameters

Dev	Device Handle

Returns: VL53L1_ERROR_NONE Success; "Other error code" See VL53L1_Error

Definition at line 840 of file vl53l1_api.c.