Skip to content

Latest commit

 

History

History
96 lines (76 loc) · 2.46 KB

combo_layers.md

File metadata and controls

96 lines (76 loc) · 2.46 KB
Raw

Combo Layers

Combo Layers is when you hold down 2 or more KC.MO() or KC.LM() keys at a time, and it goes to a defined layer.

By default, combo layers are not activated. You can activate combo layers by adding this to your main.py file. The combo_layers NEEDS to be above the keyboard.modules.append(Layers(combo_layers))

combo_layers = {
  (1, 2): 3,
   }
keyboard.modules.append(Layers(combo_layers))

In the above code, when layers 1 and 2 are held, layer 3 will activate. If you release 1 or 2 it will go to whatever key is still being held; if both are released, it will go to the default (0) layer.
You may have noticed that if you already have the layers module activated, you can add combo layers into (Layers())

You can even add more than 2 layers at a time.

combo_layers = {
  (1, 2): 3,
  (1, 2, 3): 4,
  }

Limitations

There can only be one combo layer active at a time, and when the combos are overlapping, the first matching combo in combo_layers takes precedence. Example:

layers = Layers()
layers.combo_layers = {
  (1, 2, 3): 8,
  (1, 2): 9,
  }
keyboard.modules.append(Layers(combo_layers))
  • If you activate layers 1 then 2, your active layer will be layer number 9.
  • If you activate layers 1, then 2, then 3, your active layer will be layer number 3 (because the layer combo (1,2) has been activated, but layer 3 stacks on top).
    • deactivate 1: you're on layer 3
    • deactivate 2: you're on layer 3
    • deactivate 3: you're on layer 8
  • If you activate layers 3, then 1, then 2, your active layer will be layer number 8. Deactivate layer
    • deactivate any of 1/2/3: you're on layer 0

Example Code

import board

from kmk.kmk_keyboard import KMKKeyboard
from kmk.keys import KC

combo_layers = {
  (1, 2): 3,
  }


keyboard = KMKKeyboard()

keyboard.modules.append(Layers(combo_layers))


keyboard.keymap = [
    [ #Default
    KC.A,     KC.B  KC.C  KC.D,
    KC.E,     KC.F  KC.G  KC.H,
    KC.MO(1), KC.J, KC.K, KC.MO(2),
    ],
    [ #Layer 1
    KC.N1,    KC.N2, KC.N3, KC.N4,
    KC.N5,    KC.N6, KC.N7, KC.N8,
    KC.MO(1), KC.N9, KC.N0, KC.MO(2),
    ],
        [ #Layer 2
    KC.EXLM,  KC.AT,   KC.HASH, KC.DLR,
    KC.PERC,  KC.CIRC, KC.AMPR, KC.ASTR,
    KC.MO(1), KC.LPRN, KC.RPRN, KC.MO(2),
    ],
        [ #Layer 3
    KC.F1,   KC.F2, KC.F3,  KC.F4,
    KC.F5,   KC.F6, KC.F7,  KC.F8,
    KC.MO(1) KC.F9, KC.F10, KC.MO(2)
    ]
    
]

if __name__ == '__main__':
    keyboard.go()