forked from mirrors/qmk_firmware
restructure keycode docs
This commit is contained in:
Jack Humbert
parent
40d82906cb
commit
d5244c6cf4
4 changed files with 466 additions and 215 deletions
|
|
@ -9,6 +9,8 @@
|
|||
* [Keymap overview](keymap.md)
|
||||
* [Custom Quantum Functions](custom_quantum_functions.md)
|
||||
* [Keycodes](keycodes.md)
|
||||
* [Basic Keycodes](basic_keycodes.md)
|
||||
* [Quantum Keycodes](quantum_keycodes.md)
|
||||
* [Layer switching](key_functions.md)
|
||||
* [Leader Key](leader_key.md)
|
||||
* [Macros](macros.md)
|
||||
|
|
|
|||
186
docs/basic_keycodes.md
Normal file
186
docs/basic_keycodes.md
Normal file
|
|
@ -0,0 +1,186 @@
|
|||
# Basic keycodes
|
||||
|
||||
## Letters and Numbers
|
||||
|
||||
|KC_1|KC_2|KC_3|KC_4|KC_5|KC_6|KC_7|KC_8|
|
||||
|----|----|----|----|----|----|----|----|
|
||||
|KC_9|KC_0|KC_F1|KC_F2|KC_F3|KC_F4|KC_F5|KC_F6|
|
||||
|KC_F7|KC_F8|KC_F9|KC_F10|KC_F11|KC_F12|KC_F13|KC_F14|
|
||||
|KC_F15|KC_F16|KC_F17|KC_F18|KC_F19|KC_F20|KC_F21|KC_F22|
|
||||
|KC_F23|KC_F24|KC_A|KC_B|KC_C|KC_D|KC_E|KC_F|
|
||||
|KC_G|KC_H|KC_I|KC_J|KC_K|KC_L|KC_M|KC_N|
|
||||
|KC_O|KC_P|KC_Q|KC_R|KC_S|KC_T|KC_U|KC_V|
|
||||
|KC_W|KC_X|KC_Y|KC_Z|||||
|
||||
|
||||
## Punctuation
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_ENTER|KC_ENT|`Return (ENTER)`|
|
||||
|KC_ESCAPE|KC_ESC|`ESCAPE`|
|
||||
|KC_BSPACE|KC_BSPC|`DELETE (Backspace)`|
|
||||
|KC_TAB||`Tab`|
|
||||
|KC_SPACE|KC_SPC|Spacebar|
|
||||
|KC_MINUS|KC_MINS|`-` and `_`|
|
||||
|KC_EQUAL|KC_EQL|`=` and `+`|
|
||||
|KC_LBRACKET|KC_LBRC|`[` and `{`|
|
||||
|KC_RBRACKET|KC_RBRC|`]` and `}`|
|
||||
|KC_BSLASH|KC_BSLS|`\` and <code>|</code> |
|
||||
|KC_NONUS_HASH|KC_NUHS|Non-US `#` and `~`|
|
||||
|KC_NONUS_BSLASH|KC_NUBS|Non-US `\` and <code>|</code> |
|
||||
|KC_INT1|KC_RO|JIS `\` and <code>|</code> |
|
||||
|KC_INT2|KC_KANA|International216|
|
||||
|KC_INT3|KC_JYEN|Yen Symbol (`¥`)|
|
||||
|KC_SCOLON|KC_SCLN|`;` and `:`|
|
||||
|KC_QUOTE|KC_QUOT|`‘` and `“`|
|
||||
|KC_GRAVE|KC_GRV|Grave Accent and Tilde|
|
||||
|KC_COMMA|KC_COMM|`,` and `<`|
|
||||
|KC_DOT||`.` and `>`|
|
||||
|KC_SLASH|KC_SLSH|`/` and `?`|
|
||||
|KC_CAPSLOCK|KC_CAPS|Caps Lock|
|
||||
|
||||
## Modifiers
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_LCTRL|KC_LCTL|LeftControl|
|
||||
|KC_LSHIFT|KC_LSFT|LeftShift|
|
||||
|KC_LALT||LeftAlt|
|
||||
|KC_LGUI||Left GUI(Windows/Apple/Meta key)|
|
||||
|KC_RCTRL|KC_RCTL|RightControl|
|
||||
|KC_RSHIFT|KC_RSFT|RightShift|
|
||||
|KC_RALT||RightAlt|
|
||||
|KC_RGUI||Right GUI(Windows/Apple/Meta key)|
|
||||
|KC_LOCKING_CAPS||Locking Caps Lock|
|
||||
|KC_LOCKING_NUM||Locking Num Lock|
|
||||
|KC_LOCKING_SCROLL||Locking Scroll Lock|
|
||||
|KC_INT4|KC_HENK|JIS Henken|
|
||||
|KC_INT5|KC_MHEN|JIS Muhenken|
|
||||
|
||||
## Commands
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_PSCREEN|KC_PSCR|PrintScreen|
|
||||
|KC_SCROLLLOCK|KC_SLCK|Scroll Lock|
|
||||
|KC_PAUSE|KC_PAUS|Pause|
|
||||
|KC_INSERT|KC_INS|Insert|
|
||||
|KC_HOME||Home|
|
||||
|KC_PGUP||PageUp|
|
||||
|KC_DELETE|KC_DEL|Delete Forward|
|
||||
|KC_END||End|
|
||||
|KC_PGDOWN|KC_PGDN|PageDown|
|
||||
|KC_RIGHT|KC_RGHT|RightArrow|
|
||||
|KC_LEFT||LeftArrow|
|
||||
|KC_DOWN||DownArrow|
|
||||
|KC_UP||UpArrow|
|
||||
|KC_APPLICATION|KC_APP|Application|
|
||||
|KC_POWER||Power|
|
||||
|KC_EXECUTE||Execute|
|
||||
|KC_HELP||Help|
|
||||
|KC_MENU||Menu|
|
||||
|KC_SELECT||Select|
|
||||
|KC_AGAIN||Again|
|
||||
|KC_UNDO||Undo|
|
||||
|KC_CUT||Cut|
|
||||
|KC_COPY||Copy|
|
||||
|KC_PASTE||Paste|
|
||||
|KC_FIND||Find|
|
||||
|KC_ALT_ERASE||Alternate Erase|
|
||||
|KC_SYSREQ||SysReq/Attention|
|
||||
|KC_CANCEL||Cancel|
|
||||
|KC_CLEAR||Clear|
|
||||
|KC_PRIOR||Prior|
|
||||
|KC_RETURN||Return|
|
||||
|KC_SEPARATOR||Separator|
|
||||
|KC_OUT||Out|
|
||||
|KC_OPER||Oper|
|
||||
|KC_CLEAR_AGAIN||Clear/Again|
|
||||
|KC_CRSEL||CrSel/Props|
|
||||
|KC_EXSEL||ExSel|
|
||||
|KC_SYSTEM_POWER|KC_PWR|System Power Down|
|
||||
|KC_SYSTEM_SLEEP|KC_SLEP|System Sleep|
|
||||
|KC_SYSTEM_WAKE|KC_WAKE|System Wake|
|
||||
|KC_MAIL|KC_MAIL||
|
||||
|KC_CALCULATOR|KC_CALC||
|
||||
|KC_MY_COMPUTER|KC_MYCM||
|
||||
|KC_WWW_SEARCH|KC_WSCH||
|
||||
|KC_WWW_HOME|KC_WHOM||
|
||||
|KC_WWW_BACK|KC_WBAK||
|
||||
|KC_WWW_FORWARD|KC_WFWD||
|
||||
|KC_WWW_STOP|KC_WSTP||
|
||||
|KC_WWW_REFRESH|KC_WREF||
|
||||
|KC_WWW_FAVORITES|KC_WFAV||
|
||||
|
||||
## Media Keys
|
||||
|
||||
Windows and Mac use different key codes for next track and previous track. Make sure you choose the keycode that corresponds to your OS.
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_STOP||Stop|
|
||||
|KC__MUTE||Mute|
|
||||
|KC__VOLUP||Volume Up|
|
||||
|KC__VOLDOWN||Volume Down|
|
||||
|KC_AUDIO_MUTE|KC_MUTE||
|
||||
|KC_AUDIO_VOL_UP|KC_VOLU||
|
||||
|KC_AUDIO_VOL_DOWN|KC_VOLD||
|
||||
|KC_MEDIA_NEXT_TRACK|KC_MNXT|Next Track (Windows)|
|
||||
|KC_MEDIA_PREV_TRACK|KC_MPRV|Previous Track (Windows)|
|
||||
|KC_MEDIA_FAST_FORWARD|KC_MFFD|Next Track (macOS)|
|
||||
|KC_MEDIA_REWIND|KC_MRWD|Previous Track (macOS)|
|
||||
|KC_MEDIA_STOP|KC_MSTP||
|
||||
|KC_MEDIA_PLAY_PAUSE|KC_MPLY||
|
||||
|KC_MEDIA_SELECT|KC_MSEL||
|
||||
|
||||
## Numpad
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_NUMLOCK|KC_NLCK|Keypad Num Lock and Clear|
|
||||
|KC_KP_SLASH|KC_PSLS|Keypad /|
|
||||
|KC_KP_ASTERISK|KC_PAST|Keypad *|
|
||||
|KC_KP_MINUS|KC_PMNS|Keypad -|
|
||||
|KC_KP_PLUS|KC_PPLS|Keypad +|
|
||||
|KC_KP_ENTER|KC_PENT|Keypad ENTER|
|
||||
|KC_KP_1|KC_P1|Keypad 1 and End|
|
||||
|KC_KP_2|KC_P2|Keypad 2 and Down Arrow|
|
||||
|KC_KP_3|KC_P3|Keypad 3 and PageDn|
|
||||
|KC_KP_4|KC_P4|Keypad 4 and Left Arrow|
|
||||
|KC_KP_5|KC_P5|Keypad 5|
|
||||
|KC_KP_6|KC_P6|Keypad 6 and Right Arrow|
|
||||
|KC_KP_7|KC_P7|Keypad 7 and Home|
|
||||
|KC_KP_8|KC_P8|Keypad 8 and Up Arrow|
|
||||
|KC_KP_9|KC_P9|Keypad 9 and PageUp|
|
||||
|KC_KP_0|KC_P0|Keypad 0 and Insert|
|
||||
|KC_KP_DOT|KC_PDOT|Keypad . and Delete|
|
||||
|KC_KP_EQUAL|KC_PEQL|Keypad =|
|
||||
|KC_KP_COMMA|KC_PCMM|Keypad Comma|
|
||||
|KC_KP_EQUAL_AS400||Keypad Equal Sign|
|
||||
|
||||
## Special Keys
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_NO||Ignore this key. (NOOP) |
|
||||
|
||||
## Mousekey
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_MS_UP|KC_MS_U|Mouse Cursor Up|
|
||||
|KC_MS_DOWN|KC_MS_D|Mouse Cursor Down|
|
||||
|KC_MS_LEFT|KC_MS_L|Mouse Cursor Left|
|
||||
|KC_MS_RIGHT|KC_MS_R|Mouse Cursor Right|
|
||||
|KC_MS_BTN1|KC_BTN1|Mouse Button 1|
|
||||
|KC_MS_BTN2|KC_BTN2|Mouse Button 2|
|
||||
|KC_MS_BTN3|KC_BTN3|Mouse Button 3|
|
||||
|KC_MS_BTN4|KC_BTN4|Mouse Button 4|
|
||||
|KC_MS_BTN5|KC_BTN5|Mouse Button 5|
|
||||
|KC_MS_WH_UP|KC_WH_U|Mouse Wheel Up|
|
||||
|KC_MS_WH_DOWN|KC_WH_D|Mouse Wheel Down|
|
||||
|KC_MS_WH_LEFT|KC_WH_L|Mouse Wheel Left|
|
||||
|KC_MS_WH_RIGHT|KC_WH_R|Mouse Wheel Right|
|
||||
|KC_MS_ACCEL0|KC_ACL0|Mouse Acceleration 0|
|
||||
|KC_MS_ACCEL1|KC_ACL1|Mouse Acceleration 1|
|
||||
|KC_MS_ACCEL2|KC_ACL2|Mouse Acceleration 2|
|
||||
219
docs/keycodes.md
219
docs/keycodes.md
|
|
@ -4,225 +4,14 @@ When defining a [keymap](keymap.md) each key needs a valid key definition.
|
|||
|
||||
This page documents the symbols that correspond to keycodes that are available to you in QMK.
|
||||
|
||||
To customize your board, they can be used by themselves or as **action codes** in combination with one of the [many C macros](https://github.com/qmk/qmk_firmware/wiki#c-macros-for-action-code).
|
||||
## Basic keycodes (`0x00` - `0xFF`)
|
||||
|
||||
The source of truth for these codes is [tmk_core/common/keycode.h](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/keycode.h) file in the qmk source code.
|
||||
|
||||
# The Keycodes
|
||||
|
||||
Keycodes in QMK are based on [HID Usage Keyboard/Keypad Page(0x07)](http://www.usb.org/developers/hidpage/Hut1_12v2.pdf) with following exceptions:
|
||||
[Basic keycodes](basic_keycodes.md) in QMK are based on [HID Usage Keyboard/Keypad Page(0x07)](http://www.usb.org/developers/hidpage/Hut1_12v2.pdf) with following exceptions:
|
||||
|
||||
* `KC_NO` = 0 for no action
|
||||
* `KC_TRNS` = 1 for layer transparency
|
||||
* internal special keycodes in the `0xA5-DF` range (tmk heritage).
|
||||
|
||||
## Letters and Numbers
|
||||
## Quantum keycodes (`0x0100` - `0xFFFF`)
|
||||
|
||||
|KC_1|KC_2|KC_3|KC_4|KC_5|KC_6|KC_7|KC_8|
|
||||
|----|----|----|----|----|----|----|----|
|
||||
|KC_9|KC_0|KC_F1|KC_F2|KC_F3|KC_F4|KC_F5|KC_F6|
|
||||
|KC_F7|KC_F8|KC_F9|KC_F10|KC_F11|KC_F12|KC_F13|KC_F14|
|
||||
|KC_F15|KC_F16|KC_F17|KC_F18|KC_F19|KC_F20|KC_F21|KC_F22|
|
||||
|KC_F23|KC_F24|KC_A|KC_B|KC_C|KC_D|KC_E|KC_F|
|
||||
|KC_G|KC_H|KC_I|KC_J|KC_K|KC_L|KC_M|KC_N|
|
||||
|KC_O|KC_P|KC_Q|KC_R|KC_S|KC_T|KC_U|KC_V|
|
||||
|KC_W|KC_X|KC_Y|KC_Z|||||
|
||||
|
||||
## Punctuation
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_ENTER|KC_ENT|`Return (ENTER)`|
|
||||
|KC_ESCAPE|KC_ESC|`ESCAPE`|
|
||||
|KC_BSPACE|KC_BSPC|`DELETE (Backspace)`|
|
||||
|KC_TAB||`Tab`|
|
||||
|KC_SPACE|KC_SPC|Spacebar|
|
||||
|KC_MINUS|KC_MINS|`-` and `_`|
|
||||
|KC_EQUAL|KC_EQL|`=` and `+`|
|
||||
|KC_LBRACKET|KC_LBRC|`[` and `{`|
|
||||
|KC_RBRACKET|KC_RBRC|`]` and `}`|
|
||||
|KC_BSLASH|KC_BSLS|`\` and <code>|</code> |
|
||||
|KC_NONUS_HASH|KC_NUHS|Non-US `#` and `~`|
|
||||
|KC_NONUS_BSLASH|KC_NUBS|Non-US `\` and <code>|</code> |
|
||||
|KC_INT1|KC_RO|JIS `\` and <code>|</code> |
|
||||
|KC_INT2|KC_KANA|International216|
|
||||
|KC_INT3|KC_JYEN|Yen Symbol (`¥`)|
|
||||
|KC_SCOLON|KC_SCLN|`;` and `:`|
|
||||
|KC_QUOTE|KC_QUOT|`‘` and `“`|
|
||||
|KC_GRAVE|KC_GRV|Grave Accent and Tilde|
|
||||
|KC_COMMA|KC_COMM|`,` and `<`|
|
||||
|KC_DOT||`.` and `>`|
|
||||
|KC_SLASH|KC_SLSH|`/` and `?`|
|
||||
|KC_CAPSLOCK|KC_CAPS|Caps Lock|
|
||||
|
||||
## Modifiers
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_LCTRL|KC_LCTL|LeftControl|
|
||||
|KC_LSHIFT|KC_LSFT|LeftShift|
|
||||
|KC_LALT||LeftAlt|
|
||||
|KC_LGUI||Left GUI(Windows/Apple/Meta key)|
|
||||
|KC_RCTRL|KC_RCTL|RightControl|
|
||||
|KC_RSHIFT|KC_RSFT|RightShift|
|
||||
|KC_RALT||RightAlt|
|
||||
|KC_RGUI||Right GUI(Windows/Apple/Meta key)|
|
||||
|KC_LOCKING_CAPS||Locking Caps Lock|
|
||||
|KC_LOCKING_NUM||Locking Num Lock|
|
||||
|KC_LOCKING_SCROLL||Locking Scroll Lock|
|
||||
|KC_INT4|KC_HENK|JIS Henken|
|
||||
|KC_INT5|KC_MHEN|JIS Muhenken|
|
||||
|
||||
## Commands
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_PSCREEN|KC_PSCR|PrintScreen|
|
||||
|KC_SCROLLLOCK|KC_SLCK|Scroll Lock|
|
||||
|KC_PAUSE|KC_PAUS|Pause|
|
||||
|KC_INSERT|KC_INS|Insert|
|
||||
|KC_HOME||Home|
|
||||
|KC_PGUP||PageUp|
|
||||
|KC_DELETE|KC_DEL|Delete Forward|
|
||||
|KC_END||End|
|
||||
|KC_PGDOWN|KC_PGDN|PageDown|
|
||||
|KC_RIGHT|KC_RGHT|RightArrow|
|
||||
|KC_LEFT||LeftArrow|
|
||||
|KC_DOWN||DownArrow|
|
||||
|KC_UP||UpArrow|
|
||||
|KC_APPLICATION|KC_APP|Application|
|
||||
|KC_POWER||Power|
|
||||
|KC_EXECUTE||Execute|
|
||||
|KC_HELP||Help|
|
||||
|KC_MENU||Menu|
|
||||
|KC_SELECT||Select|
|
||||
|KC_AGAIN||Again|
|
||||
|KC_UNDO||Undo|
|
||||
|KC_CUT||Cut|
|
||||
|KC_COPY||Copy|
|
||||
|KC_PASTE||Paste|
|
||||
|KC_FIND||Find|
|
||||
|KC_ALT_ERASE||Alternate Erase|
|
||||
|KC_SYSREQ||SysReq/Attention|
|
||||
|KC_CANCEL||Cancel|
|
||||
|KC_CLEAR||Clear|
|
||||
|KC_PRIOR||Prior|
|
||||
|KC_RETURN||Return|
|
||||
|KC_SEPARATOR||Separator|
|
||||
|KC_OUT||Out|
|
||||
|KC_OPER||Oper|
|
||||
|KC_CLEAR_AGAIN||Clear/Again|
|
||||
|KC_CRSEL||CrSel/Props|
|
||||
|KC_EXSEL||ExSel|
|
||||
|KC_SYSTEM_POWER|KC_PWR|System Power Down|
|
||||
|KC_SYSTEM_SLEEP|KC_SLEP|System Sleep|
|
||||
|KC_SYSTEM_WAKE|KC_WAKE|System Wake|
|
||||
|KC_MAIL|KC_MAIL||
|
||||
|KC_CALCULATOR|KC_CALC||
|
||||
|KC_MY_COMPUTER|KC_MYCM||
|
||||
|KC_WWW_SEARCH|KC_WSCH||
|
||||
|KC_WWW_HOME|KC_WHOM||
|
||||
|KC_WWW_BACK|KC_WBAK||
|
||||
|KC_WWW_FORWARD|KC_WFWD||
|
||||
|KC_WWW_STOP|KC_WSTP||
|
||||
|KC_WWW_REFRESH|KC_WREF||
|
||||
|KC_WWW_FAVORITES|KC_WFAV||
|
||||
|
||||
## Media Keys
|
||||
|
||||
Windows and Mac use different key codes for next track and previous track. Make sure you choose the keycode that corresponds to your OS.
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_STOP||Stop|
|
||||
|KC__MUTE||Mute|
|
||||
|KC__VOLUP||Volume Up|
|
||||
|KC__VOLDOWN||Volume Down|
|
||||
|KC_AUDIO_MUTE|KC_MUTE||
|
||||
|KC_AUDIO_VOL_UP|KC_VOLU||
|
||||
|KC_AUDIO_VOL_DOWN|KC_VOLD||
|
||||
|KC_MEDIA_NEXT_TRACK|KC_MNXT|Next Track (Windows)|
|
||||
|KC_MEDIA_PREV_TRACK|KC_MPRV|Previous Track (Windows)|
|
||||
|KC_MEDIA_FAST_FORWARD|KC_MFFD|Next Track (macOS)|
|
||||
|KC_MEDIA_REWIND|KC_MRWD|Previous Track (macOS)|
|
||||
|KC_MEDIA_STOP|KC_MSTP||
|
||||
|KC_MEDIA_PLAY_PAUSE|KC_MPLY||
|
||||
|KC_MEDIA_SELECT|KC_MSEL||
|
||||
|
||||
## Numpad
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_NUMLOCK|KC_NLCK|Keypad Num Lock and Clear|
|
||||
|KC_KP_SLASH|KC_PSLS|Keypad /|
|
||||
|KC_KP_ASTERISK|KC_PAST|Keypad *|
|
||||
|KC_KP_MINUS|KC_PMNS|Keypad -|
|
||||
|KC_KP_PLUS|KC_PPLS|Keypad +|
|
||||
|KC_KP_ENTER|KC_PENT|Keypad ENTER|
|
||||
|KC_KP_1|KC_P1|Keypad 1 and End|
|
||||
|KC_KP_2|KC_P2|Keypad 2 and Down Arrow|
|
||||
|KC_KP_3|KC_P3|Keypad 3 and PageDn|
|
||||
|KC_KP_4|KC_P4|Keypad 4 and Left Arrow|
|
||||
|KC_KP_5|KC_P5|Keypad 5|
|
||||
|KC_KP_6|KC_P6|Keypad 6 and Right Arrow|
|
||||
|KC_KP_7|KC_P7|Keypad 7 and Home|
|
||||
|KC_KP_8|KC_P8|Keypad 8 and Up Arrow|
|
||||
|KC_KP_9|KC_P9|Keypad 9 and PageUp|
|
||||
|KC_KP_0|KC_P0|Keypad 0 and Insert|
|
||||
|KC_KP_DOT|KC_PDOT|Keypad . and Delete|
|
||||
|KC_KP_EQUAL|KC_PEQL|Keypad =|
|
||||
|KC_KP_COMMA|KC_PCMM|Keypad Comma|
|
||||
|KC_KP_EQUAL_AS400||Keypad Equal Sign|
|
||||
|
||||
## Special Keys
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_NO||Ignore this key. (NOOP) |
|
||||
|
||||
## Mousekey
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|KC_MS_UP|KC_MS_U|Mouse Cursor Up|
|
||||
|KC_MS_DOWN|KC_MS_D|Mouse Cursor Down|
|
||||
|KC_MS_LEFT|KC_MS_L|Mouse Cursor Left|
|
||||
|KC_MS_RIGHT|KC_MS_R|Mouse Cursor Right|
|
||||
|KC_MS_BTN1|KC_BTN1|Mouse Button 1|
|
||||
|KC_MS_BTN2|KC_BTN2|Mouse Button 2|
|
||||
|KC_MS_BTN3|KC_BTN3|Mouse Button 3|
|
||||
|KC_MS_BTN4|KC_BTN4|Mouse Button 4|
|
||||
|KC_MS_BTN5|KC_BTN5|Mouse Button 5|
|
||||
|KC_MS_WH_UP|KC_WH_U|Mouse Wheel Up|
|
||||
|KC_MS_WH_DOWN|KC_WH_D|Mouse Wheel Down|
|
||||
|KC_MS_WH_LEFT|KC_WH_L|Mouse Wheel Left|
|
||||
|KC_MS_WH_RIGHT|KC_WH_R|Mouse Wheel Right|
|
||||
|KC_MS_ACCEL0|KC_ACL0|Mouse Acceleration 0|
|
||||
|KC_MS_ACCEL1|KC_ACL1|Mouse Acceleration 1|
|
||||
|KC_MS_ACCEL2|KC_ACL2|Mouse Acceleration 2|
|
||||
|
||||
## Magic Keys
|
||||
|
||||
The following keys can be used to turn on and off various "Magic" features. These include Boot Magic (holding certain keys down while plugging the keyboard in) and the Magic Key.
|
||||
|
||||
|Long Name|Short Name|Description|
|
||||
|---------|----------|-----------|
|
||||
|MAGIC_SWAP_CONTROL_CAPSLOCK||Swap Capslock and Control|
|
||||
|MAGIC_CAPSLOCK_TO_CONTROL||Change Capslock to Control|
|
||||
|MAGIC_SWAP_ALT_GUI||Swap ALT and GUI|
|
||||
|MAGIC_SWAP_LALT_LGUI||Swap LALT and LGUI|
|
||||
|MAGIC_SWAP_RALT_RGUI||Swap RALT and RGUI|
|
||||
|MAGIC_NO_GUI||Disable off the GUI key|
|
||||
|MAGIC_SWAP_GRAVE_ESC||Swap the GRAVE (~ `) and Esc keys|
|
||||
|MAGIC_SWAP_BACKSLASH_BACKSPACE||Swap Backslash and Backspace|
|
||||
|MAGIC_UNSWAP_CONTROL_CAPSLOCK||Disable the Control/Caps Swap|
|
||||
|MAGIC_UNCAPSLOCK_TO_CONTROL||Turn Capslock back into Capslock|
|
||||
|MAGIC_UNSWAP_ALT_GUI||Turn the ALT/GUI swap off|
|
||||
|MAGIC_UNSWAP_LALT_LGUI||Turn the LALT/LGUI swap off|
|
||||
|MAGIC_UNSWAP_RALT_RGUI||Turn the RALT/RGUI swap off|
|
||||
|MAGIC_UNNO_GUI||Enable the GUI key|
|
||||
|MAGIC_UNSWAP_GRAVE_ESC||Turn the GRAVE/ESC swap off|
|
||||
|MAGIC_UNSWAP_BACKSLASH_BACKSPACE||Turn the Backslash/Backspace swap off|
|
||||
|MAGIC_HOST_NKRO||Turn NKRO on|
|
||||
|MAGIC_UNHOST_NKRO||Turn NKRO off|
|
||||
|MAGIC_TOGGLE_NKRO||Toggle NKRO on or off|
|
||||
[Quantum keycodes](quantum_keycodes.md) allow for easier customisation of your keymap than the basic ones provide, without having to define custom actions.
|
||||
|
|
|
|||
274
docs/quantum_keycodes.md
Normal file
274
docs/quantum_keycodes.md
Normal file
|
|
@ -0,0 +1,274 @@
|
|||
# Quantum Keycodes
|
||||
|
||||
Something important to realise with keycodes is that they are all numbers between `0x0` and `0xFFFF` - even though they may look like functions, words, or phrases, they are all shortcuts to some number. This allows us to define all of what they do in different places, and store keymaps in a relatively small place (arrays). If you try to "call" a keycode by placing it somewhere besides a keymap, it may compile, but it won't do anything useful.
|
||||
|
||||
All keycodes on this page have a value above `0xFF` (values less are considered the [basic keycodes](basic_keycodes.md)) and won't work with any of the mod/layer-tap keys listed at the bottom.
|
||||
|
||||
* `SAFE_RANGE` is always the last keycode in the quantum list, and where custom lists can begin
|
||||
* `RESET` puts the keyboard into DFU mode for flashing
|
||||
* `DEBUG` toggles debug mode
|
||||
* Shortcuts for bootmagic options (work when bootmagic is off)
|
||||
* `MAGIC_SWAP_CONTROL_CAPSLOCK`
|
||||
* `MAGIC_CAPSLOCK_TO_CONTROL`
|
||||
* `MAGIC_SWAP_LALT_LGUI`
|
||||
* `MAGIC_SWAP_RALT_RGUI`
|
||||
* `MAGIC_NO_GUI`
|
||||
* `MAGIC_SWAP_GRAVE_ESC`
|
||||
* `MAGIC_SWAP_BACKSLASH_BACKSPACE`
|
||||
* `MAGIC_HOST_NKRO`
|
||||
* `MAGIC_SWAP_ALT_GUI`/`AG_SWAP`
|
||||
* `MAGIC_UNSWAP_CONTROL_CAPSLOCK`
|
||||
* `MAGIC_UNCAPSLOCK_TO_CONTROL`
|
||||
* `MAGIC_UNSWAP_LALT_LGUI`
|
||||
* `MAGIC_UNSWAP_RALT_RGUI`
|
||||
* `MAGIC_UNNO_GUI`
|
||||
* `MAGIC_UNSWAP_GRAVE_ESC`
|
||||
* `MAGIC_UNSWAP_BACKSLASH_BACKSPACE`
|
||||
* `MAGIC_UNHOST_NKRO`
|
||||
* `MAGIC_UNSWAP_ALT_GUI`/`AG_NORM`
|
||||
* `MAGIC_TOGGLE_NKRO`
|
||||
* `KC_GESC`/`GRAVE_ESC` acts as escape when pressed normally but when pressed with a mod will send a `~`
|
||||
* `KC_LSPO` left shift when held, open paranthesis when tapped
|
||||
* `KC_RSPC` right shift when held, close paranthesis when tapped
|
||||
* `KC_LEAD` the leader key
|
||||
|
||||
* `FUNC(n)`/`F(n)` to call `fn_action` n
|
||||
* `M(n)` to call macro n
|
||||
* `MACROTAP(n)` to macro-tap n idk FIXME
|
||||
|
||||
## Audio
|
||||
|
||||
```c
|
||||
#ifdef AUDIO_ENABLE
|
||||
AU_ON,
|
||||
AU_OFF,
|
||||
AU_TOG,
|
||||
|
||||
#ifdef FAUXCLICKY_ENABLE
|
||||
FC_ON,
|
||||
FC_OFF,
|
||||
FC_TOG,
|
||||
#endif
|
||||
|
||||
// Music mode on/off/toggle
|
||||
MU_ON,
|
||||
MU_OFF,
|
||||
MU_TOG,
|
||||
|
||||
// Music voice iterate
|
||||
MUV_IN,
|
||||
MUV_DE,
|
||||
#endif
|
||||
```
|
||||
|
||||
## Midi
|
||||
|
||||
#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
|
||||
MI_ON, // send midi notes when music mode is enabled
|
||||
MI_OFF, // don't send midi notes when music mode is enabled
|
||||
#endif
|
||||
|
||||
MIDI_TONE_MIN,
|
||||
MIDI_TONE_MAX
|
||||
|
||||
MI_C = MIDI_TONE_MIN,
|
||||
MI_Cs,
|
||||
MI_Db = MI_Cs,
|
||||
MI_D,
|
||||
MI_Ds,
|
||||
MI_Eb = MI_Ds,
|
||||
MI_E,
|
||||
MI_F,
|
||||
MI_Fs,
|
||||
MI_Gb = MI_Fs,
|
||||
MI_G,
|
||||
MI_Gs,
|
||||
MI_Ab = MI_Gs,
|
||||
MI_A,
|
||||
MI_As,
|
||||
MI_Bb = MI_As,
|
||||
MI_B,
|
||||
|
||||
MIDI_TONE_KEYCODE_OCTAVES > 1
|
||||
|
||||
where x = 1-5:
|
||||
MI_C_x,
|
||||
MI_Cs_x,
|
||||
MI_Db_x = MI_Cs_x,
|
||||
MI_D_x,
|
||||
MI_Ds_x,
|
||||
MI_Eb_x = MI_Ds_x,
|
||||
MI_E_x,
|
||||
MI_F_x,
|
||||
MI_Fs_x,
|
||||
MI_Gb_x = MI_Fs_x,
|
||||
MI_G_x,
|
||||
MI_Gs_x,
|
||||
MI_Ab_x = MI_Gs_x,
|
||||
MI_A_x,
|
||||
MI_As_x,
|
||||
MI_Bb_x = MI_As_x,
|
||||
MI_B_x,
|
||||
|
||||
MI_OCT_Nx 1-2
|
||||
MI_OCT_x 0-7
|
||||
MIDI_OCTAVE_MIN = MI_OCT_N2,
|
||||
MIDI_OCTAVE_MAX = MI_OCT_7,
|
||||
MI_OCTD, // octave down
|
||||
MI_OCTU, // octave up
|
||||
|
||||
MI_TRNS_Nx 1-6
|
||||
MI_TRNS_x 0-6
|
||||
MIDI_TRANSPOSE_MIN = MI_TRNS_N6,
|
||||
MIDI_TRANSPOSE_MAX = MI_TRNS_6,
|
||||
MI_TRNSD, // transpose down
|
||||
MI_TRNSU, // transpose up
|
||||
|
||||
MI_VEL_x 1-10
|
||||
MIDI_VELOCITY_MIN = MI_VEL_1,
|
||||
MIDI_VELOCITY_MAX = MI_VEL_10,
|
||||
MI_VELD, // velocity down
|
||||
MI_VELU, // velocity up
|
||||
|
||||
MI_CHx 1-16
|
||||
MIDI_CHANNEL_MIN = MI_CH1
|
||||
MIDI_CHANNEL_MAX = MI_CH16,
|
||||
MI_CHD, // previous channel
|
||||
MI_CHU, // next channel
|
||||
|
||||
MI_ALLOFF, // all notes off
|
||||
|
||||
MI_SUS, // sustain
|
||||
MI_PORT, // portamento
|
||||
MI_SOST, // sostenuto
|
||||
MI_SOFT, // soft pedal
|
||||
MI_LEG, // legato
|
||||
|
||||
MI_MOD, // modulation
|
||||
MI_MODSD, // decrease modulation speed
|
||||
MI_MODSU, // increase modulation speed
|
||||
#endif // MIDI_ADVANCED
|
||||
|
||||
## Backlight
|
||||
|
||||
* `BL_x` where x = 0-15
|
||||
* `BL_ON = BL_9`
|
||||
* `BL_OFF = BL_0`
|
||||
* `BL_DEC`
|
||||
* `BL_INC`
|
||||
* `BL_TOGG`
|
||||
* `BL_STEP`
|
||||
|
||||
## RGB WS2818 LEDs
|
||||
|
||||
* `RGB_TOG` toggle on/off
|
||||
* `RGB_MOD` cycle between modes
|
||||
* `RGB_HUI` hue increase
|
||||
* `RGB_HUD` hue decrease
|
||||
* `RGB_SAI` saturation increase
|
||||
* `RGB_SAD` saturation decrease
|
||||
* `RGB_VAI` value increase
|
||||
* `RGB_VAD` value decrease
|
||||
|
||||
## Thermal Printer (experimental)
|
||||
|
||||
* `PRINT_ON`
|
||||
* `PRINT_OFF`
|
||||
|
||||
## Keyboard output selection
|
||||
|
||||
* `OUT_AUTO` auto mode
|
||||
* `OUT_USB` usb only
|
||||
* `OUT_BT` bluetooth (when `BLUETOOTH_ENABLE`)
|
||||
|
||||
## Modifiers
|
||||
|
||||
* `KC_HYPR` LCTL + LSFT + LALT + LGUI - `MOD_HYPR` is the bit version
|
||||
* `KC_MEH` LCTL + LSFT + LALT - `MOD_MEH` is the bit version
|
||||
|
||||
### Modifiers with keys
|
||||
|
||||
* `LCTL(kc)` LCTL + kc
|
||||
* `LSFT(kc)`/`S(kc)` LSFT + kc
|
||||
* `LALT(kc)` LALT + kc
|
||||
* `LGUI(kc)` LGUI + kc
|
||||
* `RCTL(kc)` RCTL + kc
|
||||
* `RSFT(kc)` RSFT + kc
|
||||
* `RALT(kc)` RALT + kc
|
||||
* `RGUI(kc)` RGUI + kc
|
||||
|
||||
* `HYPR(kc)` LCTL + LSFT + LALT + LGUI + kc
|
||||
* `MEH(kc)` LCTL + LSFT + LALT + kc
|
||||
* `LCAG(kc)` LCTL + LALT + LGUI + kc
|
||||
* `ALTG(kc)` RCTL + RALT + kc
|
||||
* `SCMD(kc)`/`SWIN(kc)` LGUI + LSFT + kc
|
||||
* `LCA(kc)` LCTL + LALT + kc
|
||||
|
||||
* `OSM(mod)` use mod for one keypress - use mod bits with this
|
||||
|
||||
> Mod bits are the 4-letter part of the keycode prefixed with `MOD_`, e.g. `MOD_LCTL`
|
||||
|
||||
### Mod-tap keys
|
||||
|
||||
These keycodes will press the mod(s) when held, and the key when tapped. They only work with [basic keycodes](basic_keycodes.md).
|
||||
|
||||
* `CTL_T(kc)`/`LCTL_T(kc)` LCTL when held, kc when tapped
|
||||
* `RCTL_T(kc)` RCTL when held, kc when tapped
|
||||
|
||||
* `SFT_T(kc)`/`LSFT_T(kc)` LSFT when held, kc when tapped
|
||||
* `RSFT_T(kc)` RSFT when held, kc when tapped
|
||||
|
||||
* `ALT_T(kc)`/`LALT_T(kc)` LALT when held, kc when tapped
|
||||
* `RALT_T(kc)`/`ALGR_T(kc)` RALT when held, kc when tapped
|
||||
|
||||
* `GUI_T(kc)`/`LGUI_T(kc)` LGUI when held, kc when tapped
|
||||
* `RGUI_T(kc)` RGUI when held, kc when tapped
|
||||
|
||||
* `C_S_T(kc)` LCTL + LSFT when held, kc when tapped
|
||||
* `MEH_T(kc)` LCTL + LSFT + LALT when held, kc when tapped
|
||||
* `LCAG_T(kc)` LCTL + LALT + LGUI when held, kc when tapped
|
||||
* `RCAG_T(kc)` RCTL + RALT + RGUI when held, kc when tapped
|
||||
* `ALL_T(kc)` LCTL + LSFT + LALT + LGUI when held, kc tapped [more info](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)
|
||||
* `SCMD_T(kc)`/`SWIN_T(kc)` LGUI + LSFT when held, kc when tapped
|
||||
* `LCA_T(kc)` LCTL + LALT when held, kc when tapped
|
||||
|
||||
## Shifted symbols
|
||||
|
||||
It's important to remember that all of the keycodes also send a left shift - this may cause unintended actions if unaccounted for. The 4-letter code is preferred in most situations.
|
||||
|
||||
* `KC_TILD`/`KC_TILDE` tilde `~`
|
||||
* `KC_EXLM`/`KC_EXCLAIM` exclamation mark `!`
|
||||
* `KC_AT` at sign `@`
|
||||
* `KC_HASH` hash sign `#`
|
||||
* `KC_DLR`/`KC_DOLLAR` dollar sign `$`
|
||||
* `KC_PERC`/`KC_PERCENT` percent sign `%`
|
||||
* `KC_CIRC`/`KC_CIRCUMFLEX` circumflex `^`
|
||||
* `KC_AMPR`/`KC_AMPERSAND` ampersand `&`
|
||||
* `KC_ASTR`/`KC_ASTERISK` asterisk `*`
|
||||
* `KC_LPRN`/`KC_LEFT_PAREN` left parenthesis `(`
|
||||
* `KC_RPRN`/`KC_RIGHT_PAREN` right parenthesis `)`
|
||||
* `KC_UNDS`/`KC_UNDERSCORE` underscore `_`
|
||||
* `KC_PLUS` plus sign `+`
|
||||
* `KC_LCBR`/`KC_LEFT_CURLY_BRACE` left curly brace `{`
|
||||
* `KC_RCBR`/`KC_RIGHT_CURLY_BRACE` right curly brace `}`
|
||||
* `KC_LT`/`KC_LABK`/`KC_LEFT_ANGLE_BRACKET` left angle bracket `<`
|
||||
* `KC_GT`/`KC_RABK`/`KC_RIGHT_ANGLE_BRACKET` right angle bracket `>`
|
||||
* `KC_COLN`/`KC_COLON` colon `:`
|
||||
* `KC_PIPE` pipe `|`
|
||||
* `KC_QUES`/`KC_QUESTION` question mark `?`
|
||||
* `KC_DQT`/`KC_DOUBLE_QUOTE`/`KC_DQUO` double quote `"`
|
||||
|
||||
## Layer adjustments
|
||||
|
||||
* `LT(layer, kc)` turn on layer (0-15) when held, kc ([basic keycodes](basic_keycodes.md)) when tapped
|
||||
* `TO(layer)` turn on layer when depressed
|
||||
* `MO(layer)` momentarily turn on layer when depressed (requires `KC_TRNS` on destination layer)
|
||||
* `DF(layer)` sets the base (default) layer
|
||||
* `TG(layer)` toggle layer on/off
|
||||
* `OSL(layer)` switch to layer for one keycode
|
||||
* `TT(layer)` tap toggle? idk FIXME
|
||||
|
||||
## Unicode
|
||||
|
||||
* `UNICODE(n)`/`UC(n)` if `UNICODE_ENABLE`, this will send characters up to `0x7FFF`
|
||||
* `X(n)` if `UNICODEMAP_ENABLE`, also sends unicode via a different method
|
||||
Loading…
Reference in a new issue