111 lines
7.4 KiB
Markdown
111 lines
7.4 KiB
Markdown
|
# 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- |
|
||
|
|
`-------------------------------------------------------------------------------------------------'
|
||
|
|
```
|