{"id":20586714,"url":"https://github.com/sparkfun/qwiic_ultrasonic_py","last_synced_at":"2026-05-08T15:18:28.013Z","repository":{"id":215499936,"uuid":"733684972","full_name":"sparkfun/qwiic_ultrasonic_py","owner":"sparkfun","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-26T21:59:36.000Z","size":6331,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-26T22:31:39.813Z","etag":null,"topics":["circuitpython","micropython","python","sparkfun","sparkfun-python"],"latest_commit_sha":null,"homepage":"http://docs.sparkfun.com/qwiic_ultrasonic_py/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sparkfun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-19T22:24:25.000Z","updated_at":"2025-02-20T21:32:03.000Z","dependencies_parsed_at":"2025-02-26T22:36:58.445Z","dependency_job_id":null,"html_url":"https://github.com/sparkfun/qwiic_ultrasonic_py","commit_stats":null,"previous_names":["sparkfun/qwiic_ultrasonic_py"],"tags_count":3,"template":false,"template_full_name":"sparkfun/Qwiic_Template_Py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_ultrasonic_py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_ultrasonic_py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_ultrasonic_py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_ultrasonic_py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sparkfun","download_url":"https://codeload.github.com/sparkfun/qwiic_ultrasonic_py/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242214935,"owners_count":20090721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circuitpython","micropython","python","sparkfun","sparkfun-python"],"created_at":"2024-11-16T07:12:39.130Z","updated_at":"2026-05-08T15:18:22.949Z","avatar_url":"https://github.com/sparkfun.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"SparkFun![Qwiic Ultrasonic Python Package](docs/images/ultrasonic-gh-banner-py.png \"qwiic Ultrasonic Python Package\" )\n\n# SparkFun Qwiic Ultrasonic - Python Package\n\n![PyPi Version](https://img.shields.io/pypi/v/sparkfun_qwiic_ultrasonic)\n![GitHub issues](https://img.shields.io/github/issues/sparkfun/qwiic_ultrasonic_py)\n![License](https://img.shields.io/github/license/sparkfun/qwiic_ultrasonic_py)\n![X](https://img.shields.io/twitter/follow/sparkfun)\n[![API](https://img.shields.io/badge/API%20Reference-blue)](https://docs.sparkfun.com/qwiic_ultrasonic_py/classqwiic__ultrasonic_1_1_qwiic_ultrasonic.html)\n\nThe SparkFun Qwiic HC-SR04 Ultrasonic Distance Sensor provides a simple and cost effective solution for adding distance measurements (from 2cm to 400cm) to your project. Implementing a SparkFun Qwiic I2C interface, these sensors can be rapidly added to any project with boards that are part of the SparkFun Qwiic ecosystem.\n\nThis repository implements a Python package for the SparkFun Qwiic Ultrasonic. This package works with Python, MicroPython and CircuitPython.\n\n### Contents\n\n* [About](#about-the-package)\n* [Installation](#installation)\n* [Supported Platforms](#supported-platforms)\n* [Documentation](https://docs.sparkfun.com/qwiic_ultrasonic_py/classqwiic__ultrasonic_1_1_qwiic_ultrasonic.html)\n* [Examples](#example-use)\n\n## About the Package\n\nThis python package enables the user to access the features of the Ultrasonic Distance Sensor HC-SR04 via a single Qwiic cable. This includes reading distance and setting the I2C address of the device. The capabilities of the Ultrasonic Distance Sensor are each demonstrated in the included examples.\n\nNew to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).\n\n### Supported SparkFun Products\n\nThis Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python. \n\n* [SparkFun Qwiic Ultrasonic Distance Sensor - HC-SR04](https://www.sparkfun.com/sparkfun-qwiic-ultrasonic-distance-sensor-hc-sr04.html)\n\n### Supported Platforms\n\n| Python | Platform | Boards |\n|--|--|--|\n| Python | Linux | [Raspberry Pi](https://www.sparkfun.com/raspberry-pi-5-8gb.html) , [NVIDIA Jetson Orin Nano](https://www.sparkfun.com/nvidia-jetson-orin-nano-developer-kit.html) via the [SparkFun Qwiic SHIM](https://www.sparkfun.com/sparkfun-qwiic-shim-for-raspberry-pi.html) |\n| MicroPython | Raspberry Pi - RP2, ESP32 | [SparkFun Pro Micro RP2350](https://www.sparkfun.com/sparkfun-pro-micro-rp2350.html), [SparkFun IoT RedBoard ESP32](https://www.sparkfun.com/sparkfun-iot-redboard-esp32-development-board.html), [SparkFun IoT RedBoard RP2350](https://www.sparkfun.com/sparkfun-iot-redboard-rp2350.html)\n|CircuitPython | Raspberry Pi - RP2, ESP32 | [SparkFun Pro Micro RP2350](https://www.sparkfun.com/sparkfun-pro-micro-rp2350.html), [SparkFun IoT RedBoard ESP32](https://www.sparkfun.com/sparkfun-iot-redboard-esp32-development-board.html), [SparkFun IoT RedBoard RP2350](https://www.sparkfun.com/sparkfun-iot-redboard-rp2350.html)\n\n\u003e [!NOTE]\n\u003e The listed supported platforms and boards are the primary platform targets tested. It is fully expected that this package will work across a wide variety of Python enabled systems. \n\n## Installation \n\nThe first step to using this package is installing it on your system. The install method depends on the python platform. The following sections outline installation on Python, MicroPython and CircuitPython.\n\n### Python \n\n#### PyPi Installation\n\nThe package is primarily installed using the `pip3` command, downloading the package from the Python Index - \"PyPi\". \n\nNote - the below instructions outline installation an Linux-based (Raspberry Pi) system.\n\nFirst, setup a virtual environment from a specific directory using venv:\n```sh\npython3 -m venv path/to/venv\n```\nYou can pass any path as path/to/venv, just make sure you use the same one for all future steps. For more information on venv [click here](https://docs.python.org/3/library/venv.html).\n\nNext, install the qwiic package with:\n```sh\npath/to/venv/bin/pip3 install sparkfun-qwiic-ultrasonic\n```\nNow you should be able to run any example or custom python scripts that have `import qwiic_ultrasonic` by running e.g.:\n```sh\npath/to/venv/bin/python3 example_script.py\n```\n\n### MicroPython Installation\nIf not already installed, follow the [instructions here](https://docs.micropython.org/en/latest/reference/mpremote.html) to install mpremote on your computer.\n\nConnect a device with MicroPython installed to your computer and then install the package directly to your device with mpremote mip.\n```sh\nmpremote mip install github:sparkfun/qwiic_ultrasonic_py\n```\n\nIf you would also like to install the examples for this repository, issue the following mip command as well:\n```sh\nmpremote mip install --target \"\" github:sparkfun/qwiic_ultrasonic_py@examples\n```\n\n### CircuitPython Installation\nIf not already installed, follow the [instructions here](https://docs.circuitpython.org/projects/circup/en/latest/#installation) to install CircUp on your computer.\n\nEnsure that you have the latest version of the SparkFun Qwiic CircuitPython bundle. \n```sh\ncircup bundle-add sparkfun/Qwiic_Py\n```\n\nFinally, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.\n```sh\ncircup install --py qwiic_ultrasonic\n```\n\nIf you would like to install any of the examples from this repository, issue the corresponding circup command from below. (NOTE: The below syntax assumes you are using CircUp on Windows. Linux and Mac will have different path seperators (i.e. \"/\" vs. \"\\\"). See the [CircUp \"example\" command documentation](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/example-command) for more information)\n```sh\ncircup example qwiic_ultrasonic\\qwiic_ultrasonic_ex1_basic_readings\ncircup example qwiic_ultrasonic\\qwiic_ultrasonic_ex2_change_address.py\n```\n\nExample Use\n ---------------\nBelow is a quickstart program to print distance measurements (in mm) every tenth of a second.\n\nSee the examples directory for more detailed use examples and [examples/README.md](https://github.com/sparkfun/qwiic_ultrasonic_py/blob/master/examples/README.md) for a summary of the available examples.\n\n```python\nimport qwiic_ultrasonic\nimport sys\nimport time\n\n# Here we set the device address. Note that an older version of the Qwiic\n# Ultrasonic firmware used a default address of 0x00. If yours uses 0x00,\n# you'll need to change the address below. It is also recommended to run\n# Example 2 to change the address to the new default.\ndeviceAddress = qwiic_ultrasonic.QwiicUltrasonic.kDefaultAddress\n# deviceAddress = 0x00\n\ndef runExample():\n\tprint(\"\\nQwiic Ultrasonic Example 1 - Basic Readings\\n\")\n\n\t# Create instance of device\n\tmy_ultrasonic = qwiic_ultrasonic.QwiicUltrasonic(address=deviceAddress)\n\n\t# Check if it's connected\n\tif my_ultrasonic.is_connected() == False:\n\t\tprint(\"The device isn't connected to the system. Please check your connection\", \\\n\t\t\tfile=sys.stderr)\n\t\treturn\n\n\t# Initialize the device\n\tmy_ultrasonic.begin()\n\n\t# Loop forever\n\twhile True:\n\t\t# Get measurement from sensor. Note that the measured distance actually\n\t\t# comes from the previous trigger, so measurements will be slightly delayed\n\t\tdistance = my_ultrasonic.trigger_and_read()\n\n\t\t# Print measurement\n\t\tprint(\"Distance (mm):\", distance)\n\n\t\t# Wait a bit\n\t\ttime.sleep(0.1)\n```\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://cdn.sparkfun.com/assets/custom_pages/3/3/4/dark-logo-red-flame.png\" alt=\"SparkFun - Start Something\"\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkfun%2Fqwiic_ultrasonic_py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsparkfun%2Fqwiic_ultrasonic_py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkfun%2Fqwiic_ultrasonic_py/lists"}