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.
Kaleidoscope/plugins/Kaleidoscope-LEDEffect-Boot...
Michael Richters fd98ea2207
Rearrange plugin headers with `include-what-you-use`
3 years ago
..
src Rearrange plugin headers with `include-what-you-use` 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-BootAnimation

With this plugin enabled, the keyboard will play a little boot animation when starting up (this animation does not inhibit typing, you can still use the keyboard while the animation plays).

Using the plugin

To use the plugin, include the header, and tell Kaleidoscope to use the plugin:

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

KALEIDOSCOPE_INIT_PLUGINS(LEDControl,
                          BootAnimationEffect
                          LEDOff);

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

Plugin properties

The plugin provides the BootAnimationEffect object, with the following properties:

.timeout

This property specifies the timeout (in milliseconds) each step of the animation is displayed.

Defaults to 1000 ms, or one second.

.color

This property sets the color the animation is played with.

The default is a red color.

Dependencies