1 # How to Customize Your Keyboard's Behavior
3 For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations.
5 This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.md) will help you understand what is going on at a more fundamental level.
7 ## A Word on Core vs Keyboards vs Keymap
9 We have structured QMK as a hierarchy:
12 * Keyboard/Revision (`_kb`)
15 Each of the functions described below can be defined with a `_kb()` suffix or a `_user()` suffix. We intend for you to use the `_kb()` suffix at the Keyboard/Revision level, while the `_user()` suffix should be used at the Keymap level.
17 When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` before executing anything else- otherwise the keymap level function will never be called.
21 By far the most common task is to change the behavior of an existing keycode or to create a new keycode. From a code standpoint the mechanism for each is very similar.
23 ## Defining a New Keycode
25 The first step to creating your own custom keycode(s) is to enumerate them. This means both naming them and assigning a unique number to that keycode. Rather than limit custom keycodes to a fixed range of numbers QMK provides the `SAFE_RANGE` macro. You can use `SAFE_RANGE` when enumerating your custom keycodes to guarantee that you get a unique number.
28 Here is an example of enumerating 2 keycodes. After adding this block to your `keymap.c` you will be able to use `FOO` and `BAR` inside your keymap.
37 ## Programming the Behavior of Any Keycode
39 When you want to override the behavior of an existing key, or define the behavior for a new key, you should use the `process_record_kb()` and `process_record_user()` functions. These are called by QMK during key processing before the actual key event is handled. If these functions return `true` QMK will process the keycodes as usual. That can be handy for extending the functionality of a key rather than replacing it. If these functions return `false` QMK will skip the normal key handling, and it will be up to you to send any key up or down events that are required.
41 These function are called every time a key is pressed or released.
43 ### Example `process_record_user()` Implementation
45 This example does two things. It defines the behavior for a custom keycode called `FOO`, and it supplements our Enter key by playing a tone whenever it is pressed.
48 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
51 if (record->event.pressed) {
52 // Do something when pressed
54 // Do something else when release
56 return false; // Skip all further processing of this key
58 // Play a tone when enter is pressed
59 if (record->event.pressed) {
60 PLAY_NOTE_ARRAY(tone_qwerty);
62 return true; // Let QMK send the enter press/release events
64 return true; // Process all other keycodes normally
69 ### `process_record_*` Function Documentation
71 * Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
72 * Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)`
74 The `keycode` argument is whatever is defined in your keymap, eg `MO(1)`, `KC_L`, etc. You should use a `switch...case` block to handle these events.
76 The `record` argument contains information about the actual press:
93 QMK provides methods to read the 5 LEDs defined as part of the HID spec:
97 * `USB_LED_SCROLL_LOCK`
101 These five constants correspond to the positional bits of the host LED state.
102 There are two ways to get the host LED state:
104 * by implementing `led_set_user()`
105 * by calling `host_keyboard_leds()`
109 This function will be called when the state of one of those 5 LEDs changes.
110 It receives the LED state as parameter.
111 Use the `IS_LED_ON(USB_LED, LED_NAME)` and `IS_LED_OFF(USB_LED, LED_NAME)`
112 macros to check the LED status.
114 !> `host_keyboard_leds()` may already reflect a new value before `led_set_user()` is called.
116 ### Example `led_set_user()` Implementation
119 void led_set_user(uint8_t usb_led) {
120 if (IS_LED_ON(usb_led, USB_LED_NUM_LOCK)) {
125 if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK)) {
130 if (IS_LED_ON(usb_led, USB_LED_SCROLL_LOCK)) {
135 if (IS_LED_ON(usb_led, USB_LED_COMPOSE)) {
140 if (IS_LED_ON(usb_led, USB_LED_KANA)) {
148 ### `led_set_*` Function Documentation
150 * Keyboard/Revision: `void led_set_kb(uint8_t usb_led)`
151 * Keymap: `void led_set_user(uint8_t usb_led)`
153 ## `host_keyboard_leds()`
155 Call this function to get the last received LED state.
156 This is useful for reading the LED state outside `led_set_*`, e.g. in [`matrix_scan_user()`](#matrix-scanning-code).
158 For convenience, you can use the `IS_HOST_LED_ON(LED_NAME)` and `IS_HOST_LED_OFF(LED_NAME)` macros instead of calling `host_keyboard_leds()` directly.
160 ## Setting physical LED state
162 Some keyboard implementations provide convenience methods for setting the state of the physical LEDs.
164 ### Ergodox and Ergodox EZ
166 The Ergodox EZ implementation provides `ergodox_right_led_``1`/`2`/`3_on`/`off()`
167 to turn individual LEDs on and off, as well as
168 `ergodox_right_led_on`/`off(uint8_t led)`
169 to turn them on and off by their number.
171 In addition, it is possible to specify the brightness level with `ergodox_led_all_set(uint8_t n)`,
172 for individual LEDs with `ergodox_right_led_1`/`2`/`3_set(uint8_t n)`
173 or by their number using `ergodox_right_led_set(uint8_t led, uint8_t n)`.
175 It defines `LED_BRIGHTNESS_LO` for the lowest brightness and `LED_BRIGHTNESS_HI` for the highest brightness, which is also the default.
177 # Matrix Initialization Code
179 Before a keyboard can be used the hardware must be initialized. QMK handles initialization of the keyboard matrix itself, but if you have other hardware like LEDs or i²c controllers you will need to set up that hardware before it can be used.
182 ### Example `matrix_init_user()` Implementation
184 This example, at the keyboard level, sets up B1, B2, and B3 as LED pins.
187 void matrix_init_user(void) {
188 // Call the keymap level matrix init.
190 // Set our LED pins as output
197 ### `matrix_init_*` Function Documentation
199 * Keyboard/Revision: `void matrix_init_kb(void)`
200 * Keymap: `void matrix_init_user(void)`
202 # Matrix Scanning Code
204 Whenever possible you should customize your keyboard by using `process_record_*()` and hooking into events that way, to ensure that your code does not have a negative performance impact on your keyboard. However, in rare cases it is necessary to hook into the matrix scanning. Be extremely careful with the performance of code in these functions, as it will be called at least 10 times per second.
206 ### Example `matrix_scan_*` Implementation
208 This example has been deliberately omitted. You should understand enough about QMK internals to write this without an example before hooking into such a performance sensitive area. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on Discord](https://discord.gg/Uq7gcHh).
210 ### `matrix_scan_*` Function Documentation
212 * Keyboard/Revision: `void matrix_scan_kb(void)`
213 * Keymap: `void matrix_scan_user(void)`
215 This function gets called at every matrix scan, which is basically as often as the MCU can handle. Be careful what you put here, as it will get run a lot.
217 You should use this function if you need custom matrix scanning code. It can also be used for custom status output (such as LEDs or a display) or other functionality that you want to trigger regularly even when the user isn't typing.
220 # Keyboard Idling/Wake Code
222 If the board supports it, it can be "idled", by stopping a number of functions. A good example of this is RGB lights or backlights. This can save on power consumption, or may be better behavior for your keyboard.
224 This is controlled by two functions: `suspend_power_down_*` and `suspend_wakeup_init_*`, which are called when the system is board is idled and when it wakes up, respectively.
227 ### Example suspend_power_down_user() and suspend_wakeup_init_user() Implementation
229 This example, at the keyboard level, sets up B1, B2, and B3 as LED pins.
232 void suspend_power_down_user(void)
234 rgb_matrix_set_suspend_state(true);
237 void suspend_wakeup_init_user(void)
239 rgb_matrix_set_suspend_state(false);
244 ### `keyboard_init_*` Function Documentation
246 * Keyboard/Revision: `void suspend_power_down_kb(void)` and `void suspend_wakeup_init_user(void)`
247 * Keymap: `void suspend_power_down_kb(void)` and `void suspend_wakeup_init_user(void)`
251 This runs code every time that the layers get changed. This can be useful for layer indication, or custom layer handling.
253 ### Example `layer_state_set_*` Implementation
255 This example shows how to set the [RGB Underglow](feature_rgblight.md) lights based on the layer, using the Planck as an example
258 uint32_t layer_state_set_user(uint32_t state) {
259 switch (biton32(state)) {
261 rgblight_setrgb (0x00, 0x00, 0xFF);
264 rgblight_setrgb (0xFF, 0x00, 0x00);
267 rgblight_setrgb (0x00, 0xFF, 0x00);
270 rgblight_setrgb (0x7A, 0x00, 0xFF);
272 default: // for any other layers, or the default layer
273 rgblight_setrgb (0x00, 0xFF, 0xFF);
279 ### `layer_state_set_*` Function Documentation
281 * Keyboard/Revision: `void uint32_t layer_state_set_kb(uint32_t state)`
282 * Keymap: `uint32_t layer_state_set_user(uint32_t state)`
284 The `state` is the bitmask of the active layers, as explained in the [Keymap Overview](keymap.md#keymap-layer-status)
287 # Persistent Configuration (EEPROM)
289 This allows you to configure persistent settings for your keyboard. These settings are stored in the EEPROM of your controller, and are retained even after power loss. The settings can be read with `eeconfig_read_kb` and `eeconfig_read_user`, and can be written to using `eeconfig_update_kb` and `eeconfig_update_user`. This is useful for features that you want to be able to toggle (like toggling rgb layer indication). Additionally, you can use `eeconfig_init_kb` and `eeconfig_init_user` to set the default values for the EEPROM.
291 The complicated part here, is that there are a bunch of ways that you can store and access data via EEPROM, and there is no "correct" way to do this. However, you only have a DWORD (4 bytes) for each function.
293 Keep in mind that EEPROM has a limited number of writes. While this is very high, it's not the only thing writing to the EEPROM, and if you write too often, you can potentially drastically shorten the life of your MCU.
295 * If you don't understand the example, then you may want to avoid using this feature, as it is rather complicated.
297 ### Example Implementation
299 This is an example of how to add settings, and read and write it. We're using the user keymap for the example here. This is a complex function, and has a lot going on. In fact, it uses a lot of the above functions to work!
302 In your keymap.c file, add this to the top:
307 bool rgb_layer_change :1;
311 user_config_t user_config;
314 This sets up a 32 bit structure that we can store settings with in memory, and write to the EEPROM. Using this removes the need to define variables, since they're defined in this structure. Remember that `bool` (boolean) values use 1 bit, `uint8_t` uses 8 bits, `uint16_t` uses up 16 bits. You can mix and match, but changing the order can cause issues, as it will change the values that are read and written.
316 We're using `rgb_layer_change`, for the `layer_state_set_*` function, and use `matrix_init_user` and `process_record_user` to configure everything.
318 Now, using the `matrix_init_user` code above, you want to add `eeconfig_read_user()` to it, to populate the structure you've just created. And you can then immediately use this structure to control functionality in your keymap. And It should look like:
320 void matrix_init_user(void) {
321 // Call the keymap level matrix init.
323 // Read the user config from EEPROM
324 user_config.raw = eeconfig_read_user();
326 // Set default layer, if enabled
327 if (user_config.rgb_layer_change) {
328 rgblight_enable_noeeprom();
329 rgblight_sethsv_noeeprom_cyan();
330 rgblight_mode_noeeprom(1);
334 The above function will use the EEPROM config immediately after reading it, to set the default layer's RGB color. The "raw" value of it is converted in a usable structure based on the "union" that you created above.
337 uint32_t layer_state_set_user(uint32_t state) {
338 switch (biton32(state)) {
340 if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_magenta(); rgblight_mode_noeeprom(1); }
343 if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_red(); rgblight_mode_noeeprom(1); }
346 if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_green(); rgblight_mode_noeeprom(1); }
349 if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_white(); rgblight_mode_noeeprom(1); }
351 default: // for any other layers, or the default layer
352 if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_cyan(); rgblight_mode_noeeprom(1); }
358 This will cause the RGB underglow to be changed ONLY if the value was enabled. Now to configure this value, create a new keycode for `process_record_user` called `RGB_LYR` and `EPRM`. Additionally, we want to make sure that if you use the normal RGB codes, that it turns off Using the example above, make it look this:
361 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
364 if (record->event.pressed) {
365 // Do something when pressed
367 // Do something else when release
369 return false; // Skip all further processing of this key
371 // Play a tone when enter is pressed
372 if (record->event.pressed) {
373 PLAY_NOTE_ARRAY(tone_qwerty);
375 return true; // Let QMK send the enter press/release events
377 if (record->event.pressed) {
378 eeconfig_init(); // resets the EEPROM to default
381 case RGB_LYR: // This allows me to use underglow as layer indication, or as normal
382 if (record->event.pressed) {
383 user_config.rgb_layer_change ^= 1; // Toggles the status
384 eeconfig_update_user(user_config.raw); // Writes the new status to EEPROM
385 if (user_config.rgb_layer_change) { // if layer state indication is enabled,
386 layer_state_set(layer_state); // then immediately update the layer color
390 case RGB_MODE_FORWARD ... RGB_MODE_GRADIENT: // For any of the RGB codes (see quantum_keycodes.h, L400 for reference)
391 if (record->event.pressed) { //This disables layer indication, as it's assumed that if you're changing this ... you want that disabled
392 if (user_config.rgb_layer_change) { // only if this is enabled
393 user_config.rgb_layer_change = false; // disable it, and
394 eeconfig_update_user(user_config.raw); // write the setings to EEPROM
399 return true; // Process all other keycodes normally
403 And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. For example, if you want to set rgb layer indication by default, and save the default valued.
406 void eeconfig_init_user(void) { // EEPROM is getting reset!
407 user_config.rgb_layer_change = true; // We want this enabled by default
408 eeconfig_update_user(user_config.raw); // Write default value to EEPROM now
410 // use the non noeeprom versions, to write these values to EEPROM too
411 rgblight_enable(); // Enable RGB by default
412 rgblight_sethsv_cyan(); // Set it to CYAN by default
413 rgblight_mode(1); // set to solid by default
417 And you're done. The RGB layer indication will only work if you want it to. And it will be saved, even after unplugging the board. And if you use any of the RGB codes, it will disable the layer indication, so that it stays on the mode and color that you set it to.
419 ### 'EECONFIG' Function Documentation
421 * Keyboard/Revision: `void eeconfig_init_kb(void)`, `uint32_t eeconfig_read_kb(void)` and `void eeconfig_update_kb(uint32_t val)`
422 * Keymap: `void eeconfig_init_user(void)`, `uint32_t eeconfig_read_user(void)` and `void eeconfig_update_user(uint32_t val)`
424 The `val` is the value of the data that you want to write to EEPROM. And the `eeconfig_read_*` function return a 32 bit (DWORD) value from the EEPROM.