CircuitPython library for controlling HC-SR04 ultrasonic range sensors.
Project description
Introduction
The HC-SR04 is an inexpensive solution for measuring distances using microcontrollers. This library provides a simple driver for controlling these sensors from CircuitPython.
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-hcsr04To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-hcsr04To 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-hcsr04Usage Example
You’ll need to dedicate two pins to communicating with the HC-SR04. The sensor communicates in a very rudimentary manner, so it doesn’t matter which pins you choose, as long as they’re digital IO pins (pins that start with “D” are digital).
There are two ways of instantiating a HCSR04 object: with or without using a context manager.
See Also:
- Adafruit’s guide on Lifetime and ContextManagers
Gives more info on using context managers with CircuitPython drivers.
- board
A list of pins available on your device. To view this list, first get a REPL (the guide linked was written for the pyboard, but it still works), then input the following:
import board dir(board)
Without a Context Manager
In the example below, we create the HCSR04 object directly, get the distance every 2 seconds.
import time
import board
import adafruit_hcsr04
sonar = adafruit_hcsr04.HCSR04(trigger_pin=board.D5, echo_pin=board.D6)
while True:
try:
print((sonar.distance,))
except RuntimeError:
print("Retrying!")
time.sleep(2)With a Context Manager
In the example below, we use a context manager (the with statement) to create the HCSR04 instance, again get the distance every 2 seconds, but then the context manager handles de-initializing the device for us.
import board
from adafruit_hcsr04 import HCSR04
with HCSR04(trigger_pin=board.D5, echo_pin=board.D6) as sonar:
try:
while True:
print(sonar.distance)
sleep(2)
except KeyboardInterrupt:
passDocumentation
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file adafruit_circuitpython_hcsr04-0.4.19.tar.gz.
File metadata
- Download URL: adafruit_circuitpython_hcsr04-0.4.19.tar.gz
- Upload date:
- Size: 284.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee88766c2060d9a639e7470564539aef298907ad9fa0c212e5e192bddd0e496d |
|
| MD5 | abc0676a9478c5a8e5e041dd75a3d3e0 |
|
| BLAKE2b-256 | 4c968c339478a4c3e1f851f8f0017afa42f58ffdcf1363ab609d7f8aed9564c0 |
File details
Details for the file adafruit_circuitpython_hcsr04-0.4.19-py3-none-any.whl.
File metadata
- Download URL: adafruit_circuitpython_hcsr04-0.4.19-py3-none-any.whl
- Upload date:
- Size: 6.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e1d6d4a4bcad85cc48dd2d24cfe89e27ead618d94951144a61086accc306f8b2 |
|
| MD5 | ab3809f9cffeef0e6036f72832c2058e |
|
| BLAKE2b-256 | 02d1f3541c0c6b2e2092ccf4abed71d51425f77ae9eb7294224cf9196b206bf8 |
