Qwiic_VL53L1X_Py

Python module for the SparkFun Distance Sensor Breakout - 4 Meter, VL53L1X (Qwiic).

This package should be used in conjunction with the overall SparkFun qwiic Python Package. New to qwiic? Take a look at the entire SparkFun qwiic ecosystem.

Contents

• Supported Platforms
• Dependencies
• Installation
• Documentation
• Example Use

Supported Platforms

The qwiic VL53L1X Python package current supports the following platforms:

• Raspberry Pi

Dependencies

This package depends on the qwiic I2C driver: Qwiic_I2C_Py

Documentation

The SparkFun qwiic VL53L1X module documentation is hosted at ReadTheDocs

Installation

PyPi Installation

This repository is hosted on PyPi as the sparkfun-qwiic-vl53l1x package. On systems that support PyPi installation via pip, this library is installed using the following commands

For all users (note: the user must have sudo privileges):

sudo pip install sparkfun-qwiic-vl53l1x

For the current user:

pip install sparkfun-qwiic-vl53l1x

Local Installation

To install, make sure the setuptools package is installed on the system.

Direct installation at the command line:

python setup.py install

To build a package for use with pip:

python setup.py sdist

A package file is built and placed in a subdirectory called dist. This package file can be installed using pip.

cd dist
pip install sparkfun_qwiic_vl53l1x-<version>.tar.gz
  

Example Use

See the examples directory for more detailed use examples.

import qwiic_vl53l1x
import time
import sys

def runExample():

	print("\nSparkFun VL53L1X Example 1\n")
	mySensor = qwiic_vl53l1x.QwiicVL53L1X()

	if mySensor.isConnected() == False:
		print("The Qwiic VL53L1X device isn't connected to the system. Please check your connection", \
			file=sys.stderr)
		return

	mySensor.sensor_init()
  
	while True:
	try:
		mySensor.start_ranging()						 # Write configuration bytes to initiate measurement
		time.sleep(.005)
		distance = mySensor.get_distance()	 # Get the result of the measurement from the sensor
		time.sleep(.005)
		mySensor.stop_ranging()

		print("Distance(mm): %s" % distance)

	except Exception as e:
		print(e)