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.23.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.23-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_us100-1.1.23.tar.gz
Algorithm Hash digest
SHA256 f63c3834836bccea4564c15b717b781a9e51f2c81b7181fe8d533029dc4d72f1
MD5 6d797feb4f182c7378a031531bf1f7fb
BLAKE2b-256 369102ebdf68eee41cb299ecb6b13ab12220a3f3c52a2be8097a0fa1c6b53411

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_us100-1.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 64352dc8dda2c9602408306019a78246e8a8737d6ab02c0fb64f3712cca3b152
MD5 c65bd68353aa608c6707acc7d6fc9e13
BLAKE2b-256 f85ccd827b00dbaec18ffa6385bcbf00de81b8cd81daa16f7202787b2381c42f

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