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-Chase/README.md

45 lines
1.1 KiB

# 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:
```c++
#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](Kaleidoscope-LEDControl.md)