Kaleidoscope/README.md

Kaleidoscope-EEPROM-Colormap

The EEPROM-ColorMap extension provides an easier way to set up a different - static - color map per-layer. This means that we can set up a map of colors for each key, on a per-layer basis, and whenever a layer becomes active, the color map for that layer is applied on top of everything else. The extension supports transparent colors, to make things easier.

Both the palette and the color map is stored in EEPROM, and the palette is limited to 15 colors (with the 16th being the transparent color). The plugin can work together with the Focus plugin, to make it easier to update the palette or the color map itself.

Using the extension

To use the extension, include the header, tell it the number of layers you have, and it will do the rest.

#include <Kaleidoscope.h>
#include <Kaleidoscope-EEPROM-Colormap.h>
#include <Kaleidoscope-Focus.h>


void setup (void) {

  Kaleidoscope.setup ();
  USE_PLUGINS (&EEPROMColormapEffect, &Focus);
  
  EEPROMColormapEffect.configure (1);
  Focus.addHook (FOCUS_HOOK_COLORMAP);
}

Extension methods

The extension provides an EEPROMColormapEffect singleton object, with a single method:

.configure(maxLayers)

Tells the extension to reserve space in EEPROM for up to maxLayers layers.

Dependencies

• Kaleidoscope-EEPROM-Settings
• Kaleidoscope-Focus

Further reading

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