Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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

Dependencies

This driver depends on:

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

Installing from PyPI

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

Usage Example

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)

Documentation

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

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

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_tfmini-1.2.19.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_tfmini-1.2.19.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_tfmini-1.2.19.tar.gz
Algorithm Hash digest
SHA256 e12e75395e2dcab47be94db687167b901dac67320c7dfebf078e0546bd9e0903
MD5 5aad6de1b5f9d2db587c9ec3d8f6e36d
BLAKE2b-256 1fed26214c4a487919793ad972282fc23d3d82adfb329cc29f3498f17f99def3

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_tfmini-1.2.19-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_tfmini-1.2.19-py3-none-any.whl
Algorithm Hash digest
SHA256 7413e516e24334c887131f19abec333ed34f24fcbf3506e05382c869c86a3132
MD5 2a89a4a99198eb39c78002b150915f02
BLAKE2b-256 be080d017532b3d2a479526d8f3e565c411685a89f41e4440a98f7ed022cd807

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page