docs/keymap.md

   1 # Keymap Overview
   2
   3 QMK keymaps are defined inside a C source file. The data structure is an array of arrays. The outer array is a list of layer arrays while the inner layer array is a list of keys. Most keyboards define a `KEYMAP()` macro to help you create this array of arrays.
   4
   5
   6 ## Keymap and layers
   7 In QMK,  **`const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]`** holds multiple **layers** of keymap information in **16 bit** data holding the **action code**. You can define **32 layers** at most.
   8
   9 For trivial key definitions, the higher 8 bits of the **action code** are all 0 and the lower 8 bits holds the USB HID usage code generated by the key as **keycode**.
  10
  11 Respective layers can be validated simultaneously. Layers are indexed with 0 to 31 and higher layer has precedence.
  12
  13     Keymap: 32 Layers                   Layer: action code matrix
  14     -----------------                   ---------------------
  15     stack of layers                     array_of_action_code[row][column]
  16            ____________ precedence               _______________________
  17           /           / | high                  / ESC / F1  / F2  / F3   ....
  18       31 /___________// |                      /-----/-----/-----/-----
  19       30 /___________// |                     / TAB /  Q  /  W  /  E   ....
  20       29 /___________/  |                    /-----/-----/-----/-----
  21        :   _:_:_:_:_:__ |               :   /LCtrl/  A  /  S  /  D   ....
  22        :  / : : : : : / |               :  /  :     :     :     :
  23        2 /___________// |               2 `--------------------------
  24        1 /___________// |               1 `--------------------------
  25        0 /___________/  V low           0 `--------------------------
  26
  27
  28 Sometimes, the action code stored in keymap may be referred as keycode in some documents due to the TMK history.
  29
  30 ### Keymap layer status
  31 The state of the Keymap layer is determined by two 32 bit parameters:
  32
  33 * **`default_layer_state`** indicates a base keymap layer (0-31) which is always valid and to be referred (the default layer).
  34 * **`layer_state`** has current on/off status of each layer in its bits.
  35
  36 Keymap layer '0' is usually `default_layer`, wither other layers initially off after booting up the firmware, although this can configured differently in `config.h`. It is useful to change `default_layer` when you completely switch a key layout, for example, if you want to switch to Colemak instead of Qwerty.
  37
  38     Initial state of Keymap          Change base layout
  39     -----------------------          ------------------
  40
  41       31                               31
  42       30                               30
  43       29                               29
  44        :                                :
  45        :                                :   ____________
  46        2   ____________                 2  /           /
  47        1  /           /              ,->1 /___________/
  48     ,->0 /___________/               |  0
  49     |                                |
  50     `--- default_layer = 0           `--- default_layer = 1
  51          layer_state   = 0x00000001       layer_state   = 0x00000002
  52
  53 On the other hand, you can change `layer_state` to overlay the base layer with other layers for features such as navigation keys, function keys (F1-F12), media keys, and/or special actions.
  54
  55     Overlay feature layer
  56     ---------------------      bit|status
  57            ____________        ---+------
  58       31  /           /        31 |   0
  59       30 /___________// -----> 30 |   1
  60       29 /___________/  -----> 29 |   1
  61        :                        : |   :
  62        :   ____________         : |   :
  63        2  /           /         2 |   0
  64     ,->1 /___________/  ----->  1 |   1
  65     |  0                        0 |   0
  66     |                                 +
  67     `--- default_layer = 1            |
  68          layer_state   = 0x60000002 <-'
  69
  70
  71
  72 ### Layer Precedence and Transparency
  73 Note that ***higher layer has higher priority on stack of layers***, namely firmware falls down from top layer to bottom to look up keycode. Once it spots keycode other than **`KC_TRNS`**(transparent) on a layer it stops searching and lower layers aren't referred.
  74
  75 You can place `KC_TRANS` on overlay layer changes just part of layout to fall back on lower or base layer.
  76 Key with `KC_TRANS` (`KC_TRNS` and `_______` are the alias) doesn't has its own keycode and refers to lower valid layers for keycode, instead.
  77
  78 ## Anatomy Of A `keymap.c`
  79
  80 For this example we will walk through the [default Clueboard 66% keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard_66/keymaps/default/keymap.c). You'll find it helpful to open that file in another browser window so you can look at everything in context.
  81
  82 There are 3 main sections of a `keymap.c` file you'll want to concern yourself with:
  83
  84 * [The Definitions](#definitions)
  85 * [The Layer/Keymap Datastructure](#layers-and-keymaps)
  86 * [Custom Functions](#custom-functions), if any
  87
  88 ### Definitions
  89
  90 At the top of the file you'll find this:
  91
  92     #include "clueboard.h"
  93
  94     // Helpful defines
  95     #define GRAVE_MODS  (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)|MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI)|MOD_BIT(KC_LALT)|MOD_BIT(KC_RALT))
  96     #define _______ KC_TRNS
  97
  98     // Each layer gets a name for readability.
  99     // The underscores don't mean anything - you can
 100     // have a layer called STUFF or any other name.
 101     // Layer names don't all need to be of the same
 102     // length, and you can also skip them entirely
 103     // and just use numbers.
 104     #define _BL 0
 105     #define _FL 1
 106     #define _CL 2
 107
 108 These are some handy definitions we can use when building our keymap and our custom function. The `GRAVE_MODS` definition will be used later in our custom function. The `_______` define makes it easier to see what keys a layer is overriding, while the `_BL`, `_FL`, and `_CL` defines make it easier to refer to each of our layers.
 109
 110 ### Layers and Keymaps
 111
 112 The main part of this file is the `keymaps[]` definition. This is where you list your layers and the contents of those layers. This part of the file begins with this definition:
 113
 114     const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 115
 116 After this you'll find a list of KEYMAP() macros. A KEYMAP() is simply a list of keys to define a single layer. Typically you'll have one or more "base layers" (such as QWERTY, Dvorak, or Colemak) and then you'll layer on top of that one or more "function" layers. Due to the way layers are processed you can't overlay a "lower" layer on top of a "higher" layer.
 117
 118 `keymaps[][MATRIX_ROWS][MATRIX_COLS]` in QMK holds the 16 bit action code (sometimes referred as the quantum keycode) in it.  For the keycode representing typical keys, its high byte is 0 and its low byte is the USB HID usage ID for keyboard.
 119
 120 > TMK from which QMK was forked uses `const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]` instead and holds the 8 bit keycode.  Some keycode values are reserved to induce execution of certain action codes via the `fn_actions[]` array.
 121
 122 #### Base Layer
 123
 124 Here is an example of the Clueboard's base layer:
 125
 126       /* Keymap _BL: Base Layer (Default Layer)
 127        */
 128     [_BL] = KEYMAP(
 129       F(0),    KC_1,    KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,    KC_0,     KC_MINS,  KC_EQL,   KC_GRV,  KC_BSPC,          KC_PGUP, \
 130       KC_TAB,  KC_Q,    KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,    KC_P,     KC_LBRC,  KC_RBRC,  KC_BSLS,                   KC_PGDN, \
 131       KC_CAPS, KC_A,    KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,    KC_SCLN,  KC_QUOT,  KC_NUHS,  KC_ENT,                             \
 132       KC_LSFT, KC_NUBS, KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM, KC_DOT,   KC_SLSH,  KC_RO,    KC_RSFT,          KC_UP,            \
 133       KC_LCTL, KC_LGUI, KC_LALT, KC_MHEN,          KC_SPC,KC_SPC,                        KC_HENK,  KC_RALT,  KC_RCTL,  MO(_FL), KC_LEFT, KC_DOWN, KC_RGHT),
 134
 135 Some interesting things to note about this:
 136
 137 * From a C source point of view it's only a single array, but we have embedded whitespace to more easily visualize where each key is on the physical device.
 138 * Plain keyboard scancodes are prefixed with KC_, while "special" keys are not.
 139 * The upper left key activates custom function 0 (`F(0)`)
 140 * The "Fn" key is defined with `MO(_FL)`, which moves to the `_FL` layer while that key is being held down.
 141
 142 #### Function Overlay Layer
 143
 144 Our function layer is, from a code point of view, no different from the base layer. Conceptually, however, you will build that layer as an overlay, not a replacement. For many people this distinction does not matter, but as you build more complicated layering setups it matters more and more.
 145
 146     [_FL] = KEYMAP(
 147       KC_GRV,  KC_F1,   KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_F6,  KC_F7,  KC_F8,  KC_F9,   KC_F10,   KC_F11,   KC_F12,   _______, KC_DEL,           BL_STEP, \
 148       _______, _______, _______,_______,_______,_______,_______,_______,KC_PSCR,KC_SLCK, KC_PAUS,  _______,  _______,  _______,                   _______, \
 149       _______, _______, MO(_CL),_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,                           \
 150       _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,          KC_PGUP,         \
 151       _______, _______, _______, _______,        _______,_______,                        _______,  _______,  _______,  MO(_FL), KC_HOME, KC_PGDN, KC_END),
 152
 153 Some interesting things to note:
 154
 155 * We have used our `_______` definition to turn `KC_TRNS` into `_______`. This makes it easier to spot the keys that have changed on this layer.
 156 * While in this layer if you press one of the `_______` keys it will activate the key in the next lowest active layer.
 157
 158 ### Custom Functions
 159
 160 At the bottom of the file we've defined a single custom function. This function defines a key that sends `KC_ESC` when pressed without modifiers and `KC_GRAVE` when modifiers are held. There are a couple pieces that need to be in place for this to work, and we will go over both of them.
 161
 162 #### `fn_actions[]`
 163
 164 We define the `fn_actions[]` array to point to custom functions. `F(N)` in a keymap will call element N of that array. For the Clueboard's that looks like this:
 165
 166     const uint16_t PROGMEM fn_actions[] = {
 167       [0] = ACTION_FUNCTION(0),  // Calls action_function()
 168     };
 169
 170 In this case we've instructed QMK to call the `ACTION_FUNCTION` callback, which we will define in the next section.
 171
 172 > This `fn_actions[]` interface is mostly for backward compatibility.  In QMK, you don't need to use `fn_actions[]`.  You can directly use `ACTION_FUNCTION(N)` or any other action code value itself normally generated by the macro in `keymaps[][MATRIX_ROWS][MATRIX_COLS]`.  N in `F(N)` can only be 0 to 31.  Use of the action code directly in `keymaps` unlocks this limitation.
 173
 174 #### `action_function()`
 175
 176 To actually handle the keypress event we define an `action_function()`. This function will be called when the key is pressed, and then again when the key is released. We have to handle both situations within our code, as well as determining whether to send/release `KC_ESC` or `KC_GRAVE`.
 177
 178     void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
 179       static uint8_t mods_pressed;
 180
 181       switch (id) {
 182         case 0:
 183           /* Handle the combined Grave/Esc key
 184            */
 185           mods_pressed = get_mods()&GRAVE_MODS; // Check to see what mods are pressed
 186
 187           if (record->event.pressed) {
 188             /* The key is being pressed.
 189              */
 190             if (mods_pressed) {
 191               add_key(KC_GRV);
 192               send_keyboard_report();
 193             } else {
 194               add_key(KC_ESC);
 195               send_keyboard_report();
 196             }
 197           } else {
 198             /* The key is being released.
 199              */
 200             if (mods_pressed) {
 201               del_key(KC_GRV);
 202               send_keyboard_report();
 203             } else {
 204               del_key(KC_ESC);
 205               send_keyboard_report();
 206             }
 207           }
 208           break;
 209       }
 210     }
 211
 212 # Nitty Gritty Details
 213
 214 This should have given you a basic overview for creating your own keymap. For more details see the following resources:
 215
 216 * [Keycodes](keycodes.md)
 217 * [Keymap FAQ](faq_keymap.md)
 218
 219 We are actively working to improve these docs. If you have suggestions for how they could be made better please [file an issue](https://github.com/qmk/qmk_firmware/issues/new)!