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

LEDEffect-Chase

A simple LED effect where one color chases another across the keyboard and back, over and over again. Playful colors they are.

Using the extension

To use the plugin, include the header, and tell the firmware to use it:

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

KALEIDOSCOPE_INIT_PLUGINS(LEDControl,
                          LEDEffect-Chase);

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

Plugin methods

The plugin provides the LEDChaseEffect object, which has the following methods outside of those provided by all LED modes:

`.update_delay([delay])`

Accessor for the update delay, the time between each step of the animation. When called without an argument, returns the current setting. When called with one, sets it.

Defaults to 150 (milliseconds).

`.distance([pixels])`

Accessor for the distance between the two pixels. When called without an argument, returns the current setting. When called with one, sets it.

Defaults to 5.

Dependencies

Kaleidoscope-LEDControl