https://github.com/sparkfun/qwiic_led_stick_py
https://github.com/sparkfun/qwiic_led_stick_py
circuitpython micropython python sparkfun sparkfun-python
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/sparkfun/qwiic_led_stick_py
- Owner: sparkfun
- License: mit
- Created: 2021-06-22T15:44:57.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-19T19:33:29.000Z (about 1 year ago)
- Last Synced: 2025-03-28T09:36:23.205Z (about 1 year ago)
- Topics: circuitpython, micropython, python, sparkfun, sparkfun-python
- Language: Python
- Homepage: http://docs.sparkfun.com/qwiic_led_stick_py/
- Size: 6.16 MB
- Stars: 2
- Watchers: 8
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SparkFun Qwiic LED Stick - Python Package
[](https://docs.sparkfun.com/qwiic_led_stick_py/classqwiic__led__stick_1_1_qwiic_l_e_d_stick.html)
The SparkFun Qwiic LED Stick LED_STICK Module provides a simple and cost effective solution for adding LED Stick 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.
This repository implements a Python package for the SparkFun Qwiic LED_STICK. This package works with Python, MicroPython and CircuitPython.
### Contents
* [About](#about-the-package)
* [Installation](#installation)
* [Supported Platforms](#supported-platforms)
* [Documentation](https://docs.sparkfun.com/qwiic_led_stick_py/classqwiic__led__stick_1_1_qwiic_l_e_d_stick.html)
* [Examples](#example-use)
## About the Package
This python package enables the user to access the features of the LED_STICK via a single Qwiic cable. This includes blinking LEDs, setting brightness, setting color and more. The capabilities of the LED_STICK are each demonstrated in the included examples.
New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
### Supported SparkFun Products
This Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
* [SparkFun Qwiic LED Stick](https://www.sparkfun.com/products/18354)
### Supported Platforms
| Python | Platform | Boards |
|--|--|--|
| 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) |
| 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)
|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)
> [!NOTE]
> 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.
## Installation
The 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.
### Python
#### PyPi Installation
The package is primarily installed using the `pip3` command, downloading the package from the Python Index - "PyPi".
Note - the below instructions outline installation on a Linux-based (Raspberry Pi) system.
First, setup a virtual environment from a specific directory using venv:
```sh
python3 -m venv path/to/venv
```
You 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).
Next, install the qwiic package with:
```sh
path/to/venv/bin/pip3 install sparkfun-qwiic-led_stick
```
Now you should be able to run any example or custom python scripts that have `import qwiic_led_stick` by running e.g.:
```sh
path/to/venv/bin/python3 example_script.py
```
### MicroPython Installation
If not already installed, follow the [instructions here](https://docs.micropython.org/en/latest/reference/mpremote.html) to install mpremote on your computer.
Connect a device with MicroPython installed to your computer and then install the package directly to your device with mpremote mip.
```sh
mpremote mip install github:sparkfun/qwiic_led_stick_py
```
If you would also like to install the examples for this repository, issue the following mip command as well:
```sh
mpremote mip install --target "" github:sparkfun/qwiic_led_stick_py@examples
```
### CircuitPython Installation
If not already installed, follow the [instructions here](https://docs.circuitpython.org/projects/circup/en/latest/#installation) to install CircUp on your computer.
Ensure that you have the latest version of the SparkFun Qwiic CircuitPython bundle.
```sh
circup bundle-add sparkfun/Qwiic_Py
```
Finally, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.
```sh
circup install --py qwiic_led_stick
```
If 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)
```sh
circup example qwiic_led_stick\qwiic_led_stick_ex10_change_address
circup example qwiic_led_stick\qwiic_led_stick_ex11_2_led_sticks
circup example qwiic_led_stick\qwiic_led_stick_ex1_blink
circup example qwiic_led_stick\qwiic_led_stick_ex2_single_pixel
circup example qwiic_led_stick\qwiic_led_stick_ex3_single_pixel2
circup example qwiic_led_stick\qwiic_led_stick_ex4_set_brightness
circup example qwiic_led_stick\qwiic_led_stick_ex5_binary_counter
circup example qwiic_led_stick\qwiic_led_stick_ex6_color_gradient
circup example qwiic_led_stick\qwiic_led_stick_ex7_cycle_rainbow
circup example qwiic_led_stick\qwiic_led_stick_ex8_walking_rainbow
circup example qwiic_led_stick\qwiic_led_stick_ex9_change_length
```
Example Use
---------------
Below is a quickstart program to print readings from the LED_STICK.
See the examples directory for more detailed use examples and [examples/README.md](https://github.com/sparkfun/qwiic_led_stick_py/blob/main/examples/README.md) for a summary of the available examples.
```python
import qwiic_led_stick
import time
import sys
def run_example():
print("\nSparkFun Qwiic LED Stick Example 1")
my_stick = qwiic_led_stick.QwiicLEDStick()
if my_stick.begin() == False:
print("\nThe Qwiic LED Stick isn't connected to the sytsem. Please check your connection", \
file=sys.stderr)
return
print("\nLED Stick ready!")
my_stick.set_all_LED_brightness(15)
while True:
my_stick.set_all_LED_color(50, 50, 50)
time.sleep(1)
my_stick.LED_off()
time.sleep(1)
if __name__ == '__main__':
try:
run_example()
except (KeyboardInterrupt, SystemExit) as exErr:
print("\nEnding Example 1")
sys.exit(0)
```
