_/qmk_firmware
1
0
Fork 0
Code Releases Activity

Add macro for momentarily switching to a layer while some mods are active (#2460)

Browse source 
* Macro for a momentary layer switch with mods

Passes through to the existing ACTION_LAYER_MODS macro, albeit with more
limited options due to lack of space in the quantum_keycodes enum.

* Add documentation for LM layer-mod macro

* Clean up Tap Toggle documentation
This commit is contained in:
snyman 2018-03-20 22:59:54 -04:00 committed by Jack Humbert
parent 4ec03111cc
commit 7a5ce36f23
4 changed files with 21 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/feature_advanced_keycodes.md
View file

@ -25,7 +25,8 @@ These functions allow you to activate layers in various ways.
* `LT(layer, kc)` - momentary switch to *layer* when held, and *kc* when tapped. * `LT(layer, kc)` - momentary switch to *layer* when held, and *kc* when tapped.
* `TG(layer)` - toggles a layer on or off. * `TG(layer)` - toggles a layer on or off.
* `TO(layer)` - Goes to a layer. This code is special, because it lets you go either up or down the stack -- just goes directly to the layer you want. So while other codes only let you go _up_ the stack (from layer 0 to layer 3, for example), `TO(2)` is going to get you to layer 2, no matter where you activate it from -- even if you're currently on layer 5. This gets activated on keydown (as soon as the key is pressed). * `TO(layer)` - Goes to a layer. This code is special, because it lets you go either up or down the stack -- just goes directly to the layer you want. So while other codes only let you go _up_ the stack (from layer 0 to layer 3, for example), `TO(2)` is going to get you to layer 2, no matter where you activate it from -- even if you're currently on layer 5. This gets activated on keydown (as soon as the key is pressed).
* `TT(layer)` - Layer Tap-Toggle. If you hold the key down, the layer becomes active, and then deactivates when you let go. And if you tap it, the layer simply becomes active (toggles on). It needs 5 taps by default, but you can set it by defining `TAPPING_TOGGLE`, for example, `#define TAPPING_TOGGLE 2` for just two taps. * `TT(layer)` - Layer Tap-Toggle. If you hold the key down, the layer becomes active, and then deactivates when you let go. And if you repeatedly tap it, the layer simply becomes active (toggles on). It needs 5 taps by default, but you can set it by defining `TAPPING_TOGGLE`, for example, `#define TAPPING_TOGGLE 2` for just two taps.
* `LM(layer, mod)` - Momentary switch to *layer* (like MO), but with modifier(s) *mod* active. Only supports layers 0-15 and the left modifiers.
# Working with Layers # Working with Layers

17
docs/keycodes.md
View file

@ -368,14 +368,15 @@ This is a reference only. Each group of keys links to the page documenting their
## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers) ## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers)
|Key |Description | |Key |Description |
|---------------|----------------------------------------------------------------------------------| |----------------|----------------------------------------------------------------------------------|
|`LT(layer, kc)`|Turn on `layer` when held, `kc` when tapped | |`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped |
|`TO(layer)` |Turn on `layer` when pressed | |`TO(layer)` |Turn on `layer` when pressed |
|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)| |`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)|
|`DF(layer)` |Set the base (default) layer | |`DF(layer)` |Set the base (default) layer |
|`TG(layer)` |Toggle `layer` on or off | |`TG(layer)` |Toggle `layer` on or off |
|`TT(layer)` |Tap toggle? idk FIXME | |`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. |
## [One Shot Keys](quantum_keycodes.md#one-shot-keys) ## [One Shot Keys](quantum_keycodes.md#one-shot-keys)

5
quantum/keymap_common.c
View file

@ -122,6 +122,11 @@ action_t action_for_key(uint8_t layer, keypos_t key)
case QK_LAYER_TAP_TOGGLE ... QK_LAYER_TAP_TOGGLE_MAX: case QK_LAYER_TAP_TOGGLE ... QK_LAYER_TAP_TOGGLE_MAX:
action.code = ACTION_LAYER_TAP_TOGGLE(keycode & 0xFF); action.code = ACTION_LAYER_TAP_TOGGLE(keycode & 0xFF);
break; break;
case QK_LAYER_MOD ... QK_LAYER_MOD_MAX:
mod = keycode & 0xF;
action_layer = (keycode >> 4) & 0xF;
action.code = ACTION_LAYER_MODS(action_layer, mod);
break;
case QK_MOD_TAP ... QK_MOD_TAP_MAX: case QK_MOD_TAP ... QK_MOD_TAP_MAX:
mod = mod_config((keycode >> 0x8) & 0x1F); mod = mod_config((keycode >> 0x8) & 0x1F);
action.code = ACTION_MODS_TAP_KEY(mod, keycode & 0xFF); action.code = ACTION_MODS_TAP_KEY(mod, keycode & 0xFF);

5
quantum/quantum_keycodes.h
View file

@ -71,6 +71,8 @@ enum quantum_keycodes {
QK_TAP_DANCE_MAX = 0x57FF, QK_TAP_DANCE_MAX = 0x57FF,
QK_LAYER_TAP_TOGGLE = 0x5800, QK_LAYER_TAP_TOGGLE = 0x5800,
QK_LAYER_TAP_TOGGLE_MAX = 0x58FF, QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
QK_LAYER_MOD = 0x5900,
QK_LAYER_MOD_MAX = 0x59FF,
#ifdef STENO_ENABLE #ifdef STENO_ENABLE
QK_STENO = 0x5A00, QK_STENO = 0x5A00,
QK_STENO_BOLT = 0x5A30, QK_STENO_BOLT = 0x5A30,
@ -597,6 +599,9 @@ enum quantum_keycodes {
// One-shot layer - 256 layer max // One-shot layer - 256 layer max
#define OSL(layer) (layer | QK_ONE_SHOT_LAYER) #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
// L-ayer M-od: Momentary switch layer with modifiers active - 16 layer max, left mods only
#define LM(layer, mod) (QK_LAYER_MOD | (((layer) & 0xF) << 4) | ((mod) & 0xF))
// One-shot mod // One-shot mod
#define OSM(mod) ((mod) | QK_ONE_SHOT_MOD) #define OSM(mod) ((mod) | QK_ONE_SHOT_MOD)