A CircuitPython/Python library for Benewake's TF mini distance sensor

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-tfmini

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-tfmini

To install in a virtual environment in your current project:

mkdir project-name && cd project-name python3 -m venv .venv source .venv/bin/activate pip3 install adafruit-circuitpython-tfmini

import time import board # comment this out if using pyserial import busio # comment this out if using pyserial import adafruit_tfmini # Use hardware uart uart = busio.UART(board.TX, board.RX) # Or, you can use pyserial on any computer #import serial #uart = serial.Serial("/dev/ttyS2", timeout=1) # Simplest use, connect with the uart bus object tfmini = adafruit_tfmini.TFmini(uart) # You can put in 'short' or 'long' distance mode tfmini.mode = adafruit_tfmini.MODE_SHORT print("Now in mode", tfmini.mode) while True: print("Distance: %d cm (strength %d, mode %x)" % (tfmini.distance, tfmini.strength, tfmini.mode)) time.sleep(0.1)

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.