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
Jesse Vincent c6886b09fb
Change cleanupDone to numlockUnsynced to better represent what it does
6 years ago
src Change cleanupDone to numlockUnsynced to better represent what it does 6 years ago
.travis.yml Add build infrastructure 8 years ago
CONTRIBUTING.md Add CONTRIBUTING.md 6 years ago
COPYING Relicense under GPLv3 (only), and add headers. 6 years ago
Makefile Update Makefile with OSX fixes and new paths 7 years ago
README.md Add documentation for recently added color properties 7 years ago
library.properties Renaming 7 years ago

README.md

Kaleidoscope-NumPad

This is a plugin for Kaleidoscope, that adds a NumPad-specific LED effect, along with a way to toggle to a numpad layer, and apply the effect.

Using the extension

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

#include "Kaleidoscope-NumPad.h"

KALEIDOSCOPE_INIT_PLUGINS(NumPad);

void setup() {
  Kaleidoscope.setup();

  NumPad.color = CRGB(0, 0, 160); // a blue color
  NumPad.lock_hue = 85; // green
}

Plugin methods

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

.color

This property sets the color that the NumPad keys are highlighted in.

The default is CRGB(160, 0, 0), a red color.

.lock_hue

This property sets the color hue that the NumLock LED breathes in.

The default is 170, a blue hue.