已封存

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.

移至檔案

wolfv6 d24705d0cb rename LED LEDInterface		2016-09-24 21:58:54 -06:00
doc	rename PortPCA9655E to Port_PCA9655E, and PortMCP23S17 to Port_MCP23S17	2016-09-24 21:03:08 -06:00
examples/keybrd_PCA9655E	update PCA9655E classes and keybrd_PCA9655E.ino	2016-09-24 17:02:20 -06:00
images	move Debug variables to static	2016-07-21 03:31:36 -06:00
src	rename LED LEDInterface	2016-09-24 21:58:54 -06:00
tutorials	rename LED LEDInterface	2016-09-24 21:58:54 -06:00
unit_tests	add refPortWrite.begin(strobeOn) to Scanner_IOE::begin(), update unit tests	2016-09-23 14:53:17 -06:00
CONTRIBUTING.md	add MCP23S17 port files	2016-08-31 20:29:59 -06:00
library.properties	document	2016-07-22 12:16:47 -06:00
LICENSE.txt	initial commit keybrd version 0.3.0	2016-05-09 08:05:08 -06:00
README.md	update split keyboard tutorials 4a 4b 4c and sketches	2016-09-21 20:29:40 -06:00

README.md

keybrd library for creating keyboard firmware

keybrd library is an open source library for creating custom-keyboard firmware. The keybrd library allows keyboard designers to develop and publish their firmware simply as possible.

keybrd library supports any keyboard configuration:

one-piece
split with shift registers
split with I/O expander
single-layer
multiple-layer
LED indicator lights

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 Teensy LC, Teensy 2.0, 74HC165 shift registers, and PCA9655E I/O expander. The resulting keyboard firmware is compatible with standard USB keyboard drivers.

The keybrd library is in Beta testing. The public API should not be considered stable.

Example minimal keybrd sketch

A minimal keybrd sketch is 40 lines of code for a 4-key keyboard. The sketch is small because the keybrd library takes care of the low-level details. It runs the breadboard keyboard in this picture.

Example complex keybrd sketch

keybrd_DH and its instantiation files contain about 800 lines of code. It emulates the DataHand keyboard. Its layout has 52 keys, 3 primary layers, 5 sub-layers, 2 matrices, 8 LEDs, and blinking LEDs.

keybrd_DH_library_developer_guide.md
mainSketch.ino
instantiations_scannersLEDs.h
instantiations_scancodes.h
instantiations_layercodes.h
instantiations_rows_L.h
instantiations_rows_R.h

Support

Guides and tutorials are provided.

keybrd tutorial_1 shows how to build a breadboard keyboard. The remaining keybrd tutorials show how to create custom keybrd firmware.

Please ask questions in keybrd firmware library thread if something is not clear.