docs/custom_quantum_functions.md

   1 # How To Customize Your Keyboard's Behavior
   2
   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.
   4
   5 This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.html) will help you understand what is going on at a more fundamental level.
   6
   7 ## A Word on Core vs Keyboards vs Keymap
   8
   9 We have structured QMK as a hierarchy:
  10
  11 * Core (`_quantum`)
  12   * Keyboard/Revision (`_kb`)
  13     * Keymap (`_user`)
  14
  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.
  16
  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.
  18
  19 # Custom Keycodes
  20
  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.
  22
  23 ## Defining a New Keycode
  24
  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.
  26
  27
  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.
  29
  30 ```
  31 enum my_keycodes {
  32   FOO = SAFE_RANGE,
  33   BAR
  34 };
  35 ```
  36
  37 ## Programming The Behavior Of Any Keycode
  38
  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 you to send any key up or down events that are required.
  40
  41 These function are called every time a key is pressed or released.
  42
  43 ### Example `process_record_user()` implementation
  44
  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.
  46
  47 ```
  48 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  49   switch (keycode) {
  50     case FOO:
  51       if (record->event.pressed) {
  52         // Do something when pressed
  53       } else {
  54         // Do something else when release
  55       }
  56       return false; // Skip all further processing of this key
  57     case KC_ENTER:
  58       // Play a tone when enter is pressed
  59       if (record->event.pressed) {
  60         PLAY_NOTE_ARRAY(tone_qwerty);
  61       }
  62       return true; // Let QMK send the enter press/release events
  63   }
  64 }
  65 ```
  66
  67 ### `process_record_*` Function documentation
  68
  69 * Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
  70 * Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)`
  71
  72 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.
  73
  74 The `record` argument contains infomation about the actual press:
  75
  76 ```
  77 keyrecord_t record {
  78 +-keyevent_t event {
  79 | +-keypos_t key {
  80 | | +-uint8_t col
  81 | | +-uint8_t row
  82 | | }
  83 | +-bool     pressed
  84 | +-uint16_t time
  85 | }
  86 }
  87 ```
  88
  89 # LED Control
  90
  91 This allows you to control the 5 LED's defined as part of the USB Keyboard spec. It will be called when the state of one of those 5 LEDs changes.
  92
  93 * `USB_LED_NUM_LOCK`
  94 * `USB_LED_CAPS_LOCK`
  95 * `USB_LED_SCROLL_LOCK`
  96 * `USB_LED_COMPOSE`
  97 * `USB_LED_KANA`
  98
  99 ### Example `led_set_kb()` implementation
 100
 101 ```
 102 void led_set_kb(uint8_t usb_led) {
 103     if (usb_led & (1<<USB_LED_NUM_LOCK)) {
 104         PORTB |= (1<<0);
 105     } else {
 106         PORTB &= ~(1<<0);
 107     }
 108     if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
 109         PORTB |= (1<<1);
 110     } else {
 111         PORTB &= ~(1<<1);
 112     }
 113     if (usb_led & (1<<USB_LED_SCROLL_LOCK)) {
 114         PORTB |= (1<<2);
 115     } else {
 116         PORTB &= ~(1<<2);
 117     }
 118     if (usb_led & (1<<USB_LED_COMPOSE_LOCK)) {
 119         PORTB |= (1<<3);
 120     } else {
 121         PORTB &= ~(1<<3);
 122     }
 123     if (usb_led & (1<<USB_LED_KANA_LOCK)) {
 124         PORTB |= (1<<4);
 125     } else {
 126         PORTB &= ~(1<<4);
 127     }
 128 }
 129 ```
 130
 131 ### `led_set_*` Function documentation
 132
 133 * Keyboard/Revision: `void led_set_kb(uint8_t usb_led)`
 134 * Keymap: `void led_set_user(uint8_t usb_led)`
 135
 136 # Matrix Initialization Code
 137
 138 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 LED's or i&#xb2;c controllers you will need to set up that hardware before it can be used.
 139
 140 ### Example `matrix_init_kb()` implementation
 141
 142 This example, at the keyboard level, sets up B1, B2, and B3 as LED pins.
 143
 144 ```
 145 void matrix_init_kb(void) {
 146   // Call the keymap level matrix init.
 147   matrix_init_user();
 148
 149   // Set our LED pins as output
 150   DDRB |= (1<<1);
 151   DDRB |= (1<<2);
 152   DDRB |= (1<<3);
 153 }
 154 ```
 155
 156 ### `matrix_init_*` Function documentation
 157
 158 * Keyboard/Revision: `void matrix_init_kb(void)`
 159 * Keymap: `void matrix_init_user(void)`
 160
 161 # Matrix Scanning Code
 162
 163 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.
 164
 165 ### Example `matrix_scan_*` implementation
 166
 167 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 gitter](https://gitter.im/qmk/qmk_firmware).
 168
 169 ### `matrix_scan_*` Function documentation
 170
 171 * Keyboard/Revision: `void matrix_scan_kb(void)`
 172 * Keymap: `void matrix_scan_user(void)`
 173
 174 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.
 175
 176 You should use this function if you need custom matrix scanning code. It can also be used for custom status output (such as LED's or a display) or other functionality that you want to trigger regularly even when the user isn't typing.