Remove OneShot module (#1047)

KMKfw · Nov 19, 2024 · b6430a7 · b6430a7
1 parent 8a318c5
commit b6430a7
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 346 deletions.
diff --git a/boards/boardsource/unicorne/README.md b/boards/boardsource/unicorne/README.md
@@ -13,5 +13,5 @@ Extensions enabled by default
 - [Layers](/docs/en/layers.md) Need more keys than switches? Use layers.
 - [PEG_RGB](/docs/en/peg_rgb_matrix.md) Light it up!
 - [Display](/docs/en/display.md) Show information on the mini OLED display
-- [Oneshot](/docs/en/oneshot.md) Dead keys, for faster typing
+- [StickyKeys](/docs/en/sticky_keys.md) Sticky keys, for faster typing
 - [Combos](/docs/en/combos) Making more keys from pushing multiple keys.
diff --git a/boards/boardsource/unicorne/main.py b/boards/boardsource/unicorne/main.py
@@ -13,23 +13,22 @@
 from kmk.modules.layers import Layers
 from kmk.modules.macros import Macros
 from kmk.modules.modtap import ModTap
-from kmk.modules.oneshot import OneShot
 from kmk.modules.split import Split, SplitSide
+from kmk.modules.sticky_keys import StickyKeys
 
 supervisor.runtime.autoreload = False
 keyboard = KMKKeyboard()
 macros = Macros()
 modtap = ModTap()
 combos = Combos()
-oneshot = OneShot()
+sticky_keys = StickyKeys(release_after=450)
 layers = Layers()
-oneshot.tap_time = 450
 
 
-OS_LCTL = KC.OS(KC.LCTL)
-OS_LSFT = KC.OS(KC.LSFT)
-OS_LALT = KC.OS(KC.LALT)
-keyboard.modules.append(oneshot)
+SK_LCTL = KC.SK(KC.LCTL)
+SK_LSFT = KC.SK(KC.LSFT)
+SK_LALT = KC.SK(KC.LALT)
+keyboard.modules.append(sticky_keys)
 keyboard.modules.append(layers)
 keyboard.modules.append(modtap)
 keyboard.modules.append(combos)
@@ -107,8 +106,8 @@
         # DVORAK
         KC.ESC,   KC.QUOT, KC.COMM, KC.DOT,  KC.P,    KC.Y,                      KC.F,    KC.G,    KC.C,    KC.R,    KC.L,    KC.BSPC, \
         TAB_SB,   KC.A,    KC.O,    KC.E,    KC.U,    KC.I,                      KC.D,    KC.H,    KC.T,    KC.N,    KC.S,    KC.ENT, \
-        OS_LSFT,  KC.SCLN, KC.Q,    KC.J,    KC.K,    KC.X,                      KC.B,    KC.M,    KC.W,    KC.V,    KC.Z,    KC.SLSH, \
-                                        OS_LALT, SUPER_L, LT1_SP,   LT2_SP,  OS_LCTL, KC.NO,
+        SK_LSFT,  KC.SCLN, KC.Q,    KC.J,    KC.K,    KC.X,                      KC.B,    KC.M,    KC.W,    KC.V,    KC.Z,    KC.SLSH, \
+                                        SK_LALT, SUPER_L, LT1_SP,   LT2_SP,  SK_LCTL, KC.NO,
     ],
 
     # GAMING

diff --git a/boards/fingerpunch/ffkb/nice_nano/main.py b/boards/fingerpunch/ffkb/nice_nano/main.py
@@ -4,7 +4,7 @@
 from kmk.modules.combos import Combos, Sequence
 from kmk.modules.dynamic_sequences import DynamicSequences
 from kmk.modules.layers import Layers
-from kmk.modules.oneshot import OneShot
+from kmk.modules.sticky_keys import StickyKeys
 
 combos = Combos()
 dyn_seq = DynamicSequences(
@@ -14,10 +14,10 @@
     use_recorded_speed=False,  # Whether to play the sequence at the speed it was typed
 )
 layers = Layers()
-oneshot = OneShot()
+sticky_keys = StickyKeys()
 
 keyboard = kb.KMKKeyboard()
-keyboard.modules = [combos, dyn_seq, layers, oneshot]
+keyboard.modules = [combos, dyn_seq, layers, sticky_keys]
 keyboard.debug_enabled = False
 
 # Convenience variables for the Keymap
@@ -27,7 +27,7 @@
 L1_TAB = KC.LT(1, KC.TAB, prefer_hold=True)
 L2_ENT = KC.LT(2, KC.ENT, prefer_hold=True)
 
-OS_LSFT = KC.OS(KC.LSFT)
+SK_LSFT = KC.SK(KC.LSFT)
 
 SEQ_REC = KC.RECORD_SEQUENCE()
 SEQ_STP = KC.STOP_SEQUENCE()
@@ -48,7 +48,7 @@
         KC.ESC,  KC.Q,    KC.W,    KC.F,    KC.P,     KC.B,             KC.J,    KC.L,     KC.U,    KC.Y,    KC.SCLN, KC.LEADER,
         KC.LCTL, KC.A,    KC.R,    KC.S,    KC.T,     KC.G,    xxxxxxx, KC.M,    KC.N,     KC.E,    KC.I,    KC.O,    KC.QUOT,
         KC.LALT, KC.Z,    KC.X,    KC.C,    KC.D,     KC.V,             KC.K,    KC.H,     KC.COMM, KC.DOT,  KC.SLSH, KC.BSLS,
-                 xxxxxxx,          KC.LGUI, OS_LSFT,  KC.BSPC,          L1_TAB,  KC.SPACE, L2_ENT,             xxxxxxx,
+                 xxxxxxx,          KC.LGUI, SK_LSFT,  KC.BSPC,          L1_TAB,  KC.SPACE, L2_ENT,             xxxxxxx,
     ],
     [  # 1: Nav & Numbers
         KC.TAB,  KC.N1,   KC.N2,   KC.N3,   KC.N4,    KC.N5,            KC.N6,   KC.N7,    KC.N8,   KC.N9,   KC.N0,   KC.DEL,

diff --git a/boards/hillside/46/main.py b/boards/hillside/46/main.py
@@ -6,8 +6,8 @@
 from kmk.modules.capsword import CapsWord
 from kmk.modules.cg_swap import CgSwap
 from kmk.modules.layers import Layers
-from kmk.modules.oneshot import OneShot
 from kmk.modules.split import Split
+from kmk.modules.sticky_keys import StickyKeys
 
 keyboard = KMKKeyboard()
 keyboard.extensions.append(MediaKeys())
@@ -20,11 +20,11 @@
 keyboard.modules.append(CapsWord())
 keyboard.modules.append(CgSwap())
 keyboard.modules.append(Layers())
-keyboard.modules.append(OneShot())
+keyboard.modules.append(StickyKeys())
 split = Split(data_pin=keyboard.data_pin)
 keyboard.modules.append(split)
 
-OS_LSFT = KC.OS(KC.LSFT)
+SK_LSFT = KC.SK(KC.LSFT)
 LYR3 = KC.MO(3)
 LYR4 = KC.MO(4)
 LYR5 = KC.MO(5)
@@ -33,7 +33,7 @@
 PSTE = KC.LCTL(KC.V)
 UNDO = KC.LCTL(KC.Z)
 REDO = KC.LCTL(KC.Y)
-OS_RALT = KC.OS(KC.RALT)
+SK_RALT = KC.SK(KC.RALT)
 RGB_M_P = KC.RGB_MODE_PLAIN
 RGB_M_B = KC.RGB_MODE_BREATHE
 RGB_M_R = KC.RGB_MODE_RAINBOW
@@ -47,7 +47,7 @@
         KC.GRV,  KC.Q,    KC.W,    KC.E,    KC.R, KC.T,                  KC.Y, KC.U, KC.I,    KC.O,    KC.P,    KC.BSPC,
         KC.TAB,  KC.A,    KC.S,    KC.D,    KC.F, KC.G,                  KC.H, KC.J, KC.K,    KC.L,    KC.SCLN, KC.ENT,
         KC.LCTL, KC.Z,    KC.X,    KC.C,    KC.V, KC.B, KC.ESC,   KC.CW, KC.N, KC.M, KC.COMM, KC.DOT,  KC.SLSH, KC.QUOT,
-                 KC.LGUI, KC.LALT, OS_LSFT, LYR3,                              LYR4, KC.SPC,  KC.LALT, KC.RGUI,
+                 KC.LGUI, KC.LALT, SK_LSFT, LYR3,                              LYR4, KC.SPC,  KC.LALT, KC.RGUI,
     ],
     [   #DVORAK
         KC.TRNS, KC.QUOT, KC.COMM, KC.DOT,  KC.P,    KC.Y,                     KC.F,    KC.G,    KC.C,    KC.R,    KC.L,   KC.TRNS,
@@ -70,7 +70,7 @@
     [
         KC.HOME, KC.EXLM, KC.AT,   KC.HASH, KC.DLR,  KC.PERC,                     KC.CIRC, KC.AMPR, KC.ASTR, KC.LPRN, KC.RPRN, KC.DEL,
         KC.END,  KC.LGUI, KC.LALT, KC.LCTL, KC.LSFT, KC.INS,                      KC.LBRC, KC.RBRC, KC.MINS, KC.EQL,  KC.BSLS, KC.TRNS,
-        KC.TRNS, KC.PIPE, KC.UNDS, KC.PLUS, KC.LCBR, KC.RCBR, OS_RALT,    KC.APP, KC.MUTE, KC.VOLD, KC.VOLU, KC.MPLY, KC.NO,   KC.RCTL,
+        KC.TRNS, KC.PIPE, KC.UNDS, KC.PLUS, KC.LCBR, KC.RCBR, SK_RALT,    KC.APP, KC.MUTE, KC.VOLD, KC.VOLU, KC.MPLY, KC.NO,   KC.RCTL,
         KC.TRNS, KC.TRNS, KC.TRNS, KC.TRNS, LYR5,                                          KC.TRNS, KC.TRNS, KC.TRNS, KC.TRNS,
     ],
     [

diff --git a/boards/hillside/48/main.py b/boards/hillside/48/main.py
@@ -6,8 +6,8 @@
 from kmk.modules.capsword import CapsWord
 from kmk.modules.cg_swap import CgSwap
 from kmk.modules.layers import Layers
-from kmk.modules.oneshot import OneShot
 from kmk.modules.split import Split
+from kmk.modules.sticky_keys import StickyKeys
 
 keyboard = KMKKeyboard()
 keyboard.extensions.append(MediaKeys())
@@ -20,11 +20,11 @@
 keyboard.modules.append(CapsWord())
 keyboard.modules.append(CgSwap())
 keyboard.modules.append(Layers())
-keyboard.modules.append(OneShot())
+keyboard.modules.append(StickyKeys())
 split = Split(data_pin=keyboard.data_pin)
 keyboard.modules.append(split)
 
-OS_LSFT = KC.OS(KC.LSFT)
+SK_LSFT = KC.SK(KC.LSFT)
 LYR3 = KC.MO(3)
 LYR4 = KC.MO(4)
 LYR5 = KC.MO(5)
@@ -33,7 +33,7 @@
 PSTE = KC.LCTL(KC.V)
 UNDO = KC.LCTL(KC.Z)
 REDO = KC.LCTL(KC.Y)
-OS_RALT = KC.OS(KC.RALT)
+SK_RALT = KC.SK(KC.RALT)
 RGB_M_P = KC.RGB_MODE_PLAIN
 RGB_M_B = KC.RGB_MODE_BREATHE
 RGB_M_R = KC.RGB_MODE_RAINBOW
@@ -47,7 +47,7 @@
         KC.GRV,  KC.Q,    KC.W,    KC.E, KC.R,    KC.T,                  KC.Y, KC.U, KC.I,    KC.O,    KC.P,    KC.BSPC,
         KC.TAB,  KC.A,    KC.S,    KC.D, KC.F,    KC.G,                  KC.H, KC.J, KC.K,    KC.L,    KC.SCLN, KC.ENT,
         KC.LSFT, KC.Z,    KC.X,    KC.C, KC.V,    KC.B, KC.ESC,   KC.CW, KC.N, KC.M, KC.COMM, KC.DOT,  KC.SLSH, KC.RSFT,
-        KC.LCTL, KC.LGUI, KC.LALT, LYR3, OS_LSFT,                              LYR4, KC.SPC,  KC.LALT, KC.RGUI, KC.QUOT,
+        KC.LCTL, KC.LGUI, KC.LALT, LYR3, SK_LSFT,                              LYR4, KC.SPC,  KC.LALT, KC.RGUI, KC.QUOT,
     ],
     [   #DVORAK
         KC.TRNS, KC.QUOT, KC.COMM, KC.DOT,  KC.P,    KC.Y,                      KC.F, KC.G,    KC.C,    KC.R,    KC.L,    KC.TRNS,
@@ -64,7 +64,7 @@
     [
         KC.HOME, KC.EXLM, KC.AT,   KC.HASH, KC.DLR,  KC.PERC,                     KC.CIRC, KC.AMPR, KC.ASTR, KC.LPRN, KC.RPRN, KC.DEL,
         KC.END,  KC.LGUI, KC.LALT, KC.LCTL, KC.LSFT, KC.INS,                      KC.LBRC, KC.RBRC, KC.MINS, KC.EQL,  KC.BSLS, KC.TRNS,
-        KC.TRNS, KC.NO,   KC.VOLD, KC.MUTE, KC.VOLU, KC.MPLY, OS_RALT,    KC.APP, KC.LCBR, KC.RCBR, KC.UNDS, KC.PLUS, KC.PIPE, KC.TRNS,
+        KC.TRNS, KC.NO,   KC.VOLD, KC.MUTE, KC.VOLU, KC.MPLY, SK_RALT,    KC.APP, KC.LCBR, KC.RCBR, KC.UNDS, KC.PLUS, KC.PIPE, KC.TRNS,
         KC.TRNS, KC.TRNS, KC.TRNS, KC.TRNS, KC.TRNS,                                       LYR5,    KC.TRNS, KC.TRNS, KC.TRNS, KC.RCTL,
     ],
     [

diff --git a/boards/hillside/52/main.py b/boards/hillside/52/main.py
@@ -6,8 +6,8 @@
 from kmk.modules.capsword import CapsWord
 from kmk.modules.cg_swap import CgSwap
 from kmk.modules.layers import Layers
-from kmk.modules.oneshot import OneShot
 from kmk.modules.split import Split
+from kmk.modules.sticky_keys import StickyKeys
 
 keyboard = KMKKeyboard()
 keyboard.extensions.append(MediaKeys())
@@ -20,11 +20,11 @@
 keyboard.modules.append(CapsWord())
 keyboard.modules.append(CgSwap())
 keyboard.modules.append(Layers())
-keyboard.modules.append(OneShot())
+keyboard.modules.append(StickyKeys())
 split = Split(data_pin=keyboard.data_pin)
 keyboard.modules.append(split)
 
-OS_LSFT = KC.OS(KC.LSFT)
+SK_LSFT = KC.SK(KC.LSFT)
 LYR3 = KC.MO(3)
 LYR4 = KC.MO(4)
 LYR5 = KC.MO(5)
@@ -47,7 +47,7 @@
         KC.GRV,  KC.Q,    KC.W,    KC.E, KC.R,    KC.T,                                      KC.Y,    KC.U,    KC.I,    KC.O,    KC.P,    KC.BSPC,
         KC.TAB,  KC.A,    KC.S,    KC.D, KC.F,    KC.G,                                      KC.H,    KC.J,    KC.K,    KC.L,    KC.SCLN, KC.ENT,
         KC.LSFT, KC.Z,    KC.X,    KC.C, KC.V,    KC.B,    KC.QUOT,                 KC.SLSH, KC.N,    KC.M,    KC.COMM, KC.DOT,  KC.UP,   KC.RSFT,
-        KC.MUTE, KC.ESC, KC.LCTL,        KC.LGUI, KC.LALT, OS_LSFT, LYR3,     LYR4, KC.SPC,  KC.LALT, KC.RGUI,          KC.LEFT, KC.DOWN, KC.RGHT
+        KC.MUTE, KC.ESC, KC.LCTL,        KC.LGUI, KC.LALT, SK_LSFT, LYR3,     LYR4, KC.SPC,  KC.LALT, KC.RGUI,          KC.LEFT, KC.DOWN, KC.RGHT
     ],
     [   #DVORAK
         KC.TRNS, KC.QUOT, KC.COMM, KC.DOT, KC.P,    KC.Y,                                            KC.F,    KC.G,    KC.C, KC.R,    KC.L,    KC.TRNS,

diff --git a/boards/hillside/56/main.py b/boards/hillside/56/main.py
@@ -6,8 +6,8 @@
 from kmk.modules.capsword import CapsWord
 from kmk.modules.cg_swap import CgSwap
 from kmk.modules.layers import Layers
-from kmk.modules.oneshot import OneShot
 from kmk.modules.split import Split
+from kmk.modules.sticky_keys import StickyKeys
 
 keyboard = KMKKeyboard()
 keyboard.extensions.append(MediaKeys())
@@ -20,15 +20,15 @@
 keyboard.modules.append(CapsWord())
 keyboard.modules.append(CgSwap())
 keyboard.modules.append(Layers())
-keyboard.modules.append(OneShot())
+keyboard.modules.append(StickyKeys())
 split = Split(data_pin=keyboard.data_pin)
 keyboard.modules.append(split)
 
-OS_LSFT = KC.OS(KC.LSFT)
+SK_LSFT = KC.SK(KC.LSFT)
 LYR3 = KC.MO(3)
 LYR4 = KC.MO(4)
 LYR5 = KC.MO(5)
-OS_RALT = KC.OS(KC.RALT)
+SK_RALT = KC.SK(KC.RALT)
 RGB_M_P = KC.RGB_MODE_PLAIN
 RGB_M_B = KC.RGB_MODE_BREATHE
 RGB_M_R = KC.RGB_MODE_RAINBOW
@@ -62,7 +62,7 @@
     [
         KC.INS,  KC.EXLM, KC.AT,   KC.HASH, KC.DLR,  KC.PERC,                                     KC.CIRC, KC.AMPR, KC.ASTR, KC.LPRN, KC.RPRN, KC.TRNS,
         KC.TRNS, KC.LGUI, KC.LALT, KC.LCTL, KC.LSFT, KC.NO,                                       KC.MINS, KC.EQL,  KC.LBRC, KC.RBRC, KC.BSLS, KC.TRNS,
-        KC.TRNS, KC.NO,   KC.NO,   KC.NO,   KC.NO,   KC.NO,   OS_RALT,                    KC.APP, KC.UNDS, KC.PLUS, KC.LCBR, KC.RCBR, KC.PIPE, KC.TRNS,
+        KC.TRNS, KC.NO,   KC.NO,   KC.NO,   KC.NO,   KC.NO,   SK_RALT,                    KC.APP, KC.UNDS, KC.PLUS, KC.LCBR, KC.RCBR, KC.PIPE, KC.TRNS,
         KC.TRNS,          KC.NO,            KC.TRNS, KC.TRNS, KC.TRNS, KC.TRNS,     LYR5, KC.DEL, KC.TRNS, KC.TRNS,          KC.PGUP,          KC.TRNS,
                  KC.NO,   KC.NO,   KC.NO,                                                                           KC.HOME, KC.PGDN, KC.END,
     ],

diff --git a/boards/hillside/README.md b/boards/hillside/README.md
@@ -25,7 +25,7 @@ Extensions & modules enabled by default:
 - [RGB](/docs/en/rgb.md)
 - [MediaKeys](/docs/en/media_keys.md)
 - [CgSwap](/docs/en/cg_swap.md)
-- [OneShot](/docs/en/oneshot.md)
+- [StickyKeys](/docs/en/sticky_keys.md)
 - [CapsWord](/docs/en/capsword.md)
 
 ## Microcontroller support

diff --git a/docs/en/oneshot.md b/docs/en/oneshot.md