`adafruit_vl53l1x`

CircuitPython module for interacting with the VL53L1X distance sensor.

Author(s): Carter Nelson

Implementation Notes

Hardware:

Adafruit VL53L1X Time of Flight Distance Sensor - ~30 to 4000mm

Software and Dependencies:

Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases
Adafruit’s Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice

class adafruit_vl53l1x.VL53L1X(i2c, address=41)

Driver for the VL53L1X distance sensor.

clear_interrupt(): Clears new data interrupt.

property data_ready: Returns true if new data is ready, otherwise false.

property distance: The distance in units of centimeters.

property distance_mode: The distance mode. 1=short (up to 136cm) , 2=long (up to 360cm).

property model_info: A 3 tuple of Model ID, Module Type, and Mask Revision.

property roi_center: Returns the center of the sensor’s region of interest

property roi_xy: Returns the x and y coordinates of the sensor’s region of interest

set_address(new_address): Set a new I2C address to the instantaited object. This is only called when using multiple VL53L0X sensors on the same I2C bus (SDA & SCL pins). See also the example for proper usage.

start_ranging(): Starts ranging operation.

stop_ranging(): Stops ranging operation.

property timing_budget: Ranging duration in milliseconds. Increasing the timing budget increases the maximum distance the device can range and improves the repeatability error. However, average power consumption augments accordingly. ms = 15 (short mode only), 20, 33, 50, 100, 200, 500. Defaults to 50.