ST VL53L1X API User Manual

7.16 BootState
VL53L1X_ERROR VL53L1X_BootState(VL53L1_Dev_t dev, uint8_t *state);
This function returns the Boot state of the device (1 = booted, 0 = not booted).
7.17 GetSensorId
VL53L1X_ERROR VL53L1X_GetSensorId(VL53L1_Dev_t dev, uint16_t *id);
This function returns the sensor ID which must be 0xEEAC.
7.18 GetDistance
VL53L1X_ERROR VL53L1X_GetDistance(VL53L1_Dev_t dev,
uint16_t *distance);
This function returns the distance measured by the sensor in mm.
7.19 GetSignalPerSpad
VL53L1X_ERROR VL53L1X_GetSignalPerSpad(VL53L1_Dev_t dev,
uint16_t *signalPerSp);
This function gives the returned signal per SPAD in kcps/SPAD.
7.20 GetAmbientPerSpad
VL53L1X_ERROR VL53L1X_GetAmbientPerSpad(VL53L1_Dev_t dev,
uint16_t *amb);
This function returns the ambient per SPAD in kcps/SPAD.
7.21 GetSignalRate
VL53L1X_ERROR VL53L1X_GetSignalRate(VL53L1_Dev_t dev,
uint16_t *signalRate);
This function gives the returned signal in kcps.
7.22 GetSpadNb
VL53L1X_ERROR VL53L1X_GetSpadNb(VL53L1_Dev_t dev, uint16_t *spNb);
This function returns the current number of enabled SPADs.
7.23 GetAmbientRate
VL53L1X_ERROR VL53L1X_GetAmbientRate(VL53L1_Dev_t dev,
uint16_t *ambRate);
This function returns the ambient rate in kcps.
7.24 VL53L1X_GetRangeStatus
VL53L1X_ERROR VL53L1X_GetRangeStatus(VL53L1_Dev_t dev,
uint8_t *rangeStatus);
This function returns the ranging status error where 0 = no error, 1 = sigma failure, 2 = signal failure, 4 = sensor
out-of-bounds, and 7 = wraparound).
UM2510
BootState
UM2510 - Rev 1
page 17/26

ST VL53L1X API Specifications

General

Brand	ST
Model	VL53L1X API
Category	Control Unit
Language	English