You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Selene Scriven
485366553f
|
7 years ago | |
---|---|---|
examples/LED-Wavepool | 7 years ago | |
src | 7 years ago | |
.gitignore | 7 years ago | |
.travis.yml | 7 years ago | |
COPYING | 7 years ago | |
Makefile | 7 years ago | |
README.md | 7 years ago | |
library.properties | 7 years ago |
README.md
Kaleidoscope-LED-Wavepool
The WavepoolEffect
plugin makes waves of light splash out from each keypress.
When idle, it will also simulate gentle rainfall on the keyboard.
Using the plugin
To use the plugin, one needs to include the header and select the effect.
#include <Kaleidoscope.h>
#include <Kaleidoscope-LED-Wavepool.h>
void setup (){
Kaleidoscope.use(&WavepoolEffect);
Kaleidoscope.setup();
WavepoolEffect.activate();
}
It is recommended to place the activation of the plugin (the USE_PLUGINS
call)
as early as possible, so the plugin can catch all relevant key presses.
Plugin methods
The plugin provides the WavepoolEffect
object, which has the following
properties:
Dependencies
Further reading
Starting from the example is the recommended way of getting started with the plugin.