Skip to main content

CircuitPython library for reading distance and temperature via US-100 ultra-sonic sensor.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython library for reading distance and temperature via US-100 ultra-sonic 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-us100

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

sudo pip3 install adafruit-circuitpython-us100

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-us100

Usage Example

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.

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_us100-1.1.22.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_circuitpython_us100-1.1.22-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_us100-1.1.22.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_us100-1.1.22.tar.gz
Algorithm Hash digest
SHA256 99c7053632f18af4d0672d1858f8759ffe4efc34cc878e6b1b376b0d44893123
MD5 a336d067b47cb19b1db7a15da054e301
BLAKE2b-256 0caac5c8f4f2d860477e3954a553bb0ab66d75d8310ec90bf4100fb1e3f00651

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_us100-1.1.22-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_us100-1.1.22-py3-none-any.whl
Algorithm Hash digest
SHA256 386888f2938e67063dee0be6b039bcf83713a7b402586e7a8c037ced57a3dc37
MD5 dccd7f9ffddd7277cf83962672a15a3e
BLAKE2b-256 341c7d4a29ec5dfa9a0a16f55fa8a2dcc486d89deae1036b95a3e1ea15495daf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page