Firmware for the Keyboardio Model 01 and other keyboards with AVR or ARM MCUs.
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.
 
 
 
 
 
 
Go to file
Selene Scriven 6e5a10a1c3
Added 'idle_timeout' config option.
7 years ago
examples/LED-Wavepool updated README and example 7 years ago
src Added 'idle_timeout' config option. 7 years ago
.gitignore copied algernon's LED Stalker effect as a code base 7 years ago
.travis.yml copied algernon's LED Stalker effect as a code base 7 years ago
COPYING copied algernon's LED Stalker effect as a code base 7 years ago
Makefile copied algernon's LED Stalker effect as a code base 7 years ago
README.md Added 'idle_timeout' config option. 7 years ago
library.properties Oops, forgot to change the author/maintainer info. 7 years ago

README.md

Kaleidoscope-LED-Wavepool

status Build Status

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.idle_timeout = 5000;  // 5 seconds
  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:

.idle_timeout

When to keys are being pressed, light will periodically splash across the keyboard. This value sets the delay in ms before that starts.

To disable the idle animation entirely, set this to 0.

Default is 5000 (5 seconds).

Dependencies

Further reading

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