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.15.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-tfmini-1.2.15.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-tfmini-1.2.15.tar.gz
Algorithm Hash digest
SHA256 0282d20b9f0d60602b697df7ae35c233c1382508bf8c01918cc881b0bff0e4ad
MD5 3543c7528d95f9fc43589140703ef35e
BLAKE2b-256 b3072340a17c093ef9f83711aeead2baf5eb21ef75931271e3d328da9661108b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_tfmini-1.2.15-py3-none-any.whl
Algorithm Hash digest
SHA256 cd226a6081fc5d93fa1371b4ed9c5c4ace88f48fc7cf61b087a8e5e8ceae8317
MD5 4e137d5cb73e874cb3f6957f76f460c1
BLAKE2b-256 f6751fbe17df6d1ac802c3d5018209122f7b7a628728a83ca2e5cd6c19e12705

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