qmk_firmware/docs/quantum_keycodes.md

# Quantum Keycodes

Quantum keycodes allow for easier customization 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 bootloader mode for flashing     |
|`DEBUG`       |         |Toggle debug mode                                      |
|`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)|
restructure keycode docs 2017-06-29 04:15:07 +00:00			`# Quantum Keycodes`

Added check for event pressed to clear space cadet (#5839) * Added check for pressed to clear space cadet * Found some docs to update * Update docs/quantum_keycodes.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Changes from PR 2019-05-12 05:20:14 +00:00			`Quantum keycodes allow for easier customization of your keymap than the basic ones provide, without having to define custom actions.`
break up keymaps and quantum keycodes into files by feature 2017-08-07 00:51:42 +00:00
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
Move Grave Escape, Lock and Leader keycodes into their own sect… (#8093) 2020-02-07 04:54:14 +00:00			`\|Key \|Aliases \|Description \|`
			`\|--------------\|---------\|-------------------------------------------------------\|`
			\|`RESET` \| \|Put the keyboard into bootloader mode for flashing \|
			\|`DEBUG` \| \|Toggle debug mode \|
			\|`EEPROM_RESET`\|`EEP_RST`\|Reinitializes the keyboard's EEPROM (persistent memory)\|