This is a keyboard firmware with some useful features for Atmel AVR controller.
Source code is available here: http://github.com/tmk/tmk_keyboard
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 core
. https://github.com/tmk/tmk_keyboard/tree/core
In Makefile
you need to set TMK_DIR
to indicate core library location now.
TMK_DIR = ../../tmk_core
These features can be used in your keyboard.
You can find some keyboard specific projects under converter
and keyboard
directory.
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
+ H
.
Magic
key combination is LShift
+ RShift
in many project, 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.
ESC
)Backspace
)B
)D
)D
+X
)D
+K
)D
+M
)Left Control
)Caps Lock
)Left Alt
)Right Alt
)Left Gui
)Grave
)Back Slash
)N
)0
)1
)2
)3
)4
)5
)6
)7
)This feature makes it possible for you to use mechanical locking switch for CapsLock
, NumLock
or ScrollLock
. To enable this feature define these macros in config.h
and use KC_LCAP
, KC_LN UM
or KC_LSCR
in keymap for locking key instead of normal KC_CAPS
, KC_NLCK
or KC_SLCK
. Res
ync option tries to keep switch state consistent with keyboard LED state.
#define LOCKING_SUPPORT_ENABLE
#define LOCKING_RESYNC_ENABLE
TBD
Use PJRC's hid_listen
to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
You can use xprintf() to display debug info on hid_listen
, see tmk_core/common/xprintf.h
.
You can learn a lot about keyboard firmware from these. See Other Projects other than TMK.