History

Michael Richters cf5c19dd6c Standardize namespace block closing comments This standardizes namespace closing brackets for namespace blocks. Each one is on its own line, with a comment clearly marking which namespace it closes. Consecutive lines closing namespace blocks have no whitespace between them, but there is one blank line before and after a set of namespace block closing lines. To generate the namespace comments, I used clang-format, with `FixNamespaceComments: true`. But since clang-format can't exactly duplicate our astyle formatting, it made lots of other changes, too. To isolate the namespace comments from the other formatting changes, I first ran clang-format with `FixNamespaceComments: false`, committed those changes, then ran it again to generate the namespace comments. Then I stashed the namespace comments, reset `HEAD` to remove the other changes, applied the stashed namespace comments, and committed the results (after examining them and making a few minor adjustments by hand). Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>		3 years ago
..
src	Standardize namespace block closing comments	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.