st,vl53l1x (on i2c bus)

Vendor: STMicroelectronics

Description

STMicroelectronics VL53L1X Time of Flight sensor

Properties

Properties not inherited from the base binding file.

Name

Type

Details

friendly-name

string

Human readable string describing the sensor. It can be used to
distinguish multiple instances of the same model (e.g., lid accelerometer
vs. base accelerometer in a laptop) to a host operating system.

This property is defined in the Generic Sensor Property Usages of the HID
Usage Tables specification
(https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).

supply-gpios

phandle-array

GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.

xshut-gpios

phandle-array

Driving the XSHUT pin low puts the VL53L1X into hardware
standby (if VDD is present) or complete power off (if
VDD is not present). Additionally, if XSHUT is connected
directly to VDD, the sensor will go into boot mode on a
transition from LOW to HIGH.

int-gpios

phandle-array

An interrupt is raised when a distance measurement is ready.
GPIO1 is the interrupt pin on the VL53L1X (active low). This
can be disabled if the user prefers to use polling instead.