Kaleidoscope/README.md

Kaleidoscope-LED-ActiveModColor

With this plugin, any active modifier on the keyboard will have the LED under it highlighted. No matter how the modifier got activated (a key press, a macro, anything else), the coloring will apply.

Using the plugin

To use the plugin, one needs to include the header, and activate the effect. It is also possible to use a custom color instead of the white default.

#include <Kaleidoscope.h>
#include <Kaleidoscope-LED-ActiveModColor.h>

void setup () {
  USE_PLUGINS(&ActiveModColorEffect);
  
  Kaleidoscope.setup ();
  
  ActiveModColorEffect.highlight_color = CRGB(0x00, 0xff, 0xff);
}

It is recommended to place the activation (the USE_PLUGINS call) of the plugin last, so that it can reliably override any other plugins that may work with the LEDs, and apply the highlight over those.

Plugin methods

The plugin provides the ActiveModColorEffect object, which has the following method:

.highlight_color

The color to use for highlighting the modifiers. Defaults to a white color.

Not strictly a method, it is a variable one can assign a new value to.

Dependencies

• Kaleidoscope-LEDControl
• Kaleidoscope-Ranges

Further reading

Starting from the example is the recommended way of getting started with the plugin.