qmk_firmware/docs/quantum_keycodes.md

# Quantum Keycodes

Quantum keycodes allow for easier customisation of your keymap than the basic ones provide, without having to define custom actions.

All keycodes within quantum are numbers between `0x0000` and `0xFFFF`. Within your `keymap.c` it may look like you have functions and other special cases, but ultimately the C preprocessor will translate those into a single 4 byte integer. QMK has reserved `0x0000` through `0x00FF` for standard keycodes. These are keycodes such as `KC_A`, `KC_1`, and `KC_LCTL`, which are basic keys defined in the USB HID specification.

On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are used to implement advanced quantum features. If you define your own custom keycodes they will be put into this range as well.

## QMK Keycodes

|Key            |Aliases    |Description                                                          |
|---------------|-----------|---------------------------------------------------------------------|
|`RESET`        |           |Put the keyboard into DFU mode for flashing                          |
|`DEBUG`        |           |Toggle debug mode                                                    |
|`EEPROM_RESET` |`EEP_RST`  |Resets EEPROM state by reinitializing it                             |
|`KC_GESC`      |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI|
|`KC_LSPO`      |           |Left Shift when held, `(` when tapped                                |
|`KC_RSPC`      |           |Right Shift when held, `)` when tapped                               |
|`KC_LEAD`      |           |The [Leader key](feature_leader_key.md)                              |
|`KC_LOCK`      |           |The [Lock key](feature_key_lock.md)                                  |
|`FUNC(n)`      |`F(n)`     |Call `fn_action(n)` (deprecated)                                     |
|`M(n)`         |           |Call macro `n`                                                       |
|`MACROTAP(n)`  |           |Macro-tap `n` idk FIXME                                              |
restructure keycode docs 2017-06-29 04:15:07 +00:00			`# Quantum Keycodes`

break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			`Quantum keycodes allow for easier customisation of your keymap than the basic ones provide, without having to define custom actions.`

Trim trailing whitespace 2017-12-09 05:56:58 +00:00			All keycodes within quantum are numbers between `0x0000` and `0xFFFF`. Within your `keymap.c` it may look like you have functions and other special cases, but ultimately the C preprocessor will translate those into a single 4 byte integer. QMK has reserved `0x0000` through `0x00FF` for standard keycodes. These are keycodes such as `KC_A`, `KC_1`, and `KC_LCTL`, which are basic keys defined in the USB HID specification.
Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00
break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00			On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are used to implement advanced quantum features. If you define your own custom keycodes they will be put into this range as well.
Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00
Convert all headings to Title Case 2017-12-09 05:36:32 +00:00			`## QMK Keycodes`
Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00
Add EEPROM_RESET keycode to core code (#4234) * Add EEPROM Reset keycode * Add keycode to docs * Move EEPROM Reset code to the end of the enum * Cleanup and naming change 2018-11-06 05:38:18 +00:00			`\|Key \|Aliases \|Description \|`
			`\|---------------\|-----------\|---------------------------------------------------------------------\|`
			\|`RESET` \| \|Put the keyboard into DFU mode for flashing \|
			\|`DEBUG` \| \|Toggle debug mode \|
			\|`EEPROM_RESET` \|`EEP_RST` \|Resets EEPROM state by reinitializing it \|
			\|`KC_GESC` \|`GRAVE_ESC`\|Escape when tapped, <code>`</code> when pressed with Shift or GUI\|
			\|`KC_LSPO` \| \|Left Shift when held, `(` when tapped \|
			\|`KC_RSPC` \| \|Right Shift when held, `)` when tapped \|
			\|`KC_LEAD` \| \|The [Leader key](feature_leader_key.md) \|
			\|`KC_LOCK` \| \|The [Lock key](feature_key_lock.md) \|
			\|`FUNC(n)` \|`F(n)` \|Call `fn_action(n)` (deprecated) \|
			\|`M(n)` \| \|Call macro `n` \|
			\|`MACROTAP(n)` \| \|Macro-tap `n` idk FIXME \|