2016-05-09 20:08:23 +00:00
|
|
|
keybrd library for creating keyboard firmware
|
2016-05-09 14:05:08 +00:00
|
|
|
====================================================
|
|
|
|
|
keybrd library is an open source library for creating custom-keyboard firmware.
|
|
|
|
|
The resulting keyboard firmware is compatible with standard USB keyboard drivers.
|
|
|
|
|
|
|
|
|
|
keybrd library can support any keyboard configuration:
|
|
|
|
|
* one-piece
|
|
|
|
|
* split with I/O expander
|
|
|
|
|
* single-layer
|
|
|
|
|
* multiple-layer
|
|
|
|
|
|
|
|
|
|
Multiple-layer keyboards can write symbols without using the shift key:
|
|
|
|
|
|
|
|
|
|
~ ! @ # $ % ^ & * () _ {} | < > : ?
|
|
|
|
|
|
|
|
|
|
keybrd library leverages the Arduino environment to create keyboard firmware.
|
|
|
|
|
The Arduino development environment is free, and easy for novice programmers to setup and learn.
|
|
|
|
|
|
|
|
|
|
The keybrd library has been tested on the Teensy 2.0 microcontroller, MCP23018 I/O expander, and PCA9655E I/O expander.
|
|
|
|
|
|
|
|
|
|
> The public API should not be considered stable.
|
|
|
|
|
> Currently the keybrd library is limited to 8x8 matrices, which is enough for compact split keyboards.
|
|
|
|
|
|
|
|
|
|
Example minimal keybrd sketch
|
|
|
|
|
-----------------------------
|
2016-05-09 19:41:29 +00:00
|
|
|
<!-- todo after teensy LC bb, copy and remove annotations from keybrd_single-layer_2_annotated.ino -->
|
2016-05-09 20:14:15 +00:00
|
|
|
A [minimal keybrd sketch](tutorials/keybrd_2_single-layer_annotated/keybrd_2_single-layer_annotated.ino).
|
|
|
|
|
has about 50 lines of code and runs on a 4-key keyboard.
|
2016-05-09 20:41:50 +00:00
|
|
|
It runs on a breadboard and has rows, columns, and diodes just like the big keyboards.
|
2016-05-09 14:05:08 +00:00
|
|
|
The sketch is small because the keybrd library takes care of the low-level details.
|
|
|
|
|
|
|
|
|
|
The keybrd tutorial 1 shows how to make a breadboard keyboard.
|
2016-05-11 18:46:53 +00:00
|
|
|
The remaining [keybrd tutorials](tutorials) show how to create custom keybrd firmware.
|
2016-05-09 14:05:08 +00:00
|
|
|
|
|
|
|
|
Example complex keybrd sketch
|
|
|
|
|
-----------------------------
|
2016-05-09 19:41:29 +00:00
|
|
|
The keybrd_DH emulates the DataHand keyboard.
|
2016-05-30 03:23:33 +00:00
|
|
|
It has 72 keys, 4 layers, 6 sub-layers, 2 matrices, 8 LEDs, and blinking LEDs.
|
2016-05-09 20:08:23 +00:00
|
|
|
The keybrd_DH and its instantiation files contain about 800 lines of code.
|
2016-05-09 19:41:29 +00:00
|
|
|
|
2016-05-09 20:59:49 +00:00
|
|
|
[mainSketch.ino](https://github.com/wolfv6/keybrd_DH/blob/master/examples/keybrd_DH/mainSketch.cpp)<br>
|
|
|
|
|
[instantiations_ports.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_ports.h)<br>
|
|
|
|
|
[instantiations_LEDs.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_LEDs.h)<br>
|
|
|
|
|
[instantiations_codes.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_codes.h)<br>
|
|
|
|
|
[instantiations_matrix.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_matrix.h)
|
2016-05-09 14:05:08 +00:00
|
|
|
|
|
|
|
|
Support
|
|
|
|
|
-------
|
2016-05-09 20:08:23 +00:00
|
|
|
[Guides](doc) and [tutorials](tutorials) are provided.
|
2016-05-09 14:05:08 +00:00
|
|
|
Please ask a questions in [issues](https://github.com/wolfv6/Keybrd/issues) if something is not clear.
|
