This repository includes keyboard and converter firmware projects built with
tmk_core keyboard library.
The latest source code is available here: http://github.com/tmk/tmk_keyboard
Some projects were moved from
orphan directory. Those might be removed in some future but you will be able to access them with
orphans tag. See https://github.com/tmk/tmk_keyboard/issues/173
core: flabbergast’s Chibios protocol was merged from https://github.com/flabbergast/tmk_keyboard/tree/chibios (@72b1668). See tmk_core/protocol/chibios/README.md. Chibios protocol supports Cortex-M such as STM32 and Kinetis.
Core library was separated to other branch
Makefile you need to set
TMK_DIR to indicate core library location now.
TMK_DIR = ../../tmk_core
You can find some keyboard specific projects under
GPLv2 or later. Some protocol files are under Modified BSD License.
Third party libraries like LUFA, PJRC and V-USB have their own license respectively.
To see help press
Magic key combination is
RShift in many projects, but
Power key on ADB converter.
Magic keybind can be vary on each project, check
config.h in project directory.
Following commands can be also executed with
Magic + key. In console mode
Magic keybind is not needed.
----- Command Help ----- c: enter console mode d: toggle debug enable x: toggle matrix debug k: toggle keyboard debug m: toggle mouse debug v: print device version & info t: print timer count s: print status e: print eeprom config n: toggle NKRO 0/F10: switch to Layer0 1/F1: switch to Layer1 2/F2: switch to Layer2 3/F3: switch to Layer3 4/F4: switch to Layer4 PScr: power down/remote wake-up Caps: Lock Keyboard(Child Proof) Paus: jump to bootloader
Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable. Note that you must use keys of Layer 0 as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
To avoid configuring accidentally additive salt key
KC_SPACE also needs to be pressed along with the following configuration keys. The salt key is configurable in
config.h. See tmk_core/common/bootmagic.h.
This feature makes it possible for you to use mechanical locking switch for
ScrollLock. To enable this feature define these macros in
config.h and use
KC_LSCR in keymap for locking key instead of normal
ync option tries to keep switch state consistent with keyboard LED state.
#define LOCKING_SUPPORT_ENABLE #define LOCKING_RESYNC_ENABLE
tmk_coreinto your repository using
tmk_keybaordor other project similar to yours
See these as examples.
hid_listen to see debug messages. You can use xprintf() to display debug info, see
You can learn a lot about keyboard firmware from these. See Other Projects other than TMK.