di0ib/keybrd
Archived
1
0
Fork 0
Code Releases Activity
keybrd library is an open source library for creating custom-keyboard firmware.
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
2 Commits 1 Branch 7 Tags 12 MiB
C++ 93.3%
C 6.7%
c6b7cd1a16
Go to file
wolfv6 c6b7cd1a16 document
2016-05-09 13:41:29 -06:00
doc document 2016-05-09 13:41:29 -06:00
examples/keybrd_mapping_bb document 2016-05-09 13:41:29 -06:00
src initial commit keybrd version 0.3.0 2016-05-09 08:05:08 -06:00
tutorials initial commit keybrd version 0.3.0 2016-05-09 08:05:08 -06:00
library.properties initial commit keybrd version 0.3.0 2016-05-09 08:05:08 -06:00
LICENSE.txt initial commit keybrd version 0.3.0 2016-05-09 08:05:08 -06:00
README.md document 2016-05-09 13:41:29 -06:00

README.md

keybrd library for creating custom-keyboard firmware

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

Here is a minimal keybrd sketch. The sketch has about 50 lines of code and runs on a 4-key keyboard. It runs on a breadboard with rows, columns, and diodes just like the big keyboards. 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. The keybrd tutorials 2, 3, and 4 show how to create custom keybrd firmware.

Example complex keybrd sketch

The keybrd_DH emulates the DataHand keyboard. It has 72 keys, 4 layers, a sub-layers, 2 matrices, and is loaded with features. The keybrd_DH and its instantiation files, contain about 800 lines of code.

[mainSketch.ino](../keybrd_DH/blob/master/examples/keybrd_DH/mainSketch.cpp)
[instantiations_ports.h](../keybrd_DH/tree/master/src/instantiations_ports.h)
[instantiations_LEDs.h](../keybrd_DH/tree/master/src/instantiations_LEDs.h)
[instantiations_codes.h](../keybrd_DH/tree/master/src/instantiations_codes.h)
[instantiations_matrix.h](../keybrd_DH/tree/master/src/instantiations_matrix.h)

Support

Guides and tutorials are provided. Please ask a questions in issues if something is not clear.