History

Gergely Nagy 0c6f608704 LEDPaletteTheme: Lift out a few helper methods To be able to set a theme from the firmware itself, we need a couple of helper methods. First, we need to be able to update the palette without using Focus, and we also need to be able to update a single LED without committing it. On top of that, we'll likely want to know if the theme is initialized. To this end, we introduce `updatePaletteColor()`, which updates an entry in the palette, but does not commit it, and `isThemeUninitialized()` which does as the name suggests: it checks if the palette and the theme slices are all uninitialized. We also change `updateColorIndexAtPosition()` to not commit. The single user of it was FingerPainter, and we update that to do an explicit commit after. Signed-off-by: Gergely Nagy <algernon@keyboard.io>		3 years ago
..
src	LEDPaletteTheme: Lift out a few helper methods	3 years ago
README.md	Cleanups for typos and broken links across the documentation	4 years ago
library.properties	More library tweaking to comply with arduino requirements	4 years ago

README.md

FingerPainter

The FingerPainter plugin provides an elaborate LED mode, in which one's able to paint with their fingers: when edit mode is toggled on, keys will - instead of performing their normal function - cycle through the global palette - as provided by the LED-Palette-Theme plugin -, one by one for each tap.

This allows us to edit the theme with the keyboard only, without any special software (except to toggle edit mode on and off).

Using the plugin

To use the plugin, just include the header, add it to the list of used plugins.

#include <Kaleidoscope.h>
#include <Kaleidoscope-LEDControl.h>
#include <Kaleidoscope-LED-Palette-Theme.h>
#include <Kaleidoscope-EEPROM-Settings.h>
#include <Kaleidoscope-FingerPainter.h>
#include <Kaleidoscope-FocusSerial.h>

KALEIDOSCOPE_INIT_PLUGINS(LEDControl,
                          EEPromSettings,
                          LEDPaletteTheme,
                          FingerPainter,
                          Focus);

void setup() {
  Kaleidoscope.setup();
}

Plugin methods

The plugin provides the FingerPainter object, which provides no public methods.

Focus commands

`fingerpainter.clear`

Clears the canvas, so that one can start a new painting.

`fingerpainter.toggle`

Toggles the painting mode on and off.