Gergely Nagy
500973eaf9
|
8 years ago | |
---|---|---|
examples/LED-AlphaSquare | 8 years ago | |
src | 8 years ago | |
.gitignore | 8 years ago | |
.travis.yml | 8 years ago | |
COPYING | 8 years ago | |
Makefile | 8 years ago | |
README.md | 8 years ago | |
library.properties | 8 years ago |
README.md
Kaleidoscope-LED-AlphaSquare
An alphabet for your per-key LEDs, AlphaSquare
provides a way to display 4x4
"pixel" symbols on your keyboard. With this building block, one can build some
sweet animations, or just show off - the possibilities are almost endless!
Using the plugin
To use the plugin, one needs to include the header, and one way or another, call
the display
method.
#include <Kaleidoscope.h>
#include <Kaleidoscope-LED-AlphaSquare.h>
void setup() {
USE_PLUGINS(&AlphaSquare);
Kaleidoscope.setup();
AlphaSquare.display (Key_A);
}
Plugin methods
The plugin provides the AlphaSquare
object, which has the following methods
and properties:
.display(key)
.display(key, row, col)
.display(key, col)
.display(key, row, col, color)
Display the symbol for
key
at the given row or column, with pixels set to the specifiedcolor
. Ifrow
is omitted, the first row -0
is assumed. If the column is omitted too, then the third -2
- column is used by default. If thecolor
is omitted, the plugin will use the global.color
property.The plugin can display the English alphabet, and the numbers from 0 to 9.
.display(symbol)
.display(symbol, row, col)
.display(symbol, col)
.display(symbol, row, col, color)
Almost the same as the previous function, but instead of a key, it expects a 4x4 bitmap.
.clear(key)
, .clear(symbol)
.clear(key, col)
, .clear(symbol, col)
.clear(key, col, row)
, .clear(symbol, col, row)
Just like the
.display()
counterparts, except these clear the symbol, by turning the LED pixels it is made up from, off.
.color
The color to use to draw the pixels.
Defaults to { 0x80, 0x80, 0x80 }.
Plugin helpers
SYM4x4(...)
A helper macro, which can be used to set up custom bitmaps. It expects 16 values, a 4x4 square of zeroes and ones. Zeroes are transparent pixels, ones will be colored.
Extra symbols
There is a growing number of extra symbols available in the
kaleidoscope::alpha_square::symbols
namespace. Ok, growing may have been an
exaggeration, there is only one as of this writing:
Lambda
A lambda (
λ
) symbol.
Dependencies
Further reading
Starting from the example is the recommended way of getting started with the plugin.