API Reference

adafruit_vl53l1x

CircuitPython module for interacting with the VL53L1X distance sensor.

  • Author(s): Carter Nelson

Implementation Notes

Hardware:

Software and Dependencies:

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

The center of the sensor’s region of interest. To set the center, set the pad that is to the right and above the exact center of the region you’d like to measure as your opticalCenter. You must change the roi_xy value to somtheing smaller than 16x16 in order to use any center value other than 199.

128,136,144,152,160,168,176,184,  192,200,208,216,224,232,240,248
129,137,145,153,161,169,177,185,  193,201,209,217,225,233,241,249
130,138,146,154,162,170,178,186,  194,202,210,218,226,234,242,250
131,139,147,155,163,171,179,187,  195,203,211,219,227,235,243,251
132,140,148,156,164,172,180,188,  196,204,212,220,228,236,244,252
133,141,149,157,165,173,181,189,  197,205,213,221,229,237,245,253
134,142,150,158,166,174,182,190,  198,206,214,222,230,238,246,254
135,143,151,159,167,175,183,191,  199,207,215,223,231,239,247,255

127,119,111,103, 95, 87, 79, 71,  63, 55, 47, 39, 31, 23, 15, 7
126,118,110,102, 94, 86, 78, 70,  62, 54, 46, 38, 30, 22, 14, 6
125,117,109,101, 93, 85, 77, 69,  61, 53, 45, 37, 29, 21, 13, 5
124,116,108,100, 92, 84, 76, 68,  60, 52, 44, 36, 28, 20, 12, 4
123,115,107, 99, 91, 83, 75, 67,  59, 51, 43, 35, 27, 19, 11, 3
122,114,106, 98, 90, 82, 74, 66,  58, 50, 42, 34, 26, 18, 10, 2
121,113,105, 97, 89, 81, 73, 65,  57, 49, 41, 33, 25, 17, 9, 1
120,112,104, 96, 88, 80, 72, 64,  56, 48, 40, 32, 24, 16, 8, 0
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 VL53L1X 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.