aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/_summary.md7
-rw-r--r--docs/custom_keycode_names.md366
-rw-r--r--docs/feature_advanced_keycodes.md333
-rw-r--r--docs/mod_tap.md54
-rw-r--r--docs/one_shot_keys.md102
-rw-r--r--docs/tap_hold.md128
6 files changed, 661 insertions, 329 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index 1d877c211..3515e0d67 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -53,14 +53,16 @@
53 * Simple Keycodes 53 * Simple Keycodes
54 * [Full List](keycodes.md) 54 * [Full List](keycodes.md)
55 * [Basic Keycodes](keycodes_basic.md) 55 * [Basic Keycodes](keycodes_basic.md)
56 * [Advanced Keycodes](feature_advanced_keycodes.md) 56 * [Layer Switching](feature_advanced_keycodes.md)
57 * [Quantum Keycodes](quantum_keycodes.md) 57 * [Quantum Keycodes](quantum_keycodes.md)
58 58
59 * Advanced Keycodes 59 * Advanced Keycodes
60 * [Command](feature_command.md) 60 * [Command](feature_command.md)
61 * [Custom Keycodes](custom_keycode_names.md)
61 * [Dynamic Macros](feature_dynamic_macros.md) 62 * [Dynamic Macros](feature_dynamic_macros.md)
62 * [Grave Escape](feature_grave_esc.md) 63 * [Grave Escape](feature_grave_esc.md)
63 * [Leader Key](feature_leader_key.md) 64 * [Leader Key](feature_leader_key.md)
65 * [Mod-Tap](mod_tap.md)
64 * [Macros](feature_macros.md) 66 * [Macros](feature_macros.md)
65 * [Mouse Keys](feature_mouse_keys.md) 67 * [Mouse Keys](feature_mouse_keys.md)
66 * [Space Cadet Shift](feature_space_cadet.md) 68 * [Space Cadet Shift](feature_space_cadet.md)
@@ -71,10 +73,11 @@
71 * [Combos](feature_combo.md) 73 * [Combos](feature_combo.md)
72 * [Debounce API](feature_debounce_type.md) 74 * [Debounce API](feature_debounce_type.md)
73 * [Key Lock](feature_key_lock.md) 75 * [Key Lock](feature_key_lock.md)
74 * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) 76 * [One Shot Keys](one_shot_keys.md)
75 * [Pointing Device](feature_pointing_device.md) 77 * [Pointing Device](feature_pointing_device.md)
76 * [Swap Hands](feature_swap_hands.md) 78 * [Swap Hands](feature_swap_hands.md)
77 * [Tap Dance](feature_tap_dance.md) 79 * [Tap Dance](feature_tap_dance.md)
80 * [Tap-Hold Configuration](tap_hold.md)
78 * [Terminal](feature_terminal.md) 81 * [Terminal](feature_terminal.md)
79 * [Unicode](feature_unicode.md) 82 * [Unicode](feature_unicode.md)
80 * [Userspace](feature_userspace.md) 83 * [Userspace](feature_userspace.md)
diff --git a/docs/custom_keycode_names.md b/docs/custom_keycode_names.md
new file mode 100644
index 000000000..ebb24dc99
--- /dev/null
+++ b/docs/custom_keycode_names.md
@@ -0,0 +1,366 @@
1# Advanced Keycodes
2
3Your keymap can include keycodes that are more advanced than normal, for example keys that switch layers or send modifiers when held, but send regular keycodes when tapped. This page documents the functions that are available to you.
4
5## Assigning Custom Names
6
7People 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
14This will allow you to use `FN_CAPS` and `ALT_TAB` in your keymap, keeping it more readable.
15
16## Caveats
17
18Currently, `LT()` and `MT()` are limited to the [Basic Keycode set](keycodes_basic.md), meaning you can't use keycodes like `LCTL()`, `KC_TILD`, or anything greater than `0xFF`. Modifiers specified as part of a Layer Tap or Mod Tap's keycode will be ignored. If you need to apply modifiers to your tapped keycode, [Tap Dance](feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) can be used to accomplish this.
19
20Additionally, if at least one right-handed modifier is specified in a Mod Tap or Layer Tap, it will cause all modifiers specified to become right-handed, so it is not possible to mix and match the two.
21
22# Switching and Toggling Layers
23
24These 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). When using momentary layer switching with MO(), LM(), TT(), or LT(), make sure to leave the key on the above layers transparent or it may not work as intended.
25
26* `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).)
27* `MO(layer)` - momentarily activates *layer*. As soon as you let go of the key, the layer is deactivated.
28* `LM(layer, mod)` - Momentarily activates *layer* (like `MO`), but with modifier(s) *mod* active. Only supports layers 0-15 and the left modifiers: `MOD_LCTL`, `MOD_LSFT`, `MOD_LALT`, `MOD_LGUI` (note the use of `MOD_` constants instead of `KC_`). These modifiers can be combined using bitwise OR, e.g. `LM(_RAISE, MOD_LCTL | MOD_LALT)`.
29* `LT(layer, kc)` - momentarily activates *layer* when held, and sends *kc* when tapped. Only supports layers 0-15.
30* `OSL(layer)` - momentarily activates *layer* until the next key is pressed. See [One Shot Keys](#one-shot-keys) for details and additional functionality.
31* `TG(layer)` - toggles *layer*, activating it if it's inactive and vice versa
32* `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).
33* `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.
34
35# Working with Layers
36
37Care 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.
38
39## Beginners
40
41If you are just getting started with QMK you will want to keep everything simple. Follow these guidelines when setting up your layers:
42
43* 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).
44* 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.
45* 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.
46
47## Intermediate Users
48
49Sometimes 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.
50
51## Advanced Users
52
53Once 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.
54
55Layers 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.
56
57Sometimes, 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).
58
59# Modifier Keys
60
61These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent.
62
63|Key |Aliases |Description |
64|----------|-------------------------------|----------------------------------------------------|
65|`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` |
66|`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` |
67|`LALT(kc)`|`A(kc)` |Hold Left Alt and press `kc` |
68|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` |
69|`RCTL(kc)`| |Hold Right Control and press `kc` |
70|`RSFT(kc)`| |Hold Right Shift and press `kc` |
71|`RALT(kc)`|`ALGR(kc)` |Hold Right Alt and press `kc` |
72|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)` |Hold Right GUI and press `kc` |
73|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)` |Hold Left Shift and GUI and press `kc` |
74|`LCA(kc)` | |Hold Left Control and Alt and press `kc` |
75|`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` |
76|`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` |
77|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`|
78
79You can also chain them, for example `LCTL(LALT(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress.
80
81# Mod-Tap
82
83The Mod-Tap key `MT(mod, kc)` acts like a modifier when held, and a regular keycode when tapped. In other words, you can have a key that sends Escape when you tap it, but functions as a Control or Shift key when you hold it down.
84
85The modifiers this keycode and `OSM()` accept are prefixed with `MOD_`, not `KC_`:
86
87|Modifier |Description |
88|----------|----------------------------------------|
89|`MOD_LCTL`|Left Control |
90|`MOD_LSFT`|Left Shift |
91|`MOD_LALT`|Left Alt |
92|`MOD_LGUI`|Left GUI (Windows/Command/Meta key) |
93|`MOD_RCTL`|Right Control |
94|`MOD_RSFT`|Right Shift |
95|`MOD_RALT`|Right Alt (AltGr) |
96|`MOD_RGUI`|Right GUI (Windows/Command/Meta key) |
97|`MOD_HYPR`|Hyper (Left Control, Shift, Alt and GUI)|
98|`MOD_MEH` |Meh (Left Control, Shift, and Alt) |
99
100You can combine these by ORing them together like so:
101
102```c
103MT(MOD_LCTL | MOD_LSFT, KC_ESC)
104```
105
106This key would activate Left Control and Left Shift when held, and send Escape when tapped.
107
108For convenience, QMK includes some Mod-Tap shortcuts to make common combinations more compact in your keymap:
109
110|Key |Aliases |Description |
111|------------|-----------------------------------------------------------------|-------------------------------------------------------|
112|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped |
113|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
114|`LALT_T(kc)`|`ALT_T(kc)` |Left Alt when held, `kc` when tapped |
115|`LGUI_T(kc)`|`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
116|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped |
117|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped |
118|`RALT_T(kc)`|`ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
119|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
120|`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
121|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
122|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped |
123|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped |
124|`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped |
125|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped|
126|`HYPR_T(kc)`|`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
127
128## Caveats
129
130Unfortunately, these keycodes cannot be used in Mod-Taps or Layer-Taps, since any modifiers specified in the keycode are ignored.
131
132Additionally, you may run into issues when using Remote Desktop Connection on Windows. Because these codes send shift very fast, Remote Desktop may miss the codes.
133
134To fix this, open Remote Desktop Connection, click on "Show Options", open the the "Local Resources" tab. In the keyboard section, change the drop down to "On this Computer". This will fix the issue, and allow the characters to work correctly.
135
136# One Shot Keys
137
138One 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".
139
140For 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.
141
142One 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.
143
144Additionally, hitting keys five times in a short period will lock that key. This applies for both One Shot Modifiers and One Shot Layers, and is controlled by the `ONESHOT_TAP_TOGGLE` define.
145
146You 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 once 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
156Sometimes, you want to activate a one-shot key as part of a macro or tap dance routine.
157
158For one shot layers, you need to call `set_oneshot_layer(LAYER, ONESHOT_START)` on key down, and `clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED)` on key up. If you want to cancel the oneshot, call `reset_oneshot_layer()`.
159
160For one shot mods, you need to call `set_oneshot_mods(MOD)` to set it, or `clear_oneshot_mods()` to cancel it.
161
162!> 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.
163
164## Callbacks
165
166When you'd like to perform custom logic when pressing a one shot key, there are several callbacks you can choose to implement. You could indicate changes in one shot keys by flashing an LED or making a sound, for example.
167
168There is a callback for `OSM(mod)`. It is called whenever the state of any one shot modifier key is changed: when it toggles on, but also when it is toggled off. You can use it like this:
169
170```c
171void oneshot_mods_changed_user(uint8_t mods) {
172 if (mods & MOD_MASK_SHIFT) {
173 println("Oneshot mods SHIFT");
174 }
175 if (mods & MOD_MASK_CTRL) {
176 println("Oneshot mods CTRL");
177 }
178 if (mods & MOD_MASK_ALT) {
179 println("Oneshot mods ALT");
180 }
181 if (mods & MOD_MASK_GUI) {
182 println("Oneshot mods GUI");
183 }
184 if (!mods) {
185 println("Oneshot mods off");
186 }
187}
188```
189
190The `mods` argument contains the active mods after the change, so it reflects the current state.
191
192When you use One Shot Tap Toggle (by adding `#define ONESHOT_TAP_TOGGLE 2` in your `config.h` file), you may lock a modifier key by pressing it the specified amount of times. There's a callback for that, too:
193
194```c
195void oneshot_locked_mods_changed_user(uint8_t mods) {
196 if (mods & MOD_MASK_SHIFT) {
197 println("Oneshot locked mods SHIFT");
198 }
199 if (mods & MOD_MASK_CTRL) {
200 println("Oneshot locked mods CTRL");
201 }
202 if (mods & MOD_MASK_ALT) {
203 println("Oneshot locked mods ALT");
204 }
205 if (mods & MOD_MASK_GUI) {
206 println("Oneshot locked mods GUI");
207 }
208 if (!mods) {
209 println("Oneshot locked mods off");
210 }
211}
212```
213
214Last, there is also a callback for the `OSL(layer)` one shot key:
215
216```c
217void oneshot_layer_changed_user(uint8_t layer) {
218 if (layer == 1) {
219 println("Oneshot layer 1 on");
220 }
221 if (!layer) {
222 println("Oneshot layer off");
223 }
224}
225```
226
227If any one shot layer is switched off, `layer` will be zero. When you're looking to do something on any layer change instead of one shot layer changes, `layer_state_set_user` is a better callback to use.
228
229If you are making your own keyboard, there are also `_kb` equivalent functions:
230
231```c
232void oneshot_locked_mods_changed_kb(uint8_t mods);
233void oneshot_mods_changed_kb(uint8_t mods);
234void oneshot_layer_changed_kb(uint8_t layer);
235```
236
237As with any callback, be sure to call the `_user` variant to allow for further customizability.
238
239# Tap-Hold Configuration Options
240
241While Tap-Hold options are fantastic, they are not without their issues. We have tried to configure them with reasonal defaults, but that may still cause issues for some people.
242
243These options let you modify the behavior of the Tap-Hold keys.
244
245## Permissive Hold
246
247As of [PR#1359](https://github.com/qmk/qmk_firmware/pull/1359/), there is a new `config.h` option:
248
249```c
250#define PERMISSIVE_HOLD
251```
252
253This makes tap and hold keys (like Mod Tap) work better for fast typist, or for high `TAPPING_TERM` settings.
254
255If you press a Mod Tap key, tap another key (press and release) and then release the Mod Tap key, all within the tapping term, it will output the "tapping" function for both keys.
256
257For Instance:
258
259- `SFT_T(KC_A)` Down
260- `KC_X` Down
261- `KC_X` Up
262- `SFT_T(KC_A)` Up
263
264Normally, if you do all this within the `TAPPING_TERM` (default: 200ms) this will be registered as `ax` by the firmware and host system. With permissive hold enabled, this modifies how this is handled by considering the Mod Tap keys as a Mod if another key is tapped, and would registered as `X` (`SHIFT`+`x`).
265
266?> If you have `Ignore Mod Tap Interrupt` enabled, as well, this will modify how both work. The regular key has the modifier added if the first key is released first or if both keys are held longer than the `TAPPING_TERM`.
267
268## Ignore Mod Tap Interrupt
269
270To enable this setting, add this to your `config.h`:
271
272```c
273#define IGNORE_MOD_TAP_INTERRUPT
274```
275
276Similar to Permissive Hold, this alters how the firmware processes input for fast typist. If you press a Mod Tap key, press another key, release the Mod Tap key, and then release the normal key, it would normally output the "tapping" function for both keys. This may not be desirable for rolling combo keys.
277
278Setting `Ignore Mod Tap Interrupt` requires holding both keys for the `TAPPING_TERM` to trigger the hold function (the mod).
279
280For Instance:
281
282- `SFT_T(KC_A)` Down
283- `KC_X` Down
284- `SFT_T(KC_A)` Up
285- `KC_X` Up
286
287Normally, this would send `X` (`SHIFT`+`x`). With `Ignore Mod Tap Interrupt` enabled, holding both keys are required for the `TAPPING_TERM` to register the hold action. A quick tap will output `ax` in this case, while a hold on both will still output `X` (`SHIFT`+`x`).
288
289
290?> __Note__: This only concerns modifiers and not layer switching keys.
291
292?> If you have `Permissive Hold` enabled, as well, this will modify how both work. The regular key has the modifier added if the first key is released first or if both keys are held longer than the `TAPPING_TERM`.
293
294For more granular control of this feature, you can add the following to your `config.h`:
295
296```c
297#define IGNORE_MOD_TAP_INTERRUPT_PER_KEY
298```
299
300You can then add the following function to your keymap:
301
302```c
303bool get_ignore_mod_tap_interrupt(uint16_t keycode) {
304 switch (keycode) {
305 case SFT_T(KC_SPC):
306 return true;
307 default:
308 return false;
309 }
310}
311```
312
313## Tapping Force Hold
314
315To enable `tapping force hold`, add the following to your `config.h`:
316
317```c
318#define TAPPING_FORCE_HOLD
319```
320
321When the user holds a key after tap, this repeats the tapped key rather to hold a modifier key. This allows to use auto repeat for the tapped key.
322
323Example:
324
325- SFT_T(KC_A) Down
326- SFT_T(KC_A) Up
327- SFT_T(KC_A) Down
328- wait more than tapping term...
329- SFT_T(KC_A) Up
330
331With default settings, `a` will be sent on the first release, then `a` will be sent on the second press allowing the computer to trigger its auto repeat function.
332
333With `TAPPING_FORCE_HOLD`, the second press will be interpreted as a Shift, allowing to use it as a modifier shortly after having used it as a tap.
334
335!> `TAPPING_FORCE_HOLD` will break anything that uses tapping toggles (Such as the `TT` layer keycode, and the One Shot Tapping Toggle).
336
337For more granular control of this feature, you can add the following to your `config.h`:
338
339```c
340#define TAPPING_FORCE_HOLD_PER_KEY
341```
342
343You can then add the following function to your keymap:
344
345```c
346bool get_tapping_force_hold(uint16_t keycode, keyrecord_t *record) {
347 switch (keycode) {
348 case LT(1, KC_BSPC):
349 return true;
350 default:
351 return false;
352 }
353}
354```
355
356## Retro Tapping
357
358To enable `retro tapping`, add the following to your `config.h`:
359
360```c
361#define RETRO_TAPPING
362```
363
364Holding and releasing a dual function key without pressing another key will result in nothing happening. With retro tapping enabled, releasing the key without pressing another will send the original keycode even if it is outside the tapping term.
365
366For instance, holding and releasing `LT(2, KC_SPACE)` without hitting another key will result in nothing happening. With this enabled, it will send `KC_SPACE` instead.
diff --git a/docs/feature_advanced_keycodes.md b/docs/feature_advanced_keycodes.md
index 8c3449460..fbb3de4f7 100644
--- a/docs/feature_advanced_keycodes.md
+++ b/docs/feature_advanced_keycodes.md
@@ -1,24 +1,3 @@
1# Advanced Keycodes
2
3Your keymap can include keycodes that are more advanced than normal, for example keys that switch layers or send modifiers when held, but send regular keycodes when tapped. This page documents the functions that are available to you.
4
5## Assigning Custom Names
6
7People 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
14This will allow you to use `FN_CAPS` and `ALT_TAB` in your keymap, keeping it more readable.
15
16## Caveats
17
18Currently, `LT()` and `MT()` are limited to the [Basic Keycode set](keycodes_basic.md), meaning you can't use keycodes like `LCTL()`, `KC_TILD`, or anything greater than `0xFF`. Modifiers specified as part of a Layer Tap or Mod Tap's keycode will be ignored. If you need to apply modifiers to your tapped keycode, [Tap Dance](feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) can be used to accomplish this.
19
20Additionally, if at least one right-handed modifier is specified in a Mod Tap or Layer Tap, it will cause all modifiers specified to become right-handed, so it is not possible to mix and match the two.
21
22# Switching and Toggling Layers 1# Switching and Toggling Layers
23 2
24These 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). When using momentary layer switching with MO(), LM(), TT(), or LT(), make sure to leave the key on the above layers transparent or it may not work as intended. 3These 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). When using momentary layer switching with MO(), LM(), TT(), or LT(), make sure to leave the key on the above layers transparent or it may not work as intended.
@@ -32,6 +11,12 @@ These functions allow you to activate layers in various ways. Note that layers a
32* `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). 11* `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).
33* `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. 12* `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.
34 13
14## Caveats
15
16Currently, `LT()` and `MT()` are limited to the [Basic Keycode set](keycodes_basic.md), meaning you can't use keycodes like `LCTL()`, `KC_TILD`, or anything greater than `0xFF`. Modifiers specified as part of a Layer Tap or Mod Tap's keycode will be ignored. If you need to apply modifiers to your tapped keycode, [Tap Dance](feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) can be used to accomplish this.
17
18Additionally, if at least one right-handed modifier is specified in a Mod Tap or Layer Tap, it will cause all modifiers specified to become right-handed, so it is not possible to mix and match the two.
19
35# Working with Layers 20# Working with Layers
36 21
37Care 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. 22Care 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.
@@ -77,309 +62,3 @@ These allow you to combine a modifier with a keycode. When pressed, the keydown
77|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`| 62|`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`|
78 63
79You can also chain them, for example `LCTL(LALT(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress. 64You can also chain them, for example `LCTL(LALT(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress.
80
81# Mod-Tap
82
83The Mod-Tap key `MT(mod, kc)` acts like a modifier when held, and a regular keycode when tapped. In other words, you can have a key that sends Escape when you tap it, but functions as a Control or Shift key when you hold it down.
84
85The modifiers this keycode and `OSM()` accept are prefixed with `MOD_`, not `KC_`:
86
87|Modifier |Description |
88|----------|----------------------------------------|
89|`MOD_LCTL`|Left Control |
90|`MOD_LSFT`|Left Shift |
91|`MOD_LALT`|Left Alt |
92|`MOD_LGUI`|Left GUI (Windows/Command/Meta key) |
93|`MOD_RCTL`|Right Control |
94|`MOD_RSFT`|Right Shift |
95|`MOD_RALT`|Right Alt (AltGr) |
96|`MOD_RGUI`|Right GUI (Windows/Command/Meta key) |
97|`MOD_HYPR`|Hyper (Left Control, Shift, Alt and GUI)|
98|`MOD_MEH` |Meh (Left Control, Shift, and Alt) |
99
100You can combine these by ORing them together like so:
101
102```c
103MT(MOD_LCTL | MOD_LSFT, KC_ESC)
104```
105
106This key would activate Left Control and Left Shift when held, and send Escape when tapped.
107
108For convenience, QMK includes some Mod-Tap shortcuts to make common combinations more compact in your keymap:
109
110|Key |Aliases |Description |
111|------------|-----------------------------------------------------------------|-------------------------------------------------------|
112|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped |
113|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
114|`LALT_T(kc)`|`ALT_T(kc)` |Left Alt when held, `kc` when tapped |
115|`LGUI_T(kc)`|`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
116|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped |
117|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped |
118|`RALT_T(kc)`|`ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
119|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
120|`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
121|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
122|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped |
123|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped |
124|`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped |
125|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped|
126|`HYPR_T(kc)`|`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
127
128## Caveats
129
130Unfortunately, these keycodes cannot be used in Mod-Taps or Layer-Taps, since any modifiers specified in the keycode are ignored.
131
132Additionally, you may run into issues when using Remote Desktop Connection on Windows. Because these codes send shift very fast, Remote Desktop may miss the codes.
133
134To fix this, open Remote Desktop Connection, click on "Show Options", open the the "Local Resources" tab. In the keyboard section, change the drop down to "On this Computer". This will fix the issue, and allow the characters to work correctly.
135
136# One Shot Keys
137
138One 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".
139
140For 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.
141
142One 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.
143
144Additionally, hitting keys five times in a short period will lock that key. This applies for both One Shot Modifiers and One Shot Layers, and is controlled by the `ONESHOT_TAP_TOGGLE` define.
145
146You 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 once 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
156Sometimes, you want to activate a one-shot key as part of a macro or tap dance routine.
157
158For one shot layers, you need to call `set_oneshot_layer(LAYER, ONESHOT_START)` on key down, and `clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED)` on key up. If you want to cancel the oneshot, call `reset_oneshot_layer()`.
159
160For one shot mods, you need to call `set_oneshot_mods(MOD)` to set it, or `clear_oneshot_mods()` to cancel it.
161
162!> 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.
163
164## Callbacks
165
166When you'd like to perform custom logic when pressing a one shot key, there are several callbacks you can choose to implement. You could indicate changes in one shot keys by flashing an LED or making a sound, for example.
167
168There is a callback for `OSM(mod)`. It is called whenever the state of any one shot modifier key is changed: when it toggles on, but also when it is toggled off. You can use it like this:
169
170```c
171void oneshot_mods_changed_user(uint8_t mods) {
172 if (mods & MOD_MASK_SHIFT) {
173 println("Oneshot mods SHIFT");
174 }
175 if (mods & MOD_MASK_CTRL) {
176 println("Oneshot mods CTRL");
177 }
178 if (mods & MOD_MASK_ALT) {
179 println("Oneshot mods ALT");
180 }
181 if (mods & MOD_MASK_GUI) {
182 println("Oneshot mods GUI");
183 }
184 if (!mods) {
185 println("Oneshot mods off");
186 }
187}
188```
189
190The `mods` argument contains the active mods after the change, so it reflects the current state.
191
192When you use One Shot Tap Toggle (by adding `#define ONESHOT_TAP_TOGGLE 2` in your `config.h` file), you may lock a modifier key by pressing it the specified amount of times. There's a callback for that, too:
193
194```c
195void oneshot_locked_mods_changed_user(uint8_t mods) {
196 if (mods & MOD_MASK_SHIFT) {
197 println("Oneshot locked mods SHIFT");
198 }
199 if (mods & MOD_MASK_CTRL) {
200 println("Oneshot locked mods CTRL");
201 }
202 if (mods & MOD_MASK_ALT) {
203 println("Oneshot locked mods ALT");
204 }
205 if (mods & MOD_MASK_GUI) {
206 println("Oneshot locked mods GUI");
207 }
208 if (!mods) {
209 println("Oneshot locked mods off");
210 }
211}
212```
213
214Last, there is also a callback for the `OSL(layer)` one shot key:
215
216```c
217void oneshot_layer_changed_user(uint8_t layer) {
218 if (layer == 1) {
219 println("Oneshot layer 1 on");
220 }
221 if (!layer) {
222 println("Oneshot layer off");
223 }
224}
225```
226
227If any one shot layer is switched off, `layer` will be zero. When you're looking to do something on any layer change instead of one shot layer changes, `layer_state_set_user` is a better callback to use.
228
229If you are making your own keyboard, there are also `_kb` equivalent functions:
230
231```c
232void oneshot_locked_mods_changed_kb(uint8_t mods);
233void oneshot_mods_changed_kb(uint8_t mods);
234void oneshot_layer_changed_kb(uint8_t layer);
235```
236
237As with any callback, be sure to call the `_user` variant to allow for further customizability.
238
239# Tap-Hold Configuration Options
240
241While Tap-Hold options are fantastic, they are not without their issues. We have tried to configure them with reasonal defaults, but that may still cause issues for some people.
242
243These options let you modify the behavior of the Tap-Hold keys.
244
245## Permissive Hold
246
247As of [PR#1359](https://github.com/qmk/qmk_firmware/pull/1359/), there is a new `config.h` option:
248
249```c
250#define PERMISSIVE_HOLD
251```
252
253This makes tap and hold keys (like Mod Tap) work better for fast typist, or for high `TAPPING_TERM` settings.
254
255If you press a Mod Tap key, tap another key (press and release) and then release the Mod Tap key, all within the tapping term, it will output the "tapping" function for both keys.
256
257For Instance:
258
259- `SFT_T(KC_A)` Down
260- `KC_X` Down
261- `KC_X` Up
262- `SFT_T(KC_A)` Up
263
264Normally, if you do all this within the `TAPPING_TERM` (default: 200ms) this will be registered as `ax` by the firmware and host system. With permissive hold enabled, this modifies how this is handled by considering the Mod Tap keys as a Mod if another key is tapped, and would registered as `X` (`SHIFT`+`x`).
265
266?> If you have `Ignore Mod Tap Interrupt` enabled, as well, this will modify how both work. The regular key has the modifier added if the first key is released first or if both keys are held longer than the `TAPPING_TERM`.
267
268For more granular control of this feature, you can add the following to your `config.h`:
269
270```c
271#define PERMISSIVE_HOLD_PER_KEY
272```
273
274You can then add the following function to your keymap:
275
276```c
277bool get_permissive_hold(uint16_t keycode, keyrecord_t *record) {
278 switch (keycode) {
279 case SFT_T(KC_A):
280 return true;
281 default:
282 return false;
283 }
284}
285```
286
287## Ignore Mod Tap Interrupt
288
289To enable this setting, add this to your `config.h`:
290
291```c
292#define IGNORE_MOD_TAP_INTERRUPT
293```
294
295Similar to Permissive Hold, this alters how the firmware processes input for fast typist. If you press a Mod Tap key, press another key, release the Mod Tap key, and then release the normal key, it would normally output the "tapping" function for both keys. This may not be desirable for rolling combo keys.
296
297Setting `Ignore Mod Tap Interrupt` requires holding both keys for the `TAPPING_TERM` to trigger the hold function (the mod).
298
299For Instance:
300
301- `SFT_T(KC_A)` Down
302- `KC_X` Down
303- `SFT_T(KC_A)` Up
304- `KC_X` Up
305
306Normally, this would send `X` (`SHIFT`+`x`). With `Ignore Mod Tap Interrupt` enabled, holding both keys are required for the `TAPPING_TERM` to register the hold action. A quick tap will output `ax` in this case, while a hold on both will still output `X` (`SHIFT`+`x`).
307
308
309?> __Note__: This only concerns modifiers and not layer switching keys.
310
311?> If you have `Permissive Hold` enabled, as well, this will modify how both work. The regular key has the modifier added if the first key is released first or if both keys are held longer than the `TAPPING_TERM`.
312
313For more granular control of this feature, you can add the following to your `config.h`:
314
315```c
316#define IGNORE_MOD_TAP_INTERRUPT_PER_KEY
317```
318
319You can then add the following function to your keymap:
320
321```c
322bool get_ignore_mod_tap_interrupt(uint16_t keycode) {
323 switch (keycode) {
324 case SFT_T(KC_SPC):
325 return true;
326 default:
327 return false;
328 }
329}
330```
331
332## Tapping Force Hold
333
334To enable `tapping force hold`, add the following to your `config.h`:
335
336```c
337#define TAPPING_FORCE_HOLD
338```
339
340When the user holds a key after tap, this repeats the tapped key rather to hold a modifier key. This allows to use auto repeat for the tapped key.
341
342Example:
343
344- SFT_T(KC_A) Down
345- SFT_T(KC_A) Up
346- SFT_T(KC_A) Down
347- wait more than tapping term...
348- SFT_T(KC_A) Up
349
350With default settings, `a` will be sent on the first release, then `a` will be sent on the second press allowing the computer to trigger its auto repeat function.
351
352With `TAPPING_FORCE_HOLD`, the second press will be interpreted as a Shift, allowing to use it as a modifier shortly after having used it as a tap.
353
354!> `TAPPING_FORCE_HOLD` will break anything that uses tapping toggles (Such as the `TT` layer keycode, and the One Shot Tapping Toggle).
355
356For more granular control of this feature, you can add the following to your `config.h`:
357
358```c
359#define TAPPING_FORCE_HOLD_PER_KEY
360```
361
362You can then add the following function to your keymap:
363
364```c
365bool get_tapping_force_hold(uint16_t keycode, keyrecord_t *record) {
366 switch (keycode) {
367 case LT(1, KC_BSPC):
368 return true;
369 default:
370 return false;
371 }
372}
373```
374
375## Retro Tapping
376
377To enable `retro tapping`, add the following to your `config.h`:
378
379```c
380#define RETRO_TAPPING
381```
382
383Holding and releasing a dual function key without pressing another key will result in nothing happening. With retro tapping enabled, releasing the key without pressing another will send the original keycode even if it is outside the tapping term.
384
385For instance, holding and releasing `LT(2, KC_SPACE)` without hitting another key will result in nothing happening. With this enabled, it will send `KC_SPACE` instead.
diff --git a/docs/mod_tap.md b/docs/mod_tap.md
new file mode 100644
index 000000000..2b86701ca
--- /dev/null
+++ b/docs/mod_tap.md
@@ -0,0 +1,54 @@
1# Mod-Tap
2
3The Mod-Tap key `MT(mod, kc)` acts like a modifier when held, and a regular keycode when tapped. In other words, you can have a key that sends Escape when you tap it, but functions as a Control or Shift key when you hold it down.
4
5The modifiers this keycode and `OSM()` accept are prefixed with `MOD_`, not `KC_`:
6
7|Modifier |Description |
8|----------|----------------------------------------|
9|`MOD_LCTL`|Left Control |
10|`MOD_LSFT`|Left Shift |
11|`MOD_LALT`|Left Alt |
12|`MOD_LGUI`|Left GUI (Windows/Command/Meta key) |
13|`MOD_RCTL`|Right Control |
14|`MOD_RSFT`|Right Shift |
15|`MOD_RALT`|Right Alt (AltGr) |
16|`MOD_RGUI`|Right GUI (Windows/Command/Meta key) |
17|`MOD_HYPR`|Hyper (Left Control, Shift, Alt and GUI)|
18|`MOD_MEH` |Meh (Left Control, Shift, and Alt) |
19
20You can combine these by ORing them together like so:
21
22```c
23MT(MOD_LCTL | MOD_LSFT, KC_ESC)
24```
25
26This key would activate Left Control and Left Shift when held, and send Escape when tapped.
27
28For convenience, QMK includes some Mod-Tap shortcuts to make common combinations more compact in your keymap:
29
30|Key |Aliases |Description |
31|------------|-----------------------------------------------------------------|-------------------------------------------------------|
32|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped |
33|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped |
34|`LALT_T(kc)`|`ALT_T(kc)` |Left Alt when held, `kc` when tapped |
35|`LGUI_T(kc)`|`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped |
36|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped |
37|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped |
38|`RALT_T(kc)`|`ALGR_T(kc)` |Right Alt when held, `kc` when tapped |
39|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped |
40|`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped |
41|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped |
42|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped |
43|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped |
44|`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped |
45|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped|
46|`HYPR_T(kc)`|`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
47
48## Caveats
49
50Unfortunately, these keycodes cannot be used in Mod-Taps or Layer-Taps, since any modifiers specified in the keycode are ignored.
51
52Additionally, you may run into issues when using Remote Desktop Connection on Windows. Because these codes send shift very fast, Remote Desktop may miss the codes.
53
54To fix this, open Remote Desktop Connection, click on "Show Options", open the the "Local Resources" tab. In the keyboard section, change the drop down to "On this Computer". This will fix the issue, and allow the characters to work correctly.
diff --git a/docs/one_shot_keys.md b/docs/one_shot_keys.md
new file mode 100644
index 000000000..73d78b415
--- /dev/null
+++ b/docs/one_shot_keys.md
@@ -0,0 +1,102 @@
1# One Shot Keys
2
3One 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".
4
5For 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.
6
7One 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.
8
9Additionally, hitting keys five times in a short period will lock that key. This applies for both One Shot Modifiers and One Shot Layers, and is controlled by the `ONESHOT_TAP_TOGGLE` define.
10
11You can control the behavior of one shot keys by defining these in `config.h`:
12
13```c
14#define ONESHOT_TAP_TOGGLE 5 /* Tapping this number of times holds the key until tapped once again. */
15#define ONESHOT_TIMEOUT 5000 /* Time (in ms) before the one shot key is released */
16```
17
18* `OSM(mod)` - Momentarily hold down *mod*. You must use the `MOD_*` keycodes as shown in [Mod Tap](#mod-tap), not the `KC_*` codes.
19* `OSL(layer)` - momentary switch to *layer*.
20
21Sometimes, you want to activate a one-shot key as part of a macro or tap dance routine.
22
23For one shot layers, you need to call `set_oneshot_layer(LAYER, ONESHOT_START)` on key down, and `clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED)` on key up. If you want to cancel the oneshot, call `reset_oneshot_layer()`.
24
25For one shot mods, you need to call `set_oneshot_mods(MOD)` to set it, or `clear_oneshot_mods()` to cancel it.
26
27!> 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.
28
29## Callbacks
30
31When you'd like to perform custom logic when pressing a one shot key, there are several callbacks you can choose to implement. You could indicate changes in one shot keys by flashing an LED or making a sound, for example.
32
33There is a callback for `OSM(mod)`. It is called whenever the state of any one shot modifier key is changed: when it toggles on, but also when it is toggled off. You can use it like this:
34
35```c
36void oneshot_mods_changed_user(uint8_t mods) {
37 if (mods & MOD_MASK_SHIFT) {
38 println("Oneshot mods SHIFT");
39 }
40 if (mods & MOD_MASK_CTRL) {
41 println("Oneshot mods CTRL");
42 }
43 if (mods & MOD_MASK_ALT) {
44 println("Oneshot mods ALT");
45 }
46 if (mods & MOD_MASK_GUI) {
47 println("Oneshot mods GUI");
48 }
49 if (!mods) {
50 println("Oneshot mods off");
51 }
52}
53```
54
55The `mods` argument contains the active mods after the change, so it reflects the current state.
56
57When you use One Shot Tap Toggle (by adding `#define ONESHOT_TAP_TOGGLE 2` in your `config.h` file), you may lock a modifier key by pressing it the specified amount of times. There's a callback for that, too:
58
59```c
60void oneshot_locked_mods_changed_user(uint8_t mods) {
61 if (mods & MOD_MASK_SHIFT) {
62 println("Oneshot locked mods SHIFT");
63 }
64 if (mods & MOD_MASK_CTRL) {
65 println("Oneshot locked mods CTRL");
66 }
67 if (mods & MOD_MASK_ALT) {
68 println("Oneshot locked mods ALT");
69 }
70 if (mods & MOD_MASK_GUI) {
71 println("Oneshot locked mods GUI");
72 }
73 if (!mods) {
74 println("Oneshot locked mods off");
75 }
76}
77```
78
79Last, there is also a callback for the `OSL(layer)` one shot key:
80
81```c
82void oneshot_layer_changed_user(uint8_t layer) {
83 if (layer == 1) {
84 println("Oneshot layer 1 on");
85 }
86 if (!layer) {
87 println("Oneshot layer off");
88 }
89}
90```
91
92If any one shot layer is switched off, `layer` will be zero. When you're looking to do something on any layer change instead of one shot layer changes, `layer_state_set_user` is a better callback to use.
93
94If you are making your own keyboard, there are also `_kb` equivalent functions:
95
96```c
97void oneshot_locked_mods_changed_kb(uint8_t mods);
98void oneshot_mods_changed_kb(uint8_t mods);
99void oneshot_layer_changed_kb(uint8_t layer);
100```
101
102As with any callback, be sure to call the `_user` variant to allow for further customizability.
diff --git a/docs/tap_hold.md b/docs/tap_hold.md
new file mode 100644
index 000000000..77b20fa49
--- /dev/null
+++ b/docs/tap_hold.md
@@ -0,0 +1,128 @@
1# Tap-Hold Configuration Options
2
3While Tap-Hold options are fantastic, they are not without their issues. We have tried to configure them with reasonal defaults, but that may still cause issues for some people.
4
5These options let you modify the behavior of the Tap-Hold keys.
6
7## Permissive Hold
8
9As of [PR#1359](https://github.com/qmk/qmk_firmware/pull/1359/), there is a new `config.h` option:
10
11```c
12#define PERMISSIVE_HOLD
13```
14
15This makes tap and hold keys (like Mod Tap) work better for fast typist, or for high `TAPPING_TERM` settings.
16
17If you press a Mod Tap key, tap another key (press and release) and then release the Mod Tap key, all within the tapping term, it will output the "tapping" function for both keys.
18
19For Instance:
20
21- `SFT_T(KC_A)` Down
22- `KC_X` Down
23- `KC_X` Up
24- `SFT_T(KC_A)` Up
25
26Normally, if you do all this within the `TAPPING_TERM` (default: 200ms) this will be registered as `ax` by the firmware and host system. With permissive hold enabled, this modifies how this is handled by considering the Mod Tap keys as a Mod if another key is tapped, and would registered as `X` (`SHIFT`+`x`).
27
28?> If you have `Ignore Mod Tap Interrupt` enabled, as well, this will modify how both work. The regular key has the modifier added if the first key is released first or if both keys are held longer than the `TAPPING_TERM`.
29
30## Ignore Mod Tap Interrupt
31
32To enable this setting, add this to your `config.h`:
33
34```c
35#define IGNORE_MOD_TAP_INTERRUPT
36```
37
38Similar to Permissive Hold, this alters how the firmware processes input for fast typist. If you press a Mod Tap key, press another key, release the Mod Tap key, and then release the normal key, it would normally output the "tapping" function for both keys. This may not be desirable for rolling combo keys.
39
40Setting `Ignore Mod Tap Interrupt` requires holding both keys for the `TAPPING_TERM` to trigger the hold function (the mod).
41
42For Instance:
43
44- `SFT_T(KC_A)` Down
45- `KC_X` Down
46- `SFT_T(KC_A)` Up
47- `KC_X` Up
48
49Normally, this would send `X` (`SHIFT`+`x`). With `Ignore Mod Tap Interrupt` enabled, holding both keys are required for the `TAPPING_TERM` to register the hold action. A quick tap will output `ax` in this case, while a hold on both will still output `X` (`SHIFT`+`x`).
50
51
52?> __Note__: This only concerns modifiers and not layer switching keys.
53
54?> If you have `Permissive Hold` enabled, as well, this will modify how both work. The regular key has the modifier added if the first key is released first or if both keys are held longer than the `TAPPING_TERM`.
55
56For more granular control of this feature, you can add the following to your `config.h`:
57
58```c
59#define IGNORE_MOD_TAP_INTERRUPT_PER_KEY
60```
61
62You can then add the following function to your keymap:
63
64```c
65bool get_ignore_mod_tap_interrupt(uint16_t keycode) {
66 switch (keycode) {
67 case SFT_T(KC_SPC):
68 return true;
69 default:
70 return false;
71 }
72}
73```
74
75## Tapping Force Hold
76
77To enable `tapping force hold`, add the following to your `config.h`:
78
79```c
80#define TAPPING_FORCE_HOLD
81```
82
83When the user holds a key after tap, this repeats the tapped key rather to hold a modifier key. This allows to use auto repeat for the tapped key.
84
85Example:
86
87- SFT_T(KC_A) Down
88- SFT_T(KC_A) Up
89- SFT_T(KC_A) Down
90- wait more than tapping term...
91- SFT_T(KC_A) Up
92
93With default settings, `a` will be sent on the first release, then `a` will be sent on the second press allowing the computer to trigger its auto repeat function.
94
95With `TAPPING_FORCE_HOLD`, the second press will be interpreted as a Shift, allowing to use it as a modifier shortly after having used it as a tap.
96
97!> `TAPPING_FORCE_HOLD` will break anything that uses tapping toggles (Such as the `TT` layer keycode, and the One Shot Tapping Toggle).
98
99For more granular control of this feature, you can add the following to your `config.h`:
100
101```c
102#define TAPPING_FORCE_HOLD_PER_KEY
103```
104
105You can then add the following function to your keymap:
106
107```c
108bool get_tapping_force_hold(uint16_t keycode, keyrecord_t *record) {
109 switch (keycode) {
110 case LT(1, KC_BSPC):
111 return true;
112 default:
113 return false;
114 }
115}
116```
117
118## Retro Tapping
119
120To enable `retro tapping`, add the following to your `config.h`:
121
122```c
123#define RETRO_TAPPING
124```
125
126Holding and releasing a dual function key without pressing another key will result in nothing happening. With retro tapping enabled, releasing the key without pressing another will send the original keycode even if it is outside the tapping term.
127
128For instance, holding and releasing `LT(2, KC_SPACE)` without hitting another key will result in nothing happening. With this enabled, it will send `KC_SPACE` instead.