forked from forks/qmk_firmware
c66df16644
* Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
156 lines
8.7 KiB
Markdown
156 lines
8.7 KiB
Markdown
# The Default Helix Layout
|
|
## 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 | EISU |Lower |Space |Space |Raise | KANA | 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 | EISU |Lower |Space |Space |Raise | KANA | 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 | EISU |Lower |Space |Space |Raise | KANA | Left | Down | Up |Right |
|
|
`-------------------------------------------------------------------------------------------------'
|
|
```
|
|
|
|
## Layers
|
|
|
|
|Priority|number|name|description|
|
|
| ---- | ---- | --- | --- |
|
|
|high|16|Adjust|Functions|
|
|
||4|Raise|Numeric charactors|
|
|
||3|Lower|Other charactors|
|
|
||2|Dvorak|Dvorak leyout|
|
|
||1|Colemak|Colemak leyout|
|
|
|low|0|Qwerty|QWERTY leyout(base)|
|
|
|
|
### 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|RGBRST| | | | | | | | | | Del |
|
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
|
| | | |Aud on|Audoff| Mac | | Win |Qwerty|Colemk|Dvorak| | |
|
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
|
| | | | | | | | | | |RGB ON| HUE+ | SAT+ | VAL+ |
|
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
|
| | | | | | | | | | | MODE | HUE- | SAT- | VAL- |
|
|
`-------------------------------------------------------------------------------------------------'
|
|
```
|
|
|
|
## Customize
|
|
|
|
see `qmk_firmware/keyboards/helix/rev2/keymaps/default/rules.mk`
|
|
|
|
```
|
|
# Helix Spacific Build Options
|
|
# you can uncomment and edit follows 7 Variables
|
|
# jp: 以下の7つの変数を必要に応じて編集し、コメントアウトをはずします。
|
|
# HELIX_ROWS = 5 # Helix Rows is 4 or 5
|
|
# OLED_ENABLE = yes # OLED_ENABLE
|
|
# LOCAL_GLCDFONT = no # use each keymaps "helixfont.h" insted of "common/glcdfont.c"
|
|
# LED_BACK_ENABLE = no # LED backlight (Enable WS2812 RGB underlight.)
|
|
# LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight.)
|
|
# LED_ANIMATIONS = yes # LED animations
|
|
# IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
|
|
```
|
|
## Compile
|
|
|
|
go to qmk top directory.
|
|
```
|
|
$ cd qmk_firmware
|
|
```
|
|
|
|
build
|
|
```
|
|
$ make helix:default # with oled
|
|
$ make helix/rev2/back:default # with oled and backlight
|
|
$ make HELIX=no-ani helix/rev2/back:default # with oled and backlight without animation
|
|
$ make helix/rev2/under:default # with oled and underglow
|
|
$ make HELIX=no-oled helix:default # without oled
|
|
```
|
|
|
|
build (experimental use of split_common with backlight and oled)
|
|
```
|
|
$ make helix/rev2/sc:default
|
|
```
|
|
|
|
flash to keyboard
|
|
```
|
|
$ make helix:default:flash # with oled
|
|
$ make helix/rev2/back:default:flash # with oled and backlight
|
|
$ make HELIX=no-ani helix/rev2/back:default:flash # with oled and backlight without animation
|
|
$ make helix/rev2/under:default:flash # with oled and underglow
|
|
$ make HELIX=no-oled helix:default:flash # without oled
|
|
```
|
|
|
|
## Link
|
|
* more detail wrote in Japanese [helix/Doc/firmware_jp.md](https://github.com/MakotoKurauchi/helix/blob/master/Doc/firmware_jp.md)
|
|
* [Helix top](https://github.com/MakotoKurauchi/helix)
|
|
|