VL53L0X

ST VL53L0X time-of-flight ranging sensor. More...

Files
file	vl53l0x.h
	Custom channels and values for VL53L0X ToF Sensor.

Enumerations
enum	sensor_channel_vl53l0x {   SENSOR_CHAN_VL53L0X_RANGE_DMAX = SENSOR_CHAN_PRIV_START , SENSOR_CHAN_VL53L0X_SIGNAL_RATE_RTN_CPS , SENSOR_CHAN_VL53L0X_AMBIENT_RATE_RTN_CPS , SENSOR_CHAN_VL53L0X_EFFECTIVE_SPAD_RTN_COUNT ,   SENSOR_CHAN_VL53L0X_RANGE_STATUS }
	Custom sensor channels for the VL53L0X. More...

VL53L0X measurement status values
Reported in sensor_value.val1 by SENSOR_CHAN_VL53L0X_RANGE_STATUS.
#define	VL53L0X_RANGE_STATUS_RANGE_VALID   (0)
	Range measurement is valid.
#define	VL53L0X_RANGE_STATUS_SIGMA_FAIL   (1)
	Sigma (noise) check failed.
#define	VL53L0X_RANGE_STATUS_SIGNAL_FAIL   (2)
	Signal level check failed.
#define	VL53L0X_RANGE_STATUS_MIN_RANGE_FAIL   (3)
	Target is below the minimum measurable range.
#define	VL53L0X_RANGE_STATUS_PHASE_FAIL   (4)
	Phase check failed (target out of range).
#define	VL53L0X_RANGE_STATUS_HARDWARE_FAIL   (5)
	Hardware failure.
#define	VL53L0X_RANGE_STATUS_NO_UPDATE   (255)
	No new measurement available.

Detailed Description

ST VL53L0X time-of-flight ranging sensor.

Macro Definition Documentation

VL53L0X_RANGE_STATUS_HARDWARE_FAIL

#define VL53L0X_RANGE_STATUS_HARDWARE_FAIL   (5)

#include <zephyr/drivers/sensor/vl53l0x.h>

Hardware failure.

VL53L0X_RANGE_STATUS_MIN_RANGE_FAIL

#define VL53L0X_RANGE_STATUS_MIN_RANGE_FAIL   (3)

#include <zephyr/drivers/sensor/vl53l0x.h>

Target is below the minimum measurable range.

VL53L0X_RANGE_STATUS_NO_UPDATE

#define VL53L0X_RANGE_STATUS_NO_UPDATE   (255)

#include <zephyr/drivers/sensor/vl53l0x.h>

No new measurement available.

VL53L0X_RANGE_STATUS_PHASE_FAIL

#define VL53L0X_RANGE_STATUS_PHASE_FAIL   (4)

#include <zephyr/drivers/sensor/vl53l0x.h>

Phase check failed (target out of range).

VL53L0X_RANGE_STATUS_RANGE_VALID

#define VL53L0X_RANGE_STATUS_RANGE_VALID   (0)

#include <zephyr/drivers/sensor/vl53l0x.h>

Range measurement is valid.

VL53L0X_RANGE_STATUS_SIGMA_FAIL

#define VL53L0X_RANGE_STATUS_SIGMA_FAIL   (1)

#include <zephyr/drivers/sensor/vl53l0x.h>

Sigma (noise) check failed.

VL53L0X_RANGE_STATUS_SIGNAL_FAIL

#define VL53L0X_RANGE_STATUS_SIGNAL_FAIL   (2)

#include <zephyr/drivers/sensor/vl53l0x.h>

Signal level check failed.

Enumeration Type Documentation

sensor_channel_vl53l0x

enum sensor_channel_vl53l0x

#include <zephyr/drivers/sensor/vl53l0x.h>

Custom sensor channels for the VL53L0X.

These channels provide additional sensor data not covered by the standard Zephyr sensor channels.

Example usage:

#include <zephyr/drivers/sensor/vl53l0x.h>
 
if (sensor_channel_get(dev, SENSOR_CHAN_VL53L0X_RANGE_STATUS, &value)) {
     printk("Status: %d\n", value.val1);
}

Each channel returns its value in a sensor_value structure. Unless noted otherwise, sensor_value.val2 is unused (always 0).

Enumerator
SENSOR_CHAN_VL53L0X_RANGE_DMAX	Maximum range the device can measure, in meters. sensor_value.val1 is the integer part of the distance (meters). sensor_value.val2 is the fractional part (in millionths of a meter).
SENSOR_CHAN_VL53L0X_SIGNAL_RATE_RTN_CPS	Return signal rate, in counts per second. sensor_value.val1 is the signal rate (CPS).
SENSOR_CHAN_VL53L0X_AMBIENT_RATE_RTN_CPS	Ambient signal rate, in counts per second. sensor_value.val1 is the ambient rate (CPS).
SENSOR_CHAN_VL53L0X_EFFECTIVE_SPAD_RTN_COUNT	Effective number of SPADs used for the return measurement. sensor_value.val1 is the integer SPAD count.
SENSOR_CHAN_VL53L0X_RANGE_STATUS	Range status of the last measurement. sensor_value.val1 is one of the range status values.