CircuitPython helper for LED colors and animations.
Project description
Introduction
Perform a variety of LED animation tasks
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-led-animationTo install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-led-animationTo 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-led-animationUsage Example
import board
import neopixel
from adafruit_led_animation.animation.blink import Blink
import adafruit_led_animation.color as color
# Works on Circuit Playground Express and Bluefruit.
# For other boards, change board.NEOPIXEL to match the pin to which the NeoPixels are attached.
pixel_pin = board.NEOPIXEL
# Change to match the number of pixels you have attached to your board.
num_pixels = 10
pixels = neopixel.NeoPixel(pixel_pin, num_pixels)
blink = Blink(pixels, 0.5, color.PURPLE)
while True:
blink.animate()Documentation
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.
Building locally
Zip release files
To build this library locally you’ll need to install the circuitpython-build-tools package.
python3 -m venv .venv
source .venv/bin/activate
pip install circuitpython-build-toolsOnce installed, make sure you are in the virtual environment:
source .venv/bin/activateThen run the build:
circuitpython-build-bundles --filename_prefix circuitpython-led_animation --library_location .Sphinx documentation
Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):
python3 -m venv .venv
source .venv/bin/activate
pip install Sphinx sphinx-rtd-themeNow, once you have the virtual environment activated:
cd docs
sphinx-build -E -W -b html . _build/htmlThis will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.
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-led-animation-2.6.2.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-led-animation-2.6.2.tar.gz
- Upload date:
- Size: 45.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 14b0b4cadcfbba9b51901f4df8ae78fa4bb0ab5a8a0683e374dafae472249a86 |
|
| MD5 | ecb5166b89ca86c0956badede4c8b698 |
|
| BLAKE2b-256 | d8776f05ae4a4e574269ebf26484edee7b3ef80990487d0bf5bd7ac5f6d8b5a5 |
File details
Details for the file adafruit_circuitpython_led_animation-2.6.2-py3-none-any.whl.
File metadata
- Download URL: adafruit_circuitpython_led_animation-2.6.2-py3-none-any.whl
- Upload date:
- Size: 35.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 65c86ea5cae27526bf75e8cc35f9ed5401eab48a83e7ba5a7141d0566481be57 |
|
| MD5 | ff9c94d68323bad85fcf2b452cc80353 |
|
| BLAKE2b-256 | 2b8e8b4e7eed3ad222b06f985708a98873b3ffc15e1fbf927e04055e8a825633 |
