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 :id=qmk-keycodes

|Key              |Aliases  |Description                                                                      |
|-----------------|---------|---------------------------------------------------------------------------------|
|`QK_BOOTLOADER`  |`QK_BOOT`|Put the keyboard into bootloader mode for flashing                               |
|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode                                                                |
|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory)                          |
|`QK_MAKE`        |         |Sends `qmk compile -kb (keyboard) -km (keymap)`, or `qmk flash` if shift is held |
restructure keycode docs 2017-06-29 06:15:07 +02: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 07:20:14 +02: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 02:51:42 +02:00
Trim trailing whitespace 2017-12-09 06:56:58 +01: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 08:52:08 +02:00
break up keymaps and quantum keycodes into files by feature 2017-08-07 02:51:42 +02: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 08:52:08 +02:00
Add explicit id tags to externally linked headers 2020-02-28 05:53:50 +01:00			`## QMK Keycodes :id=qmk-keycodes`
Flesh out the quantum_keycodes documentation 2017-06-29 08:52:08 +02:00
[Core] Add compile/make macro to core (#15959) * [Core] Add KC_MAKE keycode to core fix linting fix testing error work around test idiocyncracies fix more lint something something stupid tests add doc * updates based on feedback * Add bad names * Fixup docs * semantics but cleaner Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Hide oneshot checks behind preprocessors * Move no-compile option around * Fix formatting * make shift optional * Make opt in * fix formatting * update send string function name Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: Joel Challis <git@zvecr.com> 2022-03-17 22:19:34 +01:00			`\|Key \|Aliases \|Description \|`
			`\|-----------------\|---------\|---------------------------------------------------------------------------------\|`
			\|`QK_BOOTLOADER` \|`QK_BOOT`\|Put the keyboard into bootloader mode for flashing \|
			\|`QK_DEBUG_TOGGLE`\|`DB_TOGG`\|Toggle debug mode \|
			\|`QK_CLEAR_EEPROM`\|`EE_CLR` \|Reinitializes the keyboard's EEPROM (persistent memory) \|
			\|`QK_MAKE` \| \|Sends `qmk compile -kb (keyboard) -km (keymap)`, or `qmk flash` if shift is held \|