helix board support
removing errant ticks from main.py
This commit is contained in:
Lance
xs5871
parent
b109cc2c4a
commit
a309aa52f3
111
boards/helix/README.md
Normal file
111
boards/helix/README.md
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
# Helix
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
A compact split ortholinear keyboard.
|
||||||
|
|
||||||
|
* Keyboard Maintainer: [yushakobo](https://github.com/yushakobo)
|
||||||
|
* Hardware Supported: Helix PCBs (probably rev2 only), Pro Micro RP2040 boards
|
||||||
|
|
||||||
|
Copy the `kb.py` and `main.py` files from your preferred keymap folder into your root directory of your keyboard as detailed in the [KMK instructions](http://kmkfw.io/docs/Getting_Started/).
|
||||||
|
|
||||||
|
## Microcontroller support
|
||||||
|
|
||||||
|
Update this line in `kb.py` to any supported microcontroller in `kmk/quickpin/pro_micro`:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from kmk.quickpin.pro_micro.boardsource_blok import pinout as pins
|
||||||
|
```
|
||||||
|
|
||||||
|
## Layout
|
||||||
|
|
||||||
|
### Qwerty
|
||||||
|
|
||||||
|
```
|
||||||
|
,-----------------------------------------. ,-----------------------------------------.
|
||||||
|
| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| Shift| Z | X | C | V | B | [ | ] | N | M | , | . | / |Enter |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
|Adjust| Esc | Alt | GUI | |Lower |Space |Space |Raise | | Left | Down | Up |Right |
|
||||||
|
`-------------------------------------------------------------------------------------------------'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Colemak
|
||||||
|
```
|
||||||
|
,-----------------------------------------. ,-----------------------------------------.
|
||||||
|
| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| Tab | Q | W | F | P | G | | J | L | U | Y | ; | Bksp |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| Ctrl | A | R | S | T | D | | H | N | E | I | O | ' |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| Shift| Z | X | C | V | B | [ | ] | K | M | , | . | / |Enter |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
|Adjust| Esc | Alt | GUI | |Lower |Space |Space |Raise | | Left | Down | Up |Right |
|
||||||
|
`-------------------------------------------------------------------------------------------------'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Dvorak
|
||||||
|
```
|
||||||
|
,-----------------------------------------. ,-----------------------------------------.
|
||||||
|
| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Bksp |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| Tab | ' | , | . | P | Y | | F | G | C | R | L | Del |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| Ctrl | A | O | E | U | I | | D | H | T | N | S | / |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| Shift| ; | Q | J | K | X | [ | ] | B | M | W | V | Z |Enter |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
|Adjust| Esc | Alt | GUI | |Lower |Space |Space |Raise | | Left | Down | Up |Right |
|
||||||
|
`-------------------------------------------------------------------------------------------------'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Lower
|
||||||
|
```
|
||||||
|
,-----------------------------------------. ,-----------------------------------------.
|
||||||
|
| ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| | F1 | F2 | F3 | F4 | F5 | | F6 | _ | + | { | } | | |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| | F7 | F8 | F9 | F10 | F11 | ( | ) | F12 | | | Home | End | |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| | | | | | | | | | | Next | Vol- | Vol+ | Play |
|
||||||
|
`-------------------------------------------------------------------------------------------------'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Raise
|
||||||
|
```
|
||||||
|
,-----------------------------------------. ,-----------------------------------------.
|
||||||
|
| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Bksp |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| | F7 | F8 | F9 | F10 | F11 | | | F12 | | |PageDn|PageUp| |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| | | | | | | | | | | Next | Vol- | Vol+ | Play |
|
||||||
|
`-------------------------------------------------------------------------------------------------'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Adjust (Lower + Raise)
|
||||||
|
```
|
||||||
|
,-----------------------------------------. ,-----------------------------------------.
|
||||||
|
| F1 | F2 | F3 | F4 | F5 | F6 | | F7 | F8 | F9 | F10 | F11 | F12 |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| | Reset| Debug| | | | | | | | | | Del |
|
||||||
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
||||||
|
| | | | | | Mac | | Win |Qwerty|Colemk|Dvorak| | |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| | | | | | | | | | |RGB ON| HUE+ | SAT+ | VAL+ |
|
||||||
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
||||||
|
| | | | | | | | | | | MODE | HUE- | SAT- | VAL- |
|
||||||
|
`-------------------------------------------------------------------------------------------------'
|
||||||
|
```
|
||||||
36
boards/helix/kb.py
Normal file
36
boards/helix/kb.py
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard
|
||||||
|
from kmk.quickpin.pro_micro.sparkfun_promicro_rp2040 import pinout as pins
|
||||||
|
from kmk.scanners import DiodeOrientation
|
||||||
|
|
||||||
|
class KMKKeyboard(_KMKKeyboard):
|
||||||
|
col_pins = (
|
||||||
|
pins[19],
|
||||||
|
pins[18],
|
||||||
|
pins[17],
|
||||||
|
pins[16],
|
||||||
|
pins[15],
|
||||||
|
pins[14],
|
||||||
|
pins[13],
|
||||||
|
)
|
||||||
|
row_pins = (
|
||||||
|
pins[6],
|
||||||
|
pins[7],
|
||||||
|
pins[8],
|
||||||
|
pins[9],
|
||||||
|
pins[10],
|
||||||
|
)
|
||||||
|
diode_orientation = DiodeOrientation.COL2ROW
|
||||||
|
data_pin = pins[1]
|
||||||
|
rgb_pixel_pin = pins[0]
|
||||||
|
SDA = pins[4]
|
||||||
|
SCL = pins[5]
|
||||||
|
|
||||||
|
# flake8: noqa
|
||||||
|
# fmt: off
|
||||||
|
coord_mapping = [
|
||||||
|
0, 1, 2, 3, 4, 5, 40, 39, 38, 37, 36, 35,
|
||||||
|
7, 8, 9, 10, 11, 12, 47, 46, 45, 44, 43, 42,
|
||||||
|
14, 15, 16, 17, 18, 19, 54, 53, 52, 51, 50, 49,
|
||||||
|
21, 22, 23, 24, 25, 26, 27, 62, 61, 60, 59, 58, 57, 56,
|
||||||
|
28, 29, 30, 31, 32, 33, 34, 69, 68, 67, 66, 65, 64, 63
|
||||||
|
]
|
||||||
102
boards/helix/main.py
Normal file
102
boards/helix/main.py
Normal file
@ -0,0 +1,102 @@
|
|||||||
|
from kb import KMKKeyboard
|
||||||
|
|
||||||
|
from kmk.extensions.media_keys import MediaKeys
|
||||||
|
from kmk.extensions.rgb import RGB
|
||||||
|
from kmk.keys import KC
|
||||||
|
from kmk.modules.cg_swap import CgSwap
|
||||||
|
from kmk.modules.layers import Layers
|
||||||
|
from kmk.modules.split import Split, SplitSide
|
||||||
|
|
||||||
|
keyboard = KMKKeyboard()
|
||||||
|
|
||||||
|
# RGB backlight support
|
||||||
|
rgb = RGB(pixel_pin=keyboard.rgb_pixel_pin, num_pixels=32, hue_default=80, sat_default=255, val_default=80)
|
||||||
|
keyboard.extensions.append(rgb)
|
||||||
|
|
||||||
|
# Split keyboard support
|
||||||
|
split_side = SplitSide.LEFT
|
||||||
|
split_side = SplitSide.RIGHT
|
||||||
|
split = Split(
|
||||||
|
use_pio=True,
|
||||||
|
uart_flip=True,
|
||||||
|
data_pin=keyboard.data_pin
|
||||||
|
)
|
||||||
|
keyboard.modules.append(split)
|
||||||
|
|
||||||
|
# Media key support
|
||||||
|
keyboard.extensions.append(MediaKeys())
|
||||||
|
|
||||||
|
# CG Swap Module
|
||||||
|
cg_swap = CgSwap()
|
||||||
|
keyboard.modules.append(cg_swap)
|
||||||
|
|
||||||
|
# Layer support
|
||||||
|
layers_ext = Layers()
|
||||||
|
keyboard.modules.append(layers_ext)
|
||||||
|
|
||||||
|
# Cleaner key names
|
||||||
|
_______ = KC.TRNS
|
||||||
|
XXXXXXX = KC.NO
|
||||||
|
|
||||||
|
QWERTY = KC.DF(0)
|
||||||
|
COLEMAK = KC.DF(1)
|
||||||
|
DVORAK = KC.DF(2)
|
||||||
|
LOWER = KC.MO(3)
|
||||||
|
RAISE = KC.MO(4)
|
||||||
|
ADJUST = KC.MO(5)
|
||||||
|
|
||||||
|
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.GRV, KC.N1, KC.N2, KC.N3, KC.N4, KC.N5, KC.N6, KC.N7, KC.N8, KC.N9, KC.N0, KC.DEL,
|
||||||
|
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.LCTL, 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.LBRC, KC.RBRC, KC.N, KC.M, KC.COMM, KC.DOT, KC.SLSH, KC.ENT ,
|
||||||
|
ADJUST, KC.ESC, KC.LALT, KC.LGUI, XXXXXXX, LOWER, KC.SPC, KC.SPC, RAISE, XXXXXXX, KC.LEFT, KC.DOWN, KC.UP, KC.RGHT
|
||||||
|
],
|
||||||
|
[ # COLEMAK
|
||||||
|
KC.GRV, KC.N1, KC.N2, KC.N3, KC.N4, KC.N5, KC.N6, KC.N7, KC.N8, KC.N9, KC.N0, KC.DEL,
|
||||||
|
KC.TAB, KC.Q, KC.W, KC.F, KC.P, KC.G, KC.J, KC.L, KC.U, KC.Y, KC.SCLN, KC.BSPC,
|
||||||
|
KC.LCTL, KC.A, KC.R, KC.S, KC.T, KC.D, KC.H, KC.N, KC.E, KC.I, KC.O, KC.QUOT,
|
||||||
|
KC.LSFT, KC.Z, KC.X, KC.C, KC.V, KC.B, KC.LBRC, KC.RBRC, KC.K, KC.M, KC.COMM, KC.DOT, KC.SLSH, KC.ENT ,
|
||||||
|
ADJUST, KC.ESC, KC.LALT, KC.LGUI, XXXXXXX, LOWER, KC.SPC, KC.SPC, RAISE, XXXXXXX, KC.LEFT, KC.DOWN, KC.UP, KC.RGHT
|
||||||
|
],
|
||||||
|
[ # DVORAK
|
||||||
|
KC.GRV, KC.N1, KC.N2, KC.N3, KC.N4, KC.N5, KC.N6, KC.N7, KC.N8, KC.N9, KC.N0, KC.DEL,
|
||||||
|
KC.TAB, KC.QUOT, KC.COMM, KC.DOT, KC.P, KC.Y, KC.F, KC.G, KC.C, KC.R, KC.L, KC.DEL,
|
||||||
|
KC.LCTL, KC.A, KC.O, KC.E, KC.U, KC.I, KC.D, KC.H, KC.T, KC.N, KC.S, KC.SLSH,
|
||||||
|
KC.LSFT, KC.SCLN, KC.Q, KC.J, KC.K, KC.X, KC.LBRC, KC.RBRC, KC.B, KC.M, KC.W, KC.V, KC.Z, KC.ENT ,
|
||||||
|
ADJUST, KC.ESC, KC.LALT, KC.LGUI, XXXXXXX, LOWER, KC.SPC, KC.SPC, RAISE, XXXXXXX, KC.LEFT, KC.DOWN, KC.UP, KC.RGHT
|
||||||
|
],
|
||||||
|
[ # LOWER
|
||||||
|
KC.TILD, KC.EXLM, KC.AT, KC.HASH, KC.DLR, KC.PERC, KC.CIRC, KC.AMPR, KC.ASTR, KC.LPRN, KC.RPRN, _______,
|
||||||
|
KC.TILD, KC.EXLM, KC.AT, KC.HASH, KC.DLR, KC.PERC, KC.CIRC, KC.AMPR, KC.ASTR, KC.LPRN, KC.RPRN, _______,
|
||||||
|
_______, KC.F1, KC.F2, KC.F3, KC.F4, KC.F5, KC.F6, KC.UNDS, KC.PLUS, KC.LCBR, KC.RCBR, KC.PIPE,
|
||||||
|
KC.CAPS, KC.F7, KC.F8, KC.F9, KC.F10, KC.F11, KC.LPRN, KC.RPRN, KC.F12, _______, _______, KC.HOME, KC.END, _______,
|
||||||
|
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC.MNXT, KC.VOLD, KC.VOLU, KC.MPLY
|
||||||
|
],
|
||||||
|
[ # RAISE
|
||||||
|
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.GRV, KC.N1, KC.N2, KC.N3, KC.N4, KC.N5, KC.N6, KC.N7, KC.N8, KC.N9, KC.N0, 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.CAPS, KC.F7, KC.F8, KC.F9, KC.F10, KC.F11, _______, _______, KC.F12, _______, _______, KC.PGDN, KC.PGUP, _______,
|
||||||
|
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC.MNXT, KC.VOLD, KC.VOLU, KC.MPLY
|
||||||
|
],
|
||||||
|
[ # ADJUSTs
|
||||||
|
KC.F1, KC.F2, KC.F3, KC.F4, KC.F5, KC.F6, KC.F7, KC.F8, KC.F9, KC.F10, KC.F11, KC.F12,
|
||||||
|
_______, KC.RESET, KC.DEBUG, _______, _______, _______, _______, _______, _______, _______, _______, KC.DEL,
|
||||||
|
_______, _______, _______, _______, _______, KC.CG_NORM, KC.CG_SWAP, QWERTY, COLEMAK, DVORAK, _______, _______,
|
||||||
|
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI,
|
||||||
|
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_HUD, RGB_SAD, RGB_VAD
|
||||||
|
]
|
||||||
|
]
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
keyboard.go()
|
||||||
Loading…
x
Reference in New Issue
Block a user