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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-tfmini-1.2.12.tar.gz
Algorithm Hash digest
SHA256 4262a8c248078b271ac1f09b1c0b924a023c9648a94380d58bd34e5f154d91bc
MD5 f37ec3c97284ac550a8ad73eb84b5d80
BLAKE2b-256 1f556f28d1c42e0b81ede4c446ca4840286f7457fc8a2a9ea507d512d626d72f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_tfmini-1.2.12-py3-none-any.whl
Algorithm Hash digest
SHA256 fae28b2780d484d0c48a5e6f590cca7eb6ba4172b314dbf2da38951be3cdefee
MD5 5c3452119a7c7554590d0df72d3544de
BLAKE2b-256 a75487cb6ca40b67fa7eece63a183da97514e4cf0fe4d5903bce893d94d95f53

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