A CircuitPython/Python library for Benewake`s TF mini distance sensor
Project description
Introduction
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-tfminiTo install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-tfminiTo install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-tfminiUsage 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)Contributing
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Building locally
Zip release files
To build this library locally you’ll need to install the circuitpython-build-tools package.
python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-toolsOnce installed, make sure you are in the virtual environment:
source .env/bin/activateThen run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tfmini --library_location .Sphinx documentation
Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-themeNow, once you have the virtual environment activated:
cd docs
sphinx-build -E -W -b html . _build/htmlThis will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file adafruit-circuitpython-tfmini-1.1.1.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-tfmini-1.1.1.tar.gz
- Upload date:
- Size: 19.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4674f266a58a4a9cb7a40e04eeb2fb9158d801d38c195b2840ed1146939528a4 |
|
| MD5 | 459eecb5938d6950391e40de7e0a7849 |
|
| BLAKE2b-256 | 2e0f22b7957025b3759e2d282ebfec2e49fe1f264b4fc8189a20746851a42c23 |
