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

39 lines
1.3 KiB

# Kaleidoscope-LEDEffect-Chase
![status][st:stable] [![Build Status][travis:image]][travis:status]
[travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-LEDEffect-Chase.svg?branch=master
[travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-LEDEffect-Chase
[st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52
[st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52
[st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52
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 no public methods or
properties, outside of those provided by all LED modes.
## Dependencies
* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl)