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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_us100-1.1.24.tar.gz
Algorithm Hash digest
SHA256 a79b7ce7f8dcc0898a3c14bb2aaa73086159183c861a4a2bc2652b2871e4e848
MD5 bf2b7d8f033cc37f44a1f391d09ac9f2
BLAKE2b-256 050dd929ad0e0af135855b000c7ec4a025288472de77ac717630861552df679a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_us100-1.1.24-py3-none-any.whl
Algorithm Hash digest
SHA256 32ba5080156280269041432d703498b5448a3ece30ab89640194b6a7f441c94e
MD5 c619f10c239a5b1aa1d9db76beedca5d
BLAKE2b-256 67e7e090387f93fbb74798d801a6e224d0a4c1a7b1715292ec51abafe966a14a

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