John Alexander / VL53L3_Lib

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   VL53L3ExpansionBoard

Embed: (wiki syntax)

« Back to documentation index

VL53LX General Functions

VL53LX General Functions
[VL53LX Function Definition]

General functions and definitions. More...

Functions

VL53LX_Error VL53LX_GetVersion (VL53LX_Version_t *pVersion)
 Return the VL53LX driver Version.
VL53LX_Error VL53LX_GetProductRevision (uint8_t *pProductRevisionMajor, uint8_t *pProductRevisionMinor)
 Reads the Product Revision for a for given Device This function can be used to distinguish cut1.0 from cut1.1.
VL53LX_Error VL53LX_GetDeviceInfo (VL53LX_DeviceInfo_t *pVL53LX_DeviceInfo)
 Reads the Device information for given Device.
VL53LX_Error VL53LX_GetUID (uint64_t *pUid)
 Reads the Device unique identifier.

Detailed Description

General functions and definitions.


Function Documentation

VL53LX_Error VL53LX_GetDeviceInfo ( VL53LX_DeviceInfo_t pVL53LX_DeviceInfo ) [inherited]

Reads the Device information for given Device.

Note:
This function Access to the device
Parameters:
DevDevice Handle
pVL53LX_DeviceInfoPointer to current device info for a given Device
Returns:
VL53LX_Error_NONE Success
"Other error code" See VL53LX_Error

Definition at line 27010 of file vl53lx_class.cpp.

VL53LX_Error VL53LX_GetProductRevision ( uint8_t *  pProductRevisionMajor,
uint8_t *  pProductRevisionMinor 
) [inherited]

Reads the Product Revision for a for given Device This function can be used to distinguish cut1.0 from cut1.1.

Parameters:
DevDevice Handle
pProductRevisionMajorPointer to Product Revision Major for a given Device
pProductRevisionMinorPointer to Product Revision Minor for a given Device
Returns:
VL53LX_Error_NONE Success
"Other error code" See VL53LX_Error

Definition at line 26993 of file vl53lx_class.cpp.

VL53LX_Error VL53LX_GetUID ( uint64_t *  pUid ) [inherited]

Reads the Device unique identifier.

Note:
This function Access to the device
Parameters:
DevDevice Handle
pUidPointer to current device unique ID
Returns:
VL53LX_Error_NONE Success
"Other error code" See VL53LX_Error

Definition at line 27029 of file vl53lx_class.cpp.

VL53LX_Error VL53LX_GetVersion ( VL53LX_Version_t pVersion ) [inherited]

Return the VL53LX driver Version.

Note:
This function doesn't access to the device
Parameters:
pVersionRer to current driver Version
Returns:
VL53LX_Error_NONE Success
"Other error code" See VL53LX_Error

Definition at line 26979 of file vl53lx_class.cpp.