~ruther/qmk_firmware

ref: 4b80ee46f80360f9f14ff8a88f3f610d0cf74544 qmk_firmware/docs/quantum_keycodes.md -rw-r--r-- 1.2 KiB
4b80ee46 — Joshua Diamond Add Hebrew keymap aliases (#9383) 5 years ago

#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
RESET Put the keyboard into bootloader mode for flashing
DEBUG Toggle debug mode
EEPROM_RESET EEP_RST Reinitializes the keyboard's EEPROM (persistent memory)