docs/feature_advanced_keycodes.md

   1 # Advanced Keycodes
   2
   3 Your keymap can include keycodes that are more advanced than normal, for example shifted keys. This page documents the functions that are available to you.
   4
   5 ### Assigning Custom Names
   6
   7 People often define custom names using `#define`. For example:
   8
   9 ```c
  10 #define FN_CAPS LT(_FL, KC_CAPSLOCK)
  11 #define ALT_TAB LALT(KC_TAB)
  12 ```
  13
  14 This will allow you to use `FN_CAPS` and `ALT_TAB` in your `KEYMAP()`, keeping it more readable.
  15
  16 ### Limits of These Aliases
  17
  18 Currently, the keycodes able to used with these functions are limited to the [Basic Keycodes](keycodes_basic.md), meaning you can't use keycodes like `KC_TILD`, or anything greater than 0xFF. For a full list of the keycodes able to be used see [Basic Keycodes](keycodes_basic.md).
  19
  20 # Switching and Toggling Layers
  21
  22 These functions allow you to activate layers in various ways. Note that layers are not generally independent layouts -- multiple layers can be activated at once, and it's typical for layers to use `KC_TRNS` to allow keypresses to pass through to lower layers. For a detailed explanation of layers, see [Keymap Overview](keymap.md#keymap-and-layers)
  23
  24 * `DF(layer)` - switches the default layer. The default layer is the always-active base layer that other layers stack on top of. See below for more about the default layer. This might be used to switch from QWERTY to Dvorak layout. (Note that this is a temporary switch that only persists until the keyboard loses power. To modify the default layer in a persistent way requires deeper customization, such as calling the `set_single_persistent_default_layer` function inside of [process_record_user](custom_quantum_functions.md#programming-the-behavior-of-any-keycode).)
  25 * `MO(layer)` - momentarily activates *layer*. As soon as you let go of the key, the layer is deactivated.
  26 * `LM(layer, mod)` - Momentarily activates *layer* (like `MO`), but with modifier(s) *mod* active. Only supports layers 0-15 and the left modifiers.
  27 * `LT(layer, kc)` - momentarily activates *layer* when held, and sends *kc* when tapped.
  28 * `TG(layer)` - toggles *layer*, activating it if it's inactive and vice versa
  29 * `TO(layer)` - activates *layer* and de-activates all other layers (except your default layer). This function is special, because instead of just adding/removing one layer to your active layer stack, it will completely replace your current active layers, uniquely allowing you to replace higher layers with a lower one. This is activated on keydown (as soon as the key is pressed).
  30 * `TT(layer)` - Layer Tap-Toggle. If you hold the key down, *layer* is activated, and then is de-activated when you let go (like `MO`). If you repeatedly tap it, the layer will be toggled on or off (like `TG`). It needs 5 taps by default, but you can change this by defining `TAPPING_TOGGLE` -- for example, `#define TAPPING_TOGGLE 2` to toggle on just two taps.
  31
  32 # Working with Layers
  33
  34 Care must be taken when switching layers, it's possible to lock yourself into a layer with no way to deactivate that layer (without unplugging your keyboard.) We've created some guidelines to help users avoid the most common problems.
  35
  36 ### Beginners
  37
  38 If you are just getting started with QMK you will want to keep everything simple. Follow these guidelines when setting up your layers:
  39
  40 * Setup layer 0 as your default, "base" layer. This is your normal typing layer, and could be whatever layout you want (qwerty, dvorak, colemak, etc.). It's important to set this as the lowest layer since it will typically have most or all of the keyboard's keys defined, so would block other layers from having any effect if it were above them (i.e., had a higher layer number).
  41 * Arrange your layers in a "tree" layout, with layer 0 as the root. Do not try to enter the same layer from more than one other layer.
  42 * In a layer's keymap, only reference higher-numbered layers. Because layers are processed from the highest-numbered (topmost) active layer down, modifying the state of lower layers can be tricky and error-prone.
  43
  44 ### Intermediate Users
  45
  46 Sometimes you need more than one base layer. For example, if you want to switch between QWERTY and Dvorak, switch between layouts for different countries, or switch your layout for different videogames. Your base layers should always be the lowest numbered layers. When you have multiple base layers you should always treat them as mutually exclusive. When one base layer is on the others are off.
  47
  48 ### Advanced Users
  49
  50 Once you have a good feel for how layers work and what you can do, you can get more creative. The rules listed in the beginner section will help you be successful by avoiding some of the tricker details but they can be constraining, especially for ultra-compact keyboard users. Understanding how layers work will allow you to use them in more advanced ways.
  51
  52 Layers stack on top of each other in numerical order. When determining what a keypress does, QMK scans the layers from the top down, stopping when it reaches the first active layer that is not set to `KC_TRNS`. As a result if you activate a layer that is numerically lower than your current layer, and your current layer (or another layer that is active and higher than your target layer) has something other than `KC_TRNS`, that is the key that will be sent, not the key on the layer you just activated. This is the cause of most people's "why doesn't my layer get switched" problem.
  53
  54 Sometimes, you might want to switch between layers in a macro or as part of a tap dance routine. `layer_on` activates a layer, and `layer_off` deactivates it. More layer-related functions can be found in [action_layer.h](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action_layer.h).
  55
  56 # Modifier Keys
  57
  58 These functions allow you to combine a mod with a keycode. When pressed the keydown for the mod will be sent first, and then *kc* will be sent. When released the keyup for *kc* will be sent and then the mod will be sent.
  59
  60 * `LSFT(kc)` or `S(kc)` - applies left Shift to *kc* (keycode)
  61 * `RSFT(kc)` - applies right Shift to *kc*
  62 * `LCTL(kc)` - applies left Control to *kc*
  63 * `RCTL(kc)` - applies right Control to *kc*
  64 * `LALT(kc)` - applies left Alt to *kc*
  65 * `RALT(kc)` - applies right Alt to *kc*
  66 * `LGUI(kc)` - applies left GUI (command/win) to *kc*
  67 * `RGUI(kc)` - applies right GUI (command/win) to *kc*
  68 * `HYPR(kc)` - applies Hyper (all modifiers) to *kc*
  69 * `MEH(kc)`  - applies Meh (all modifiers except Win/Cmd) to *kc*
  70 * `LCAG(kc)` - applies CtrlAltGui to *kc*
  71
  72 You can also chain these, like this:
  73
  74     LALT(LCTL(KC_DEL)) -- this makes a key that sends Alt, Control, and Delete in a single keypress.
  75
  76 # Shifted Keycodes
  77
  78 The following shortcuts automatically add `LSFT()` to keycodes to get commonly used symbols.
  79
  80 |Key                     |Aliases           |Description        |
  81 |------------------------|------------------|-------------------|
  82 |`KC_TILDE`              |`KC_TILD`         |`~`                |
  83 |`KC_EXCLAIM`            |`KC_EXLM`         |`!`                |
  84 |`KC_AT`                 |                  |`@`                |
  85 |`KC_HASH`               |                  |`#`                |
  86 |`KC_DOLLAR`             |`KC_DLR`          |`$`                |
  87 |`KC_PERCENT`            |`KC_PERC`         |`%`                |
  88 |`KC_CIRCUMFLEX`         |`KC_CIRC`         |`^`                |
  89 |`KC_AMPERSAND`          |`KC_AMPR`         |`&`                |
  90 |`KC_ASTERISK`           |`KC_ASTR`         |`*`                |
  91 |`KC_LEFT_PAREN`         |`KC_LPRN`         |`(`                |
  92 |`KC_RIGHT_PAREN`        |`KC_RPRN`         |`)`                |
  93 |`KC_UNDERSCORE`         |`KC_UNDS`         |`_`                |
  94 |`KC_PLUS`               |                  |`+`                |
  95 |`KC_LEFT_CURLY_BRACE`   |`KC_LCBR`         |`{`                |
  96 |`KC_RIGHT_CURLY_BRACE`  |`KC_RCBR`         |`}`                |
  97 |`KC_PIPE`               |                  |<code>&#124;</code>|
  98 |`KC_COLON`              |`KC_COLN`         |`:`                |
  99 |`KC_DOUBLE_QUOTE`       |`KC_DQT`/`KC_DQUO`|`"`                |
 100 |`KC_LEFT_ANGLE_BRACKET` |`KC_LT`/`KC_LABK` |`<`                |
 101 |`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>`                |
 102 |`KC_QUESTION`           |`KC_QUES`         |`?`                |
 103
 104 # Mod Tap
 105
 106 `MT(mod, kc)` - is *mod* (modifier key - MOD_LCTL, MOD_LSFT) when held, and *kc* when tapped. In other words, you can have a key that sends Esc (or the letter O or whatever) when you tap it, but works as a Control key or a Shift key when you hold it down.
 107
 108 These are the values you can use for the `mod` in `MT()` and `OSM()`:
 109
 110   * MOD_LCTL
 111   * MOD_LSFT
 112   * MOD_LALT
 113   * MOD_LGUI
 114   * MOD_RCTL
 115   * MOD_RSFT
 116   * MOD_RALT
 117   * MOD_RGUI
 118   * MOD_HYPR
 119   * MOD_MEH
 120
 121 These can also be combined like `MOD_LCTL | MOD_LSFT` e.g. `MT(MOD_LCTL | MOD_LSFT, KC_ESC)` which would activate Control and Shift when held, and send Escape when tapped.
 122
 123 We've added shortcuts to make common modifier/tap (mod-tap) mappings more compact:
 124
 125   * `CTL_T(kc)` - is LCTL when held and *kc* when tapped
 126   * `SFT_T(kc)` - is LSFT when held and *kc* when tapped
 127   * `ALT_T(kc)` - is LALT when held and *kc* when tapped
 128   * `ALGR_T(kc)` - is AltGr when held and *kc* when tapped
 129   * `GUI_T(kc)` - is LGUI when held and *kc* when tapped
 130   * `ALL_T(kc)` - is Hyper (all mods) when held and *kc* when tapped. To read more about what you can do with a Hyper key, see [this blog post by Brett Terpstra](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)
 131   * `LCAG_T(kc)` - is CtrlAltGui when held and *kc* when tapped
 132   * `MEH_T(kc)` - is like Hyper, but not as cool -- does not include the Cmd/Win key, so just sends Alt+Ctrl+Shift.
 133
 134 ?> Due to the way that keycodes are structured, any modifiers specified as part of `kc`, such as `LCTL()` or `KC_LPRN`, will only activate when held instead of tapped.
 135
 136 ?> Additionally, if there is at least one right modifier, any other modifiers will turn into their right equivalents, so it is not possible to "mix and match" the two.
 137
 138 # One Shot Keys
 139
 140 One shot keys are keys that remain active until the next key is pressed, and then are released. This allows you to type keyboard combinations without pressing more than one key at a time. These keys are usually called "Sticky keys" or "Dead keys".
 141
 142 For example, if you define a key as `OSM(MOD_LSFT)`, you can type a capital A character by first pressing and releasing shift, and then pressing and releasing A. Your computer will see the shift key being held the moment shift is pressed, and it will see the shift key being released immediately after A is released.
 143
 144 One shot keys also work as normal modifiers. If you hold down a one shot key and type other keys, your one shot will be released immediately after you let go of the key.
 145
 146 You can control the behavior of one shot keys by defining these in `config.h`:
 147
 148 ```c
 149 #define ONESHOT_TAP_TOGGLE 5  /* Tapping this number of times holds the key until tapped this number of times again. */
 150 #define ONESHOT_TIMEOUT 5000  /* Time (in ms) before the one shot key is released */
 151 ```
 152
 153 * `OSM(mod)` - Momentarily hold down *mod*. You must use the `MOD_*` keycodes as shown in [Mod Tap](#mod-tap), not the `KC_*` codes.
 154 * `OSL(layer)` - momentary switch to *layer*.
 155
 156 Sometimes, you want to activate a one-shot layer as part of a macro or tap dance routine. To do this, you need to call `set_oneshot_layer(LAYER, ONESHOT_START)` on key down, and `set_oneshot_layer(ONESHOT_PRESSED)` on key up. If you want to cancel the oneshot, call `reset_oneshot_layer()`. For more complicated actions, take a look at the oneshot implementation in [`process_record`](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action.c#L429).
 157
 158 If you're having issues with OSM translating over Remote Desktop Connection, this can be fixed by opening the settings, going to the "Local Resources" tap, and in the keyboard section, change the drop down to "On this Computer".  This will fix the issue and allow OSM to function properly over Remote Desktop.
 159
 160 # Permissive Hold
 161
 162 As of [PR#1359](https://github.com/qmk/qmk_firmware/pull/1359/), there is a new `config.h` option:
 163
 164 ```
 165 #define PERMISSIVE_HOLD
 166 ```
 167
 168 This makes it easier for fast typists to use dual-function keys. Without this, if you let go of a held key inside the tapping term, it won't register.
 169
 170 Example: (Tapping Term = 200ms)
 171
 172 - SHFT_T(KC_A) Down
 173 - KC_X Down
 174 - KC_X Up
 175 - SHFT_T(KC_A) Up
 176
 177 With defaults, if above is typed within tapping term, this will emit `ax`. With permissive hold, if above is typed within tapping term, this will emit `X` (so, Shift+X).