Metadata-Version: 2.1
Name: adafruit-circuitpython-tfmini
Version: 1.2.1
Summary: A CircuitPython/Python library for Benewake`s TF mini distance sensor
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_TFmini
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-tfmini/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/tfmini/en/latest/
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/discord/327254708534116352.svg
            :target: https://discord.gg/nBQh6qu
            :alt: Discord
        
        .. image:: https://github.com/adafruit/Adafruit_CircuitPython_TFmini/workflows/Build%CI/badge.svg
            :target: https://github.com/adafruit/Adafruit_CircuitPython_TFmini/actions/
            :alt: Build Status
        
        A CircuitPython/Python library for Benewake's TF mini distance sensor
        
        Dependencies
        =============
        This driver depends on:
        
        * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
        
        Please ensure all dependencies are available on the CircuitPython filesystem.
        This is easily achieved by downloading
        `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
        
        Installing from PyPI
        --------------------
        
        On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
        PyPI <https://pypi.org/project/adafruit-circuitpython-tfmini/>`_. To install for current user:
        
        .. code-block:: shell
        
            pip3 install adafruit-circuitpython-tfmini
        
        To install system-wide (this may be required in some cases):
        
        .. code-block:: shell
        
            sudo pip3 install adafruit-circuitpython-tfmini
        
        To install in a virtual environment in your current project:
        
        .. code-block:: shell
        
            mkdir project-name && cd project-name
            python3 -m venv .env
            source .env/bin/activate
            pip3 install adafruit-circuitpython-tfmini
        
        Usage Example
        =============
        
        .. code-block:: python
        
        	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
        <https://github.com/adafruit/Adafruit_CircuitPython_TFmini/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Documentation
        =============
        
        For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
        
Keywords: adafruit tfmini benewake distance sensor hardware micropython circuitpython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
