alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '33626a569f'
${ noResults }
Kaleidoscope/plugins/Kaleidoscope-LEDEffect-Breathe
History
Jesse Vincent 33626a569f
Move most plugin READMEs back into the plugins 		4 years ago
..
src Clean up toplevel header files so we can extra their short descriptions 4 years ago
README.md Move most plugin READMEs back into the plugins 4 years ago
library.properties Add generated 'author' lines to plugins based on Copyright statements. 4 years ago

README.md

LEDEffect-Breathe

Provides a breathing effect for the keyboard. Breathe in, breathe out.

Using the extension

To use the plugin, include the header, and tell the firmware to use it:

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

KALEIDOSCOPE_INIT_PLUGINS(LEDControl,
                          LEDBreatheEffect);

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

Plugin properties

The plugin provides the LEDBreatheEffect object, which has a single property:

.hue

The hue of the breathe effect.

Defaults to 170, a blue hue.

.saturation

The color saturation of the breathe effect.

Defaults to 255, the maximum.

Dependencies