2 https://github.com/tmk/tmk_keyboard/blob/master/doc/keymap.md
5 See [doc/keycode.txt](https://github.com/tmk/tmk_keyboard/blob/master/doc/keycode.txt).
6 Keycodes are actually defined in [common/keycode.h](https://github.com/tmk/tmk_keyboard/blob/master/common/keycode.h).
9 Use keycode for Print Screen(`KC_PSCREEN` or `KC_PSCR`) instead of `KC_SYSREQ`. Key combination of 'Alt + Print Screen' is recognized as 'System request'.
11 See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and
12 - http://en.wikipedia.org/wiki/Magic_SysRq_key
13 - http://en.wikipedia.org/wiki/System_request
15 ## Power key doesn't work
16 Use `KC_PWR` instead of `KC_POWER` or vice versa.
17 - `KC_PWR` works with Windows and Linux, not with OSX.
18 - `KC_POWER` works with OSX and Linux, not with Windows.
20 http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264
23 Solves my personal 'the' problem. I often got 'the' or 'THe' wrongly instead of 'The'. Oneshot Shift mitgates this for me.
24 https://github.com/tmk/tmk_keyboard/issues/67
26 ## Modifier/Layer stuck
27 Modifier keys or layers can be stuck unless layer switching is configured properly.
28 For Modifier keys and layer actions you have to place `KC_TRANS` on same position of destination layer to unregister the modifier key or return to previous layer on release event.
30 - https://github.com/tmk/tmk_keyboard/blob/master/doc/keymap.md#31-momentary-switching
31 - http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604
32 - https://github.com/tmk/tmk_keyboard/issues/248
35 ## Mechanical Lock Switch Support
36 https://github.com/tmk/tmk_keyboard#mechanical-locking-support
38 This feature is for *mechanical lock switch* like this Alps one.
39 http://deskthority.net/wiki/Alps_SKCL_Lock
41 Using enabling this feature and using keycodes `LCAP`, `LNUM` or `LSCR` in keymap you can use physical locking CapsLock, NumLock or ScrollLock keys as you expected.
43 Old vintage mechanical keyboards occasionally have lock switches but modern ones don't have. ***You don't need this feature in most case and just use keycodes `CAPS`, `NLCK` and `SLCK`.***
46 ## Input special charactors other than ASCII like Cédille 'Ç'
47 NO UNIVERSAL METHOD TO INPUT THOSE WORKS OVER ALL SYSTEMS. You have to define **MACRO** in way specific to your OS or layout.
49 See this post for example **MACRO** code.
51 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p195620
53 On **Windows** you can use `AltGr` key or **Alt code**.
54 - http://en.wikipedia.org/wiki/AltGr_key
55 - http://en.wikipedia.org/wiki/Alt_code
57 On **Mac** OS defines `Option` key combinations.
58 - http://en.wikipedia.org/wiki/Option_key#Alternative_keyboard_input
60 On **Xorg** you can use `compose` key, instead.
61 - http://en.wikipedia.org/wiki/Compose_key
63 And see this for **Unicode** input.
64 - http://en.wikipedia.org/wiki/Unicode_input
70 Apple keyboard sends keycode for Fn unlike most of other keyboards.
71 I think you can send Apple Fn key using Apple venter specific Page 0xff00 and usage 0x0003. But you have to change HID Report Descriptor for this, of course.
73 https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/AppleHIDUsageTables.h
76 ## Media control keys in Mac OSX
77 #### KC_MNXT and KC_MPRV does not work on Mac
78 Use `KC_MFFD`(`KC_MEDIA_FAST_FORWARD`) and `KC_MRWD`(`KC_MEDIA_REWIND`) instead of `KC_MNXT` and `KC_MPRV`.
79 See https://github.com/tmk/tmk_keyboard/issues/195
82 ## Keys supported in Mac OSX?
83 You can know which keycodes are supported in OSX from this source code.
85 `usb_2_adb_keymap` array maps Keyboard/Keypad Page usages to ADB scancodes(OSX internal keycodes).
87 https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo_USB2ADB.c
89 And `IOHIDConsumer::dispatchConsumerEvent` handles Consumer page usages.
91 https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp
94 ## JIS keys in Mac OSX
95 Japanese JIS keyboard specific keys like `無変換(Muhenkan)`, `変換(Henkan)`, `ひらがな(hiragana)` are not recognized on OSX. You can use **Seil** to enable those keys, try following options.
97 * Enable NFER Key on PC keyboard
98 * Enable XFER Key on PC keyboard
99 * Enable KATAKANA Key on PC keyboard
101 https://pqrs.org/osx/karabiner/seil.html
104 ## RN-42 Bluetooth doesn't work with Karabiner
105 Karabiner - Keymapping tool on Mac OSX - ignores inputs from RN-42 module by default. You have to enable this option to make Karabiner working with your keyboard.
106 https://github.com/tekezo/Karabiner/issues/403#issuecomment-102559237
108 See these for the deail of this problem.
109 https://github.com/tmk/tmk_keyboard/issues/213
110 https://github.com/tekezo/Karabiner/issues/403
113 ## Esc and `~ on a key
114 https://github.com/p3lim/keyboard_firmware/commit/fd799c12b69a5ab5addd1d4c03380a1b8ef8e9dc
117 ## 32 Fn keys are not enough?
119 It uses 16 bit codes and has no limitation of 32 Fn at the expense of memory space. TMK keymap is actually is 8 bit codes as subset of the actionmap.
120 https://github.com/tmk/tmk_keyboard/issues?utf8=%E2%9C%93&q=is%3Aissue+actionmap
122 ### extension for modified keys
123 https://geekhack.org/index.php?topic=41989.msg1885526#msg1885526