LED Strip Controller

Library to control an LED strip from an Arduino.
All elements of this library are held under the LEDStripController namespace.

NOTE: This library uses EEPROM to store values between runs.
Currently 32 bits of EEPROM are used (addresses 0-31).
Currently there is no way to alter these addresses without modifying the library.

To access the final memory address at run time, use:

LEDStripController::Addrs::end

Dependencies

• FastLED - here
• SerialCommands - here
• LinkedList - here

Classes

• Controller
  • Contains various getters and setters to control which lighting functions and colors are used
• SerialController
  • Sub-class of Controller
  • Inherits all of the same methods to control lighting functions
  • Intercepts commands from a given stream and changes it's own state accordingly.
  • When constructing an object of this class, an object of the Stream class can be provided.
    • This object is what commands will be recieved through.
  • If no stream is provided, Serial will be used by default.
  • Commands for this class are shown here

Usage

To create a normal Controller object (with no serial attachment for commands), do the following:

LEDStripController::Controller ledCon;

Note: This Controller will not yet do anything, in the setup function you will need to:

• Create an array of leds using FastLED.
• Call the Controller.setLEDs method to provide this array of leds to the Controller.
• Add a Controller.mainloop call to the loop function (this is what applies the lighting to the leds).

An example of a program using this library is shown below.
I use this for my own bluetooth controlled led strip.

#include "<LEDStripController.h>"

#define LED_TYPE WS2812B
#define DATA_PIN 8
#define COLOR_ORDER GRB
#define NUM_LEDS 60

CRGB leds[NUM_LEDS];
LEDStripController::SerialController ledController;

void setup()
{
    Serial.begin(9600);
    FastLED.addLeds<LED_TYPE, DATA_PIN, COLOR_ORDER>(leds, NUM_LEDS);
    ledController.setLEDs(leds, NUM_LEDS);
}

void loop()
{
    ledController.mainloop();
}

Lighting functions

There are 13 lighting functions supplied with this library.

User defined color functions

• Use the colors defined by the user
• Will cycle between user defined colors

0. Single color fill - Fill the strip with a solid color
1. Alternate fill - Fill the strip with alternating colors based on the colors stored in memory
2. Single color fade - Fade the given color in and out
3. Single color wipe - Fills a single color from one end of the strip to the other
4. Single color wipe (center) - A variant of the previous function that fills from the center

Rainbow color functions

5. Rainbow fill - Fill the strip with a rainbow gradient
6. Rainbow wipe - Same as wipe function but with rainbow gradient
7. Rainbow shift - Shift the hue of the led strip constantly, creating a rainbow effect
8. Rainbow cycle - Cycle a rainbow gradient down the strip continuously

Random color functions

• These functions generate a random color, this color is changed after a certain number of frames

9. Random color fill - Fill's the strip with a random solid color
10. Random color fade - Fade a random color in and out
11. Random color wipe - Same as color wipe, but with a random color
12. Random color wipe (center) - Same as above

Adding your own lighting functions

You can add your own lighting functions to the Controller instance after creating it.
All lighting functions must be of the form shown below:

// This example function fills the LED strip with a single color
void func(Controller &C) {
    fill_solid(C.getLEDs(), C.getNumLEDs(), C.getColor());
}

You can then use the functions provided by FastLED and the Controller class to produce your own custom effects.
For examples of these functions, please take a look at Effects.h.

Color cycling

Colors are automatically cycled in the provided lighting functions.
This cycle runs automatically between the set minimum color index and maximum color index.

For example the following variables:

Variable	Value
Color 0	255, 0, 0
Color 1	0, 255, 0
Color 2	0, 0, 255
Minimum color index	0
Maximuim color index	2

Would result in a cycle of red, green, blue which repeats.
The speed of this animation is set by the FPS variable.

Commands

The following commands can be sent over the provided stream to alter the behaviour of SerialController.

• help/? - Returns URL of this page, where list of commands is provided
• toggle/t <state(0,1)> - Toggle the strip on or off
• bright/b <value(0-255)> - Set the brightness of the strip
• effect/e <value> - Set current lighting effect
• col/c <r(0-255)> <g(0-255)> <b(0-255)> <index(0-7)> - Color interaction CLI, has several forms:
  • c - Get the current color
  • c <index> - Get the color with the given index
  • c <r(0-255)> <g(0-255)> <b(0-255)> - Set the current color
  • c <r(0-255)> <g(0-255)> <b(0-255)> <index> - Set the color with the given index
• mincolor/mic <index(0-7)> - Set the current active colour to the index specified
• maxcolor/mac <index>(0-7) - Set final acitve color index
• fps <value(1-255)> - Set the target refresh rate. Used to control the speed of animation.