You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kaleidoscope/README.md

1.8 KiB

Kaleidoscope-LEDEffect-Rainbow

status Build Status

Two colorful rainbow effects are implemented by this plugin: one where the rainbow waves through the keys, and another where the LEDs breathe though the colors of a rainbow. The difference is that in the first case, we have all the rainbow colors on display, and it waves through the keyboard. In the second case, we have only one color at a time, for the whole board, and the color cycles through the rainbow's palette.

Using the extension

To use the plugin, include the header, and tell the firmware to use either (or both!) of the effects:

#include <Kaleidoscope-LEDControl.h>
#include <Kaleidoscope-LEDEffect-Rainbow.h>

KALEIDOSCOPE_INIT_PLUGINS(LEDRainbowEffect, LEDRainbowWaveEffect);

void setup() {
  Kaleidoscope.setup();

  LEDRainbowEffect.brightness(150);
  LEDRainbowWaveEffect.brightness(150);
  LEDRainbowWaveEffect.delay(50);
}

Plugin methods

The plugin provides two objects: LEDRainbowEffect, and LEDRainbowWaveEffect, both of which provide methods to set the delay time (animation speed) and effect brightness, called delay and brightness respectively.

Dependencies