Soldered UltrasonicSensor MicroPython Library

This driver supports two hardware variants of the HC-SR04 ultrasonic distance sensor (2cm-400cm range, 1cm accuracy):


Ultrasonic Module HC-SR04 (opens in a new tab) (Native/GPIO, SKU 555041)	Ultrasonic Sensor With Qwiic (opens in a new tab) (I2C, SKU 333001)

In Native mode, the raw HC-SR04 module is wired directly to two GPIO pins (trig/echo) and timed in software. In I2C mode, the Qwiic variant carries an onboard ATtiny404 that handles the trigger/echo timing and exposes distance over I2C - no pulse timing needed on the microcontroller side.

How to install

After installing the mpremote package (opens in a new tab), install the library on your board using the following command:

  mpremote mip install github:SolderedElectronics/Soldered-UltrasonicSensor-MicroPython-Library

Or, if you're running a Windows OS:

  python -m mpremote mip install github:SolderedElectronics/Soldered-UltrasonicSensor-MicroPython-Library

Repository Contents

UltrasonicSensor.py - MicroPython driver class (Native + I2C)
Qwiic.py - shared I2C base class this driver depends on
package.json - mip install manifest
/Examples - Native and Qwiic (I2C) examples

Hardware design

You can find hardware design for these boards in the Ultrasonic-sensor-with-easyC and Ultrasonic-sensor-qwiic hardware repositories.

Documentation

Access library documentation here (opens in a new tab).

About Soldered

At Soldered, we design and manufacture a wide selection of electronic products to help you turn your ideas into acts and bring you one step closer to your final project. Our products are intented for makers and crafted in-house by our experienced team in Osijek, Croatia. We believe that sharing is a crucial element for improvement and innovation, and we work hard to stay connected with all our makers regardless of their skill or experience level. Therefore, all our products are open-source. Finally, we always have your back. If you face any problem concerning either your shopping experience or your electronics project, our team will help you deal with it, offering efficient customer service and cost-free technical support anytime. Some of those might be useful for you:

Open-source license

Soldered invests vast amounts of time into hardware & software for these products, which are all open-source. Please support future development by buying one of our products.

Check license details in the LICENSE file. Long story short, use these open-source files for any purpose you want to, as long as you apply the same open-source licence to it and disclose the original source. No warranty - all designs in this repository are distributed in the hope that they will be useful, but without any warranty. They are provided "AS IS", therefore without warranty of any kind, either expressed or implied. The entire quality and performance of what you do with the contents of this repository are your responsibility. In no event, Soldered (TAVU) will be liable for your damages, losses, including any general, special, incidental or consequential damage arising out of the use or inability to use the contents of this repository.

Have fun!

And thank you from your fellow makers at Soldered Electronics.