feat(extensions): most of the extensions implementation, by kdb424

2020-10-21 12:19:42 -07:00
parent 9821f7bcc3
commit e72d2b8c34
140 changed files with 3860 additions and 2312 deletions
--- a/boards/boardsource/3x4/README.md
+++ b/boards/boardsource/3x4/README.md
@@ -0,0 +1,13 @@
+# Boardsource 3x4
+
+![Boardsource3x4](https://boardsource.imgix.net/30171267-d988-46cc-ba03-9f6a8ab96487.jpg?raw=true)
+
+This macro pad / small 12 key was inspired by the plaid look
+
+kb.py is designed to work with the nice!nano
+
+Retailers (USA)  
+[Boardsource](https://boardsource.xyz/store/5ecc2008eee64242946c98c1)  
+
+Extentions enabled by default  
+- [Layers](https://github.com/KMKfw/kmk_firmware/tree/master/docs/layers.md) Need more keys than switches? Use layers.
--- a/boards/boardsource/3x4/kb.py
+++ b/boards/boardsource/3x4/kb.py
@@ -0,0 +1,12 @@
+import board
+
+from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard
+from kmk.matrix import DiodeOrientation
+
+
+class KMKKeyboard(_KMKKeyboard):
+    row_pins = (board.P1_15, board.P0_02, board.P0_29)
+    col_pins = (board.P0_09, board.P0_10, board.P1_11, board.P1_13)
+    diode_orientation = DiodeOrientation.COLUMNS
+    i2c = board.I2C
+    powersave_pin = board.P0_13
--- a/boards/boardsource/3x4/main.py
+++ b/boards/boardsource/3x4/main.py
@@ -0,0 +1,30 @@
+from kb import KMKKeyboard
+from kmk.keys import KC
+from kmk.modules.layers import Layers
+
+keyboard = KMKKeyboard()
+
+# Cleaner key names
+_______ = KC.TRNS
+XXXXXXX = KC.NO
+
+layers_ext = Layers()
+keyboard.modules = [layers_ext]
+
+RAISE = KC.MO(1)
+
+keyboard.keymap = [
+    [  #Base
+        KC.N0,  KC.N1,  KC.N4,  KC.N7,
+        KC.ENT, KC.N2,  KC.N5,  KC.N8,
+        RAISE,  KC.N3,  KC.N6,  KC.N9
+    ],
+    [  #RAISE
+        _______, _______, _______, _______,
+        _______, _______, _______, _______,
+        _______, _______, _______, _______
+    ]
+]
+
+if __name__ == '__main__':
+    keyboard.go()
--- a/boards/boardsource/4x12/README.md
+++ b/boards/boardsource/4x12/README.md
@@ -0,0 +1,21 @@
+# Boardsource 4x12 Ortho
+
+![Boardsource4x12](https://boardsource.imgix.net/164c3388-5057-46c8-8fcd-82c58c7870ce.jpg?raw=true)
+![Boardsource4x12LP](https://boardsource.imgix.net/c2108ea4-7d70-4327-b4b4-88c8191b1369.jpg?raw=true)
+
+The 4x12 ortholinear keyboard is an extremely common and beloved layout within the keyboard community. Made popular by Jack's Planck from OLKB, the 4x12 ortholinear layout is possibly the most popular non-stagger layout available.  
+
+kb.py is designed to work with the nice!nano  
+
+Retailers (USA)  
+4x12  
+[Boardsource](https://boardsource.xyz/store/5ecb78d286879c9a0c22dafd )  
+Low profile 4x12  
+[Boardsource](https://boardsource.xyz/store/5ecb7dad86879c9a0c22db32)  
+
+Extentions enabled by default  
+- [Layers](https://github.com/KMKfw/kmk_firmware/tree/master/docs/layers.md) Need more keys than switches? Use layers.
+- [MediaKeys](https://github.com/KMKfw/kmk_firmware/tree/master/docs/media_keys.md) Control volume and other media functions
+
+Common Extentions
+- [Power](https://github.com/KMKfw/kmk_firmware/tree/master/docs/power.md) Powersaving features for battery life
--- a/boards/boardsource/4x12/kb.py
+++ b/boards/boardsource/4x12/kb.py
@@ -0,0 +1,25 @@
+import board
+
+from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard
+from kmk.matrix import DiodeOrientation
+
+
+class KMKKeyboard(_KMKKeyboard):
+    row_pins = (board.P0_08, board.P0_06, board.P0_17, board.P0_20)
+    col_pins = (
+        board.P0_31,
+        board.P0_29,
+        board.P0_02,
+        board.P1_15,
+        board.P1_13,
+        board.P1_11,
+        board.P0_10,
+        board.P0_09,
+        board.P1_06,
+        board.P1_04,
+        board.P0_11,
+        board.P1_00,
+    )
+    diode_orientation = DiodeOrientation.COLUMNS
+    i2c = board.I2C
+    powersave_pin = board.P0_13
--- a/boards/boardsource/4x12/main.py
+++ b/boards/boardsource/4x12/main.py
@@ -0,0 +1,43 @@
+from kb import KMKKeyboard
+from kmk.extensions.media_keys import MediaKeys
+from kmk.keys import KC
+from kmk.modules.layers import Layers
+
+keyboard = KMKKeyboard()
+
+media = MediaKeys()
+layers_ext = Layers()
+
+keyboard.extensions = [media]
+keyboard.modules = [layers_ext]
+
+# Cleaner key names
+_______ = KC.TRNS
+XXXXXXX = KC.NO
+
+LOWER = KC.MO(1)
+RAISE = KC.MO(2)
+
+keyboard.keymap = [
+    [  #QWERTY
+        KC.TAB,  KC.Q,    KC.W,    KC.E,    KC.R,    KC.T,    KC.Y,    KC.U,    KC.I,    KC.O,    KC.P,    KC.BSPC,
+        KC.ESC,  KC.A,    KC.S,    KC.D,    KC.F,    KC.G,    KC.H,    KC.J,    KC.K,    KC.L,    KC.SCLN, KC.QUOT,
+        KC.LSFT, KC.Z,    KC.X,    KC.C,    KC.V,    KC.B,    KC.N,    KC.M,    KC.COMM, KC.DOT,  KC.SLSH, KC.ENT ,
+        KC.PIPE, KC.LCTL, KC.LALT, KC.LGUI, LOWER,   KC.SPC,  KC.SPC,  RAISE,   KC.LEFT, KC.DOWN, KC.UP,   KC.RGHT
+    ],
+    [  #LOWER
+        KC.GRV,  KC.N1,   KC.N2,   KC.N3,   KC.N4,   KC.N5,   KC.N6,   KC.N7,   KC.N8,   KC.N9,   KC.N0,   KC.BSPC,
+        KC.DEL,  KC.F1,   KC.F2,   KC.F3,   KC.F4,   KC.F5,   KC.F6,   KC.MINS, KC.EQL,  KC.LBRC, KC.RBRC, KC.BSLS,
+        _______, KC.F7,   KC.F8,   KC.F9,   KC.F10,  KC.F11,  KC.F12,  KC.NUHS, KC.NUBS, KC.PGUP, KC.PGDN, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, KC.MNXT, KC.VOLD, KC.VOLU, KC.MPLY
+    ],
+    [  #RAISE
+        KC.TILD, KC.EXLM, KC.AT,   KC.HASH, KC.DLR,  KC.PERC, KC.CIRC, KC.AMPR, KC.ASTR, KC.LPRN, KC.RPRN, KC.BSPC,
+        KC.DEL,  KC.F1,   KC.F2,   KC.F3,   KC.F4,   KC.F5,   KC.F6,   KC.UNDS, KC.PLUS, KC.LCBR, KC.RCBR, KC.PIPE,
+        _______, KC.F7,   KC.F8,   KC.F9,   KC.F10,  KC.F11,  KC.F12,  _______, _______, KC.HOME, KC.END,  _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, KC.MNXT, KC.VOLD, KC.VOLU, KC.MPLY
+    ]
+]
+
+if __name__ == '__main__':
+    keyboard.go()
--- a/boards/boardsource/5x12/README.md
+++ b/boards/boardsource/5x12/README.md
@@ -0,0 +1,21 @@
+# Boardsource 5x12 Ortho
+
+![Boardsource5x12](https://boardsource.imgix.net/74abb511-792e-42d9-9f6e-8100c521b2e0.jpg?raw=true)
+![Boardsource5x12LP](https://boardsource.imgix.net/57ad3f69-3c88-4ae8-9592-6e4d2f45a58e.jpg?raw=true)
+
+5x12 ortholinear -- for when just really don't want to give up your number row. The 5x12 ortholinear keyboard is a common ortholinear layout that many people prefer because it includes a number row. Made popular by Jack's Preonic from OLKB, the 5x12 ortholinear layout is a great option for those who want to try ortholinear but feel they aren't ready to make the jump to a 40%. The 5x12 Ortho is an approachable keyboard with hotswap compatibility.  
+
+kb.py is designed to work with the nice!nano  
+
+Retailers (USA)  
+5x12  
+[Boardsource](https://boardsource.xyz/store/5ecb802c86879c9a0c22db61)  
+Low Profile 5x12
+[Boardsource](https://boardsource.xyz/store/5ecb822386879c9a0c22db84)  
+
+Extentions enabled by default  
+- [Layers](https://github.com/KMKfw/kmk_firmware/tree/master/docs/layers.md) Need more keys than switches? Use layers.
+- [MediaKeys](https://github.com/KMKfw/kmk_firmware/tree/master/docs/media_keys.md) Control volume and other media functions
+
+Common Extentions
+- [Power](https://github.com/KMKfw/kmk_firmware/tree/master/docs/power.md) Powersaving features for battery life
--- a/boards/boardsource/5x12/kb.py
+++ b/boards/boardsource/5x12/kb.py
@@ -0,0 +1,25 @@
+import board
+
+from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard
+from kmk.matrix import DiodeOrientation
+
+
+class KMKKeyboard(_KMKKeyboard):
+    row_pins = (board.P0_08, board.P0_06, board.P0_17, board.P0_20, board.P0_22)
+    col_pins = (
+        board.P0_31,
+        board.P0_29,
+        board.P0_02,
+        board.P1_15,
+        board.P1_13,
+        board.P1_11,
+        board.P0_10,
+        board.P0_09,
+        board.P1_06,
+        board.P1_04,
+        board.P0_11,
+        board.P1_00,
+    )
+    diode_orientation = DiodeOrientation.COLUMNS
+    i2c = board.I2C
+    powersave_pin = board.P0_13
--- a/boards/boardsource/5x12/main.py
+++ b/boards/boardsource/5x12/main.py
@@ -0,0 +1,46 @@
+from kb import KMKKeyboard
+from kmk.extensions.media_keys import MediaKeys
+from kmk.keys import KC
+from kmk.modules.layers import Layers
+
+keyboard = KMKKeyboard()
+
+media = MediaKeys()
+layers_ext = Layers()
+
+keyboard.modules = [layers_ext]
+keyboard.extensions = [media]
+
+# Cleaner key names
+_______ = KC.TRNS
+XXXXXXX = KC.NO
+
+LOWER = KC.MO(1)
+RAISE = KC.MO(2)
+
+keyboard.keymap = [
+    [  #QWERTY
+        KC.GRV,  KC.N1,   KC.N2,   KC.N3,   KC.N4,   KC.N5,   KC.N6,   KC.N7,   KC.N8,   KC.N9,   KC.N0,   KC.BSPC,
+        KC.TAB,  KC.Q,    KC.W,    KC.E,    KC.R,    KC.T,    KC.Y,    KC.U,    KC.I,    KC.O,    KC.P,    KC.DEL,
+        KC.ESC,  KC.A,    KC.S,    KC.D,    KC.F,    KC.G,    KC.H,    KC.J,    KC.K,    KC.L,    KC.SCLN, KC.QUOT,
+        KC.LSFT, KC.Z,    KC.X,    KC.C,    KC.V,    KC.B,    KC.N,    KC.M,    KC.COMM, KC.DOT,  KC.SLSH, KC.ENT,
+        KC.PIPE, KC.LCTL, KC.LALT, KC.LGUI, LOWER,   KC.SPC,  KC.SPC,  RAISE,   KC.LEFT, KC.DOWN, KC.UP,   KC.RGHT
+    ],
+    [  #LOWER
+        KC.ESC,  KC.F1,   KC.F2,   KC.F3,   KC.F4,   KC.F5,   KC.F6,   KC.F7,   KC.F8,   KC.F9,   KC.F10,  KC.F11,
+        _______, _______, _______, _______, _______, _______, _______, _______, KC.UP,   _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, KC.LEFT, KC.DOWN, KC.RGHT, _______, _______,
+        KC.CAPS, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, KC.MNXT, KC.VOLD, KC.VOLU, KC.MPLY
+    ],
+    [  #RAISE
+        KC.GRV,  KC.F1,   KC.F2,   KC.F3,   KC.F4,   KC.F5,   KC.F6,   KC.F7,   KC.F8,   KC.F9,   KC.F10,  KC.F11,
+        KC.ESC,  KC.N1,   KC.N2,   KC.N3,   KC.N4,   KC.N5,   KC.N6,   KC.N7,   KC.N8,   KC.N9,   KC.N0,   KC.DEL,
+        _______, KC.N4,   KC.N5,   KC.N6,   KC.PLUS, KC.F5,   KC.F6,   KC.MINS, KC.EQL,  KC.LBRC, KC.RBRC, _______,
+        KC.ENT,  KC.N7,   KC.N8,   KC.N9,   KC.MINS, KC.F11,  KC.F12,  KC.NUHS, KC.NUBS, KC.MUTE, _______, KC.BSLS,
+        _______, _______, _______, _______, _______, _______, _______, _______, KC.MNXT, KC.VOLD, KC.VOLU, KC.MPLY
+    ]
+]
+
+if __name__ == '__main__':
+    keyboard.go()
--- a/boards/boardsource/microdox/README.md
+++ b/boards/boardsource/microdox/README.md
@@ -0,0 +1,19 @@
+# Microdox
+
+![microdox](https://boardsource.imgix.net/337ae65a-d061-46a4-b119-9916b043c58f.jpg?raw=true)
+
+The Microdox is is a feature-packed 30% split columnar staggered keyboard. Even though the Microdox is an extremely small keyboard it offers tons of features from larger boards while maintaining a tiny footprint.  
+
+kb.py is designed to work with the nice!nano  
+
+Retailers (USA)  
+[Boardsource](https://boardsource.xyz/store/5f2e7e4a2902de7151494f92)  
+
+Extentions enabled by default  
+- [Layers](https://github.com/KMKfw/kmk_firmware/tree/master/docs/layers.md) Need more keys than switches? Use layers.
+- [BLE_Split](https://github.com/KMKfw/kmk_firmware/tree/master/docs/split.md) Connects halves without wires
+- [ModTap](https://github.com/KMKfw/kmk_firmware/tree/master/docs/modtap.md) Allows mod keys to act as different keys when tapped.
+
+Common Extentions
+- [Split](https://github.com/KMKfw/kmk_firmware/tree/master/docs/split.md) Connects halves using a wire
+- [Power](https://github.com/KMKfw/kmk_firmware/tree/master/docs/power.md) Powersaving features for battery life
--- a/boards/boardsource/microdox/kb.py
+++ b/boards/boardsource/microdox/kb.py
@@ -0,0 +1,24 @@
+import board
+
+from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard
+from kmk.matrix import DiodeOrientation
+from kmk.matrix import intify_coordinate as ic
+
+
+class KMKKeyboard(_KMKKeyboard):
+    col_pins = (board.P0_31, board.P0_29, board.P0_02, board.P1_15, board.P1_13)
+    row_pins = (board.P0_10, board.P0_09, board.P1_04, board.P1_06)
+    diode_orientation = DiodeOrientation.COLUMNS
+    data_pin = board.P0_08
+    rgb_pixel_pin = board.P0_06
+    rgb_num_pixels = 12
+    i2c = board.I2C
+    powersave_pin = board.P0_13
+
+    coord_mapping = []
+    coord_mapping.extend(ic(0, x) for x in range(10))
+    coord_mapping.extend(ic(1, x) for x in range(10))
+    coord_mapping.extend(ic(2, x) for x in range(10))
+
+    # And now, to handle R3, which at this point is down to just six keys
+    coord_mapping.extend(ic(3, x) for x in range(3, 9))
--- a/boards/boardsource/microdox/main.py
+++ b/boards/boardsource/microdox/main.py
@@ -0,0 +1,54 @@
+from kb import KMKKeyboard
+from kmk.keys import KC
+from kmk.modules.layers import Layers
+from kmk.modules.split import Split, SplitSide, SplitType
+
+keyboard = KMKKeyboard()
+
+# TODO Comment one of these on each side
+split_side = SplitSide.LEFT
+split_side = SplitSide.RIGHT
+split = Split(split_type=SplitType.BLE, split_side=split_side)
+
+layers_ext = Layers()
+
+keyboard.modules = [layers_ext, split]
+
+# Cleaner key names
+_______ = KC.TRNS
+XXXXXXX = KC.NO
+
+LOWER = KC.MO(2)
+RAISE = KC.MO(1)
+
+RGB_TOG = KC.RGB_TOG
+RGB_HUI = KC.RGB_HUI
+RGB_HUD = KC.RGB_HUI
+RGB_SAI = KC.RGB_SAI
+RGB_SAD = KC.RGB_SAD
+RGB_VAI = KC.RGB_VAI
+RGB_VAD = KC.RGB_VAD
+
+keyboard.keymap = [
+    [  #QWERTY
+        KC.Q,    KC.W,    KC.E,    KC.R,    KC.T,                         KC.Y,    KC.U,    KC.I,    KC.O,   KC.P,\
+        KC.A,    KC.S,    KC.D,    KC.F,    KC.G,                         KC.H,    KC.J,    KC.K,    KC.L, KC.SCLN,\
+        KC.Z,    KC.X,    KC.C,    KC.V,    KC.B,                         KC.N,    KC.M, KC.COMM,  KC.DOT, KC.SLSH,\
+                                    KC.LCTL,   LOWER,  KC.SPC,     KC.BSPC,    RAISE,  KC.ENT,
+    ],
+    [  #RAISE
+        KC.N1,   KC.N2,   KC.N3,   KC.N4,   KC.N5,                        KC.N6,   KC.N7,   KC.N8,   KC.N9,   KC.N0,\
+        KC.TAB,  KC.LEFT, KC.DOWN, KC.UP,   KC.RGHT,                      XXXXXXX, KC.MINS, KC.EQL,  KC.LBRC, KC.RBRC,\
+        KC.LCTL, KC.GRV,  KC.LGUI, KC.LALT, XXXXXXX,                      XXXXXXX, XXXXXXX, XXXXXXX, KC.BSLS, KC.QUOT,\
+                                    XXXXXXX, XXXXXXX, XXXXXXX,      XXXXXXX, XXXXXXX, XXXXXXX,
+    ],
+    [  #LOWER
+        KC.EXLM, KC.AT,   KC.HASH, KC.DLR,  KC.PERC,      KC.CIRC, KC.AMPR, KC.ASTR, KC.LPRN, KC.RPRN,\
+        KC.ESC,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,      XXXXXXX, KC.UNDS, KC.PLUS, KC.LCBR, KC.RCBR,\
+        KC.CAPS, KC.TILD, XXXXXXX, XXXXXXX, XXXXXXX,      XXXXXXX, XXXXXXX, XXXXXXX, KC.PIPE,  KC.DQT,\
+                            XXXXXXX, XXXXXXX, XXXXXXX,      KC.ENT,  XXXXXXX, KC.DEL
+    ]
+]
+
+if __name__ == '__main__':
+    keyboard.go()