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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-tfmini-1.2.13.tar.gz
Algorithm Hash digest
SHA256 8e5d5bbf3dec99bd769a263e0faa3727b569235fa07014581f3893bce260148d
MD5 9322f2f92063e3b4e07e276ada245a1d
BLAKE2b-256 e41729e1ffcdaf0c34222e563af7c3b4bd07a2fa49bae78d5505ae7e0c3d34db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_tfmini-1.2.13-py3-none-any.whl
Algorithm Hash digest
SHA256 6052c0a626d21ba7900f26bfeea7cc3d8c024ca59fb3aeb5bdcbb572b5feb7b8
MD5 4f6d86fe127e8270bec263773e01526c
BLAKE2b-256 f40b6803a9653a0a7d19e9b3fcd2a27f461d2084cfad9ab853bbc2ff93d741bc

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