User created animations for BiblioPixel
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

BiblioPixelAnimations

User created animations for BiblioPixel.

Installation

To install or upgrade the repository, just run the following command:

pip install BiblioPixelAnimations --upgrade

This will clone the latest code from GitHub and install it to your python path.

Using Animations

A simple example of how to use the animations in this repo.

from bibliopixel.drivers.serial_driver import *
from bibliopixel import LEDStrip
#import the module you'd like to use
from BiblioPixelAnimations.strip import Rainbows

#init driver with the type and count of LEDs you're using
driver = DriverSerial(type=LEDTYPE.WS2812B, num=10)

#init controller
led = LEDStrip(driver)

#init animation; replace with whichever animation you'd like to use
anim = Rainbows.RainbowCycle(led)

try:
    #run the animation
    anim.run()
except KeyboardInterrupt:
    #Ctrl+C will exit the animation and turn the LEDs offs
    led.all_off()
    led.update()

PixelWeb

For information on how to make your animation PixelWeb ready, checkout the PixelWeb wikie: https://github.com/ManiacalLabs/PixelWeb/wiki/Manifests

Submit

To submit, please post to our forum. We will add them to this repository as we have time. Or, if you would like to help, fork this repository, add your animation as a new file under /matrix or /strip and submit a pull request.

Please include author information in a comment block at the top of your file. By submitting, you agree to provide your animations under the included MIT license.

Style Guide

Please follow the PEP 8 Style Guide coding guidelines. Please upload one animtion per file unless multiple files are required and consider reusability by other developers.

##Modules##

If your animation is big enough to require multiple files please build this in to a standalone module and place it in it's own folder.