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
Gergely Nagy 115c54ef14
README: Add a "Dependencies" section
8 years ago
examples/LED-ActiveModColor The Big Rename 8 years ago
src The Big Rename 8 years ago
.gitignore Test the plugin with Travis CI 8 years ago
.travis.yml Test the plugin with Travis CI 8 years ago
COPYING Initial import 8 years ago
README.md README: Add a "Dependencies" section 8 years ago
library.properties The Big Rename 8 years ago

README.md

Kaleidoscope-LED-ActiveModColor

status Build Status

With this plugin, any active modifier on the keyboard will have the LED under it highlighted. No matter how the modifier got activated (a key press, a macro, anything else), the coloring will apply.

Using the plugin

To use the plugin, one needs to include the header, and activate the effect. It is also possible to use a custom color instead of the white default.

#include <Kaleidoscope.h>
#include <Kaleidoscope-LED-ActiveModColor.h>

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

  Kaleidoscope.use (&ActiveModColorEffect, NULL);
  
  ActiveModColorEffect.configure ({0x00, 0xff, 0xff});
}

It is recommended to place the activation (the Kaleidoscope.use call) of the plugin last, so that it can reliably override any other plugins that may work with the LEDs, and apply the highlight over those.

Plugin methods

The plugin provides the ActiveModColorEffect object, which has the following method:

.configure(color)

Set the color to use for highlighting the modifiers. If unset, will use the default white color.

Dependencies

Further reading

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