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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-tfmini-1.2.18.tar.gz
Algorithm Hash digest
SHA256 088c87d9635168d8d36ce7c264fd9a4c4c7a1e4c1742f59fc28ec969f887bf1e
MD5 31e2108de05129759348fa6299b4f24f
BLAKE2b-256 aab0d253cf1aad811a43e35f40590dd2ac5c35099d8b29e0ac5c0c811a612a2b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_tfmini-1.2.18-py3-none-any.whl
Algorithm Hash digest
SHA256 86cd52834b1bccd052975677b42e3764f4e50d4491b3b857e8021d879acd97f9
MD5 521401bd2cfbaa94834660fb482d0585
BLAKE2b-256 869841e29f424287ff094d0ffee73d87a575613e844c834e7d745caa8615605c

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