John Alexander / VL53L3_Lib

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   VL53L3ExpansionBoard

Embed: (wiki syntax)

« Back to documentation index

VL53LX Init Functions

VL53LX Init Functions
[VL53LX Function Definition]

VL53LX Init Functions. More...

Functions

VL53LX_Error VL53LX_SetDeviceAddress (uint8_t DeviceAddress)
 Set new device address.
VL53LX_Error VL53LX_DataInit ()
 One time device initialization.
VL53LX_Error VL53LX_WaitDeviceBooted ()
 Wait for device booted after chip enable (hardware standby)

Detailed Description

VL53LX Init Functions.


Function Documentation

VL53LX_Error VL53LX_DataInit (  ) [inherited]

One time device initialization.

To be called after device has been powered on and booted see VL53LX_WaitDeviceBooted()

Function Description
When not used after a fresh device "power up", it may return VL53LX_Error_CALIBRATION_WARNING meaning wrong calibration data may have been fetched from device that can result in ranging offset error
If VL53LX_DataInit is called several times then the application must restore calibration calling VL53LX_SetOffsetCalibrationData() It implies application has gathered calibration data thanks to VL53LX_GetOffsetCalibrationData() after an initial calibration stage.
Note:
This function Access to the device
Parameters:
DevDevice Handle
Returns:
VL53LX_Error_NONE Success
"Other error code" See VL53LX_Error

Definition at line 27059 of file vl53lx_class.cpp.

VL53LX_Error VL53LX_SetDeviceAddress ( uint8_t  DeviceAddress ) [inherited]

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 VL53LX_DataInit()

Note:
This function Access to the device
Parameters:
DevDevice Handle
DeviceAddressThe new Device address
Returns:
VL53LX_Error_NONE Success
"Other error code" See VL53LX_Error

Definition at line 27043 of file vl53lx_class.cpp.

VL53LX_Error VL53LX_WaitDeviceBooted (  ) [inherited]

Wait for device booted after chip enable (hardware standby)

Parameters:
DevDevice Handle
Returns:
VL53LX_Error_NONE Success
"Other error code" See VL53LX_Error

Definition at line 27115 of file vl53lx_class.cpp.