{"id":20586724,"url":"https://github.com/sparkfun/qwiic_button_py","last_synced_at":"2026-04-14T00:04:46.061Z","repository":{"id":137300822,"uuid":"330781277","full_name":"sparkfun/qwiic_button_py","owner":"sparkfun","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-19T18:01:29.000Z","size":6525,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-19T18:35:37.812Z","etag":null,"topics":["circuitpython","micropython","python","sparkfun","sparkfun-python"],"latest_commit_sha":null,"homepage":"http://docs.sparkfun.com/qwiic_button_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":"2021-01-18T20:37:52.000Z","updated_at":"2025-03-19T18:01:34.000Z","dependencies_parsed_at":"2024-11-01T20:16:58.502Z","dependency_job_id":"2bb99478-b4c7-40ac-af94-2ca4890a6d07","html_url":"https://github.com/sparkfun/qwiic_button_py","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/sparkfun/qwiic_button_py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_button_py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_button_py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_button_py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_button_py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sparkfun","download_url":"https://codeload.github.com/sparkfun/qwiic_button_py/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2Fqwiic_button_py/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262702325,"owners_count":23350641,"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:40.667Z","updated_at":"2026-04-14T00:04:46.027Z","avatar_url":"https://github.com/sparkfun.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Qwiic BUTTON - Python Package](docs/images/gh-banner.png \"qwiic BUTTON Python Package\")\n\n# SparkFun Qwiic Button - Python Package\n\n![PyPi Version](https://img.shields.io/pypi/v/sparkfun_qwiic_button)\n![GitHub issues](https://img.shields.io/github/issues/sparkfun/qwiic_button_py)\n![License](https://img.shields.io/github/license/sparkfun/qwiic_button_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_button_py/classqwiic__button_1_1_qwiic_button.html)\n\nThe SparkFun Qwiic Button Module provides a simple and cost effective solution for adding Button capabilities 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 BUTTON. 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_button_py/classqwiic__button_1_1_qwiic_button.html)\n* [Examples](#example-use)\n\n## About the Package\n\nThis python package enables the user to access the features of the button via a single Qwiic cable. This includes checking button state, configuring button LED, change I2C address and more. The capabilities of the BUTTON 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 Button Red LED](https://www.sparkfun.com/sparkfun-qwiic-button-red-led.html)\n* [SparkFun Qwiic Button Green LED](https://www.sparkfun.com/sparkfun-qwiic-button-green-led.html)\n* [SparkFun Qwiic Button Breakout](https://www.sparkfun.com/sparkfun-qwiic-button-breakout.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 on a 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-button\n```\nNow you should be able to run any example or custom python scripts that have `import qwiic_button` 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_button_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_button_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_button\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. 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\n```sh\ncircup example qwiic_button\\qwiic_button_ex1_buttonPress\ncircup example qwiic_button\\qwiic_button_ex2_LEDon\ncircup example qwiic_button\\qwiic_button_ex3_LEDconfig\ncircup example qwiic_button\\qwiic_button_ex4_queueUsage\ncircup example qwiic_button\\qwiic_button_ex5_popQueue\ncircup example qwiic_button\\qwiic_button_ex6_changeI2CAddress\ncircup example qwiic_button\\qwiic_button_ex7_2Buttons\n```\n\nExample Use\n ---------------\nBelow is a quickstart program to print readings from the BUTTON.\n\nSee the examples directory for more detailed use examples and [examples/README.md](https://github.com/sparkfun/qwiic_button_py/blob/main/examples/README.md) for a summary of the available examples.\n\n```python\n\nimport qwiic_button \nimport time\nimport sys\n\ndef run_example():\n\n    print(\"\\nSparkFun Qwiic Button Example 1\")\n    my_button = qwiic_button.QwiicButton()\n\n    if my_button.begin() == False:\n        print(\"\\nThe Qwiic Button isn't connected to the system. Please check your connection\", \\\n            file=sys.stderr)\n        return\n    print(\"\\nButton ready!\")\n    \n    while True:   \n        \n        if my_button.is_button_pressed() == True:\n            print(\"The button is pressed!\")\n\n        else:    \n            print(\"The button is not pressed!\")\n            \n        time.sleep(0.1)\n\nif __name__ == '__main__':\n    try:\n        run_example()\n    except (KeyboardInterrupt, SystemExit) as exErr:\n        print(\"\\nEnding Example 1\")\n        sys.exit(0)\n\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_button_py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsparkfun%2Fqwiic_button_py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkfun%2Fqwiic_button_py/lists"}