di0ib
/
keybrd
Watch 1
Star 0
Fork 0
Code Releases 7 Activity
keybrd library is an open source library for creating custom-keyboard firmware.
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.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
129 Commits
1 Branch
Tree: fbf4eda206
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'fbf4eda206'
${ noResults }
wolfv6 fbf4eda206 add PortMCP23S17::beginProtocol() 7 years ago
doc combined PortWrite_MCP23S17 and PortRead_MCP23S17 into Port_MCP23S17 7 years ago
examples/keybrd_PCA9655E update diagrams and tutorials: 0 1 2 3a 7 years ago
images move Debug variables to static 7 years ago
src add PortMCP23S17::beginProtocol() 7 years ago
tutorials add layers and LEDs to keybrd_5b_LED_on_IOE.ino 7 years ago
unit_tests add refPortWrite.begin(strobeOn) to Scanner_IOE::begin(), update unit tests 7 years ago
CONTRIBUTING.md add MCP23S17 port files 7 years ago
LICENSE.txt initial commit keybrd version 0.3.0 8 years ago
README.md update split keyboard tutorials 4a 4b 4c and sketches 7 years ago
library.properties document 7 years ago

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.

breadboard keyboard

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

hweller

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.