|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 |
- 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.
- The resulting keyboard firmware is compatible with standard USB keyboard drivers.
-
- keybrd library can support any keyboard configuration:
- * one-piece
- * split with shift registers
- * 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 Teensy LC, Teensy 2.0, 74HC165 shift registers, and PCA9655E I/O expander.
-
- > The keybrd library is in Beta testing. The public API should not be considered stable.
-
- Example minimal keybrd sketch
- -----------------------------
- A [minimal keybrd sketch](/tutorials/keybrd_1_breadboard/keybrd_1_breadboard.ino)
- 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.
-
- <img src="tutorials/keybrd_1_breadboard/breadboard_keyboard_2x2.JPG" title="breadboard keyboard" alt="breadboard keyboard" style="height:290px;width:328px;">
-
- Example complex keybrd sketch
- -----------------------------
- keybrd_DH and its instantiation files contain about 800 lines of code.
- It emulates the DataHand keyboard.
- The layout has 52 keys, 4 layers, 6 sub-layers, 2 matrices, 8 LEDs, and blinking LEDs.
-
- [keybrd_DH_library_developer_guide.md](https://github.com/wolfv6/keybrd_DH/blob/master/doc/keybrd_DH_library_developer_guide.md)<br>
- [mainSketch.ino](https://github.com/wolfv6/keybrd_DH/blob/master/examples/keybrd_DH/mainSketch.cpp)<br>
- [instantiations_pins.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_pins.h)<br>
- [instantiations_scancodes.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_scancodes.h)<br>
- [instantiations_layercodes.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_layercodes.h)<br>
- [instantiations_rows_L.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_rows_L.h)<br>
- [instantiations_rows_R.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_rows_R.h)
-
- ![hweller](images/datahand.jpg "DataHand")
-
- Support
- -------
- [Guides](doc) and [tutorials](tutorials) are provided.
-
- keybrd tutorial_1 shows how to make a breadboard keyboard.
- The remaining [keybrd tutorials](tutorials) show how to create custom keybrd firmware.
-
- Please ask questions in [keybrd library for keyboard firmware](geekhack todo) thread if something is not clear.
|