qmk/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 {#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. Puts keyboard into bootloader mode if shift & control are held |
|`QK_REBOOT`      |`QK_RBT` |Resets the keyboard. Does not load the bootloader                                                                                                |

::: warning
Note: `QK_MAKE` requires `#define ENABLE_COMPILE_KEYCODE` in your config.h to function.
:::
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
Vitepress conversion of docs. (#23795) 2024-05-30 02:00:41 +00:00			`## QMK Keycodes {#qmk-keycodes}`
Flesh out the quantum_keycodes documentation 2017-06-29 06:52:08 +00:00
Add ability to enter bootloader mode from `QK_MAKE` (#17745) 2022-07-23 16:43:32 +00: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. Puts keyboard into bootloader mode if shift & control are held \|
			\|`QK_REBOOT` \|`QK_RBT` \|Resets the keyboard. Does not load the bootloader \|
[Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) Co-authored-by: Ryan <fauxpark@gmail.com> 2023-06-20 01:55:27 +00:00
Vitepress conversion of docs. (#23795) 2024-05-30 02:00:41 +00:00			`::: warning`
			Note: `QK_MAKE` requires `#define ENABLE_COMPILE_KEYCODE` in your config.h to function.
			`:::`