Introduction

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-us100/badge/?version=latest :target: https://docs.circuitpython.org/projects/us100/en/latest/ :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_US100/workflows/Build%20CI/badge.svg :target: https://github.com/adafruit/Adafruit_CircuitPython_US100/actions/ :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Code Style: Black

CircuitPython library for reading distance and temperature via US-100 ultra-sonic 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-us100/>_. To install for current user:

.. code-block:: shell

pip3 install adafruit-circuitpython-us100

To install system-wide (this may be required in some cases):

.. code-block:: shell

sudo pip3 install adafruit-circuitpython-us100

To install in a virtual environment in your current project:

.. code-block:: shell

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-us100

Usage Example

.. code-block:: python

import time
import board
import busio
import adafruit_us100

uart = busio.UART(board.TX, board.RX, baudrate=9600)
# Create a US-100 module instance.
us100 = adafruit_us100.US100(uart)

while True:
    print("-----")
    print(f"Temperature: {us100.temperature}°C")
    print(f"Distance: {us100.distance} cm")
    time.sleep(0.5)

Documentation

API documentation for this library can be found on Read the Docs <https://docs.circuitpython.org/projects/us100/en/latest/>_.

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>_.

Contributing

Contributions are welcome! Please read our Code of Conduct <https://github.com/adafruit/Adafruit_CircuitPython_US100/blob/main/CODE_OF_CONDUCT.md>_ before contributing to help this project stay welcoming.