ArduCor: RGB LED Routines for Arduino

ArduCor is an arduino library that generates a set of lighting routines for arduino-based lighting arrays. It works for all arduinos except the ATtiny series and is compatible with Neopixels, Rainbowduinos, and standard RGB LEDs.

There are two types of samples for this project. The Simple Samples show how to use the ArduCor library with as few lines of code as possible. The Corluma Samples work with Corluma, an open source application that controls RGB LEDs from a computer or a mobile device.

<a name="toc"></a>Table of Contents

• Installation
• Library Usage
  • Single Color Routines
  • Multi Color Routines
• Arduino Library API (html) (pdf)
• Samples
  • Simple Samples
  • Corluma Samples
• Contributing
• License
• Version Notes

<a name="installation"></a>Installation

1. Download the git repository
2. Copy the ArduCor directory into your Arduino Libraries directory.
3. Choose the proper sample for your hardware setup from the samples folder.
4. Build and upload to your board.

If there are compilation issues, make sure you have the library for your hardware setup installed. For a Rainbowduino, you can find the library here. For a NeoPixel, you can find the library here.

<a name="library-usage"></a>Library Usage

<a name="single-routines"></a>Single Color Routines

These routines use a single color:

• Single Solid
• Single Blink
• Single Wave
• Single Glimmer
• Single Fade
  • in and out, linear or sine
• Single Sawtooth Fade
  • in or out

<a name="multi-routines"></a>Multi Colors Routines

These routines use groups of colors saved in an array to execute the routine. This can be a custom group of colors or it can come from a preset palette of colors. All routines have a parameter used to determine the color group for the routine. A description of the different palettes is here.

• Multi Glimmer
• Multi Random Individual
• Multi Random Solid
• Multi Fade
• Multi Bars

<a name="contributing"></a>Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request.

<a name="license"></a>License

MIT License, provided here.