2018-04-24 22:43:57 +06:00
|
|
|
# The Default Helix Layout
|
|
|
|
|
## Layout
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
### Qwerty
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
```
|
|
|
|
|
,-----------------------------------------. ,-----------------------------------------.
|
|
|
|
|
| ` | 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 |
|
|
|
|
|
`-------------------------------------------------------------------------------------------------'
|
|
|
|
|
```
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
### 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 |
|
|
|
|
|
`-------------------------------------------------------------------------------------------------'
|
|
|
|
|
```
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
### 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 |
|
|
|
|
|
`-------------------------------------------------------------------------------------------------'
|
|
|
|
|
```
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
## Layers
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
|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)|
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
### Lower
|
|
|
|
|
```
|
|
|
|
|
,-----------------------------------------. ,-----------------------------------------.
|
|
|
|
|
| ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
|
|
|
|
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
|
|
|
|
| ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
|
|
|
|
|
|------+------+------+------+------+------| |------+------+------+------+------+------|
|
|
|
|
|
| | F1 | F2 | F3 | F4 | F5 | | F6 | _ | + | { | } | | |
|
|
|
|
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
|
|
|
|
| | F7 | F8 | F9 | F10 | F11 | ( | ) | F12 | | | Home | End | |
|
|
|
|
|
|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
|
|
|
|
|
| | | | | | | | | | | Next | Vol- | Vol+ | Play |
|
|
|
|
|
`-------------------------------------------------------------------------------------------------'
|
|
|
|
|
```
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
### 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 |
|
|
|
|
|
`-------------------------------------------------------------------------------------------------'
|
|
|
|
|
```
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
### 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- |
|
|
|
|
|
`-------------------------------------------------------------------------------------------------'
|
|
|
|
|
```
|
2018-01-28 23:14:12 +06:00
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
## Customize
|
|
|
|
|
|
|
|
|
|
see `qmk_firmware/keyboards/helix/rev2/keymaps/default/rules.mk`
|
|
|
|
|
|
|
|
|
|
```
|
[Keyboard] Cleanup helix rules options (#6952)
* add temporary test shell-spript
* Use LINK_TIME_OPTIMIZATION_ENABLE instead of Link_Time_Optimization
No change in build result.
* Helix config.h use '#pragma once'
No change in build result.
* Helix helix.h,rev?/rev?.h,pico/pico.h use '#pragma once'
No change in build result.
* Use drivers/avr/pro_micro.h instead of keyboards/helix/pro_micro.h
No change in build result.
* remove keyboards/helix/{rev2|pico}/serial_config.h
No change in build result.
* 'HELIX_ROWS' macro is now referenced only in rev1/config.h and rev2/config.h.
No change in build result.
* The contents of helix/rules.mk were distributed to subdirectories.
This is a preparation to create a new subdirectory for helix code using split_common.
No change in build result.
remove 'USE_I2C = yes', 'SUBPROJECT_rev1 = no' from keyboards/helix/rules.mk.
follow code move from keyboards/helix/rules.mk to keyboards/helix/{rev1,rev2,pico}/rules.mk.
----
SRC += i2c.c
SRC += serial.c
SRC += ssd1306.c
CUSTOM_MATRIX = yes
---
* helix/{i2c.[ch], serial.[ch], ssd1306.[ch]} move into helix/local_drivers/
No change in build result.
* Simplified 'helix/pico/keymap/*/rules.mk' using KEYBOARD_LOCAL_FEATURES_MK.
No change in build result.
* add keyboards/helix/pico/local_features.mk
* add 'KEYBOARD_LOCAL_FEATURES_MK := $(dir $(lastword $(MAKEFILE_LIST)))local_features.mk' into keyboards/helix/pico/rules.mk
* remove HELIX_CUSTOMISE_MSG from keyboards/helix/pico/keymaps/*/rules.mk
* remove HELIX= process from keyboards/helix/pico/keymaps/*/rules.mk
* remove convert code(helix to standaerd) from keyboards/helix/pico/keymaps/*/rules.mk
* add 'include $(strip $(KEYBOARD_LOCAL_FEATURES_MK))' into keyboards/helix/pico/keymaps/*/rules.mk
* Simplified 'helix/rev2/keymap/*/rules.mk' using KEYBOARD_LOCAL_FEATURES_MK.
No change in build result.
* add keyboards/helix/rev2/local_features.mk
* add 'KEYBOARD_LOCAL_FEATURES_MK := $(dir $(lastword $(MAKEFILE_LIST)))local_features.mk' into keyboards/helix/rev2/rules.mk
* remove HELIX_CUSTOMISE_MSG from keyboards/helix/rev2/keymaps/*/rules.mk
* remove HELIX= process from keyboards/helix/rev2/keymaps/*/rules.mk
* remove convert code(helix to standaerd) from keyboards/helix/rev2/keymaps/*/rules.mk
* add 'include $(strip $(KEYBOARD_LOCAL_FEATURES_MK))' into keyboards/helix/rev2/keymaps/*/rules.mk
* Added helix keyboard build NEW method.
No change in build result.
## Helix build
$ make helix:default ## no oled, no backlight, no underglow
$ make helix/rev2/back:default ## no oled, with backlight, no underglow
$ make helix/rev2/under:default ## no oled, no backlight, with underglow
$ make helix/rev2/oled:default ## with oled, no backlight, not underglow
$ make helix/rev2/oled/back:default ## with oled, with backlight, no underglow
$ make helix/rev2/back/oled:default ## with oled, with backlight, no underglow
$ make helix/rev2/oled/under:default ## with oled, no backlight, with underglow
$ make helix/rev2/under/oled:default ## with oled, no backlight, with underglow
## Helix pico build
$ make helix/pico:default ## no oled, no backlight, no underglow
$ make helix/pico/back:default ## no oled, with backlight, no underglow
$ make helix/pico/under:default ## no oled, no backlight, with underglow
$ make helix/pico/oled:default ## with oled, no backlight, not underglow
* add temporary test shell-spript
* test end remove test script. Revert "add temporary test shell-spript"
This reverts commit 5dac20cd0f8b4bc192edb2313652c1635f829657.
* test end remove test script. Revert "add temporary test shell-spript"
This reverts commit ec49f63b2dc0f2b3fe8c1c36ffa615cee2f7e3ed.
* Extended the 'HELIX=' option. add keyword 'verbose', 'no_ani'.
No change in build result.
* update keyboards/helix/{rev2,pico}/keymaps/default/readme.md
* rename KEYBOARD_TOP_DIR to HELIX_TOP_DIR in rules.mk
* update keyboards/helix/{rev2,pico}/keymaps/default/readme_jp.md
* rm keyboards/helix/pico/oled/rules.mk
* update helix's readmes. All the ':avrdude' was replaced with ':flash'.
* remove F_CPU, ARCH, F_USB, INTERRUPT_CONTROL_ENDPOINT from helix/rules.mk
No change in build result.
2019-10-17 00:01:49 +06:00
|
|
|
# Helix Spacific Build Options
|
|
|
|
|
# you can uncomment and edit follows 7 Variables
|
|
|
|
|
# jp: 以下の7つの変数を必要に応じて編集し、コメントアウトをはずします。
|
|
|
|
|
# HELIX_ROWS = 5 # Helix Rows is 4 or 5
|
2020-11-29 02:02:18 +06:00
|
|
|
# OLED_ENABLE = yes # OLED_ENABLE
|
[Keyboard] Cleanup helix rules options (#6952)
* add temporary test shell-spript
* Use LINK_TIME_OPTIMIZATION_ENABLE instead of Link_Time_Optimization
No change in build result.
* Helix config.h use '#pragma once'
No change in build result.
* Helix helix.h,rev?/rev?.h,pico/pico.h use '#pragma once'
No change in build result.
* Use drivers/avr/pro_micro.h instead of keyboards/helix/pro_micro.h
No change in build result.
* remove keyboards/helix/{rev2|pico}/serial_config.h
No change in build result.
* 'HELIX_ROWS' macro is now referenced only in rev1/config.h and rev2/config.h.
No change in build result.
* The contents of helix/rules.mk were distributed to subdirectories.
This is a preparation to create a new subdirectory for helix code using split_common.
No change in build result.
remove 'USE_I2C = yes', 'SUBPROJECT_rev1 = no' from keyboards/helix/rules.mk.
follow code move from keyboards/helix/rules.mk to keyboards/helix/{rev1,rev2,pico}/rules.mk.
----
SRC += i2c.c
SRC += serial.c
SRC += ssd1306.c
CUSTOM_MATRIX = yes
---
* helix/{i2c.[ch], serial.[ch], ssd1306.[ch]} move into helix/local_drivers/
No change in build result.
* Simplified 'helix/pico/keymap/*/rules.mk' using KEYBOARD_LOCAL_FEATURES_MK.
No change in build result.
* add keyboards/helix/pico/local_features.mk
* add 'KEYBOARD_LOCAL_FEATURES_MK := $(dir $(lastword $(MAKEFILE_LIST)))local_features.mk' into keyboards/helix/pico/rules.mk
* remove HELIX_CUSTOMISE_MSG from keyboards/helix/pico/keymaps/*/rules.mk
* remove HELIX= process from keyboards/helix/pico/keymaps/*/rules.mk
* remove convert code(helix to standaerd) from keyboards/helix/pico/keymaps/*/rules.mk
* add 'include $(strip $(KEYBOARD_LOCAL_FEATURES_MK))' into keyboards/helix/pico/keymaps/*/rules.mk
* Simplified 'helix/rev2/keymap/*/rules.mk' using KEYBOARD_LOCAL_FEATURES_MK.
No change in build result.
* add keyboards/helix/rev2/local_features.mk
* add 'KEYBOARD_LOCAL_FEATURES_MK := $(dir $(lastword $(MAKEFILE_LIST)))local_features.mk' into keyboards/helix/rev2/rules.mk
* remove HELIX_CUSTOMISE_MSG from keyboards/helix/rev2/keymaps/*/rules.mk
* remove HELIX= process from keyboards/helix/rev2/keymaps/*/rules.mk
* remove convert code(helix to standaerd) from keyboards/helix/rev2/keymaps/*/rules.mk
* add 'include $(strip $(KEYBOARD_LOCAL_FEATURES_MK))' into keyboards/helix/rev2/keymaps/*/rules.mk
* Added helix keyboard build NEW method.
No change in build result.
## Helix build
$ make helix:default ## no oled, no backlight, no underglow
$ make helix/rev2/back:default ## no oled, with backlight, no underglow
$ make helix/rev2/under:default ## no oled, no backlight, with underglow
$ make helix/rev2/oled:default ## with oled, no backlight, not underglow
$ make helix/rev2/oled/back:default ## with oled, with backlight, no underglow
$ make helix/rev2/back/oled:default ## with oled, with backlight, no underglow
$ make helix/rev2/oled/under:default ## with oled, no backlight, with underglow
$ make helix/rev2/under/oled:default ## with oled, no backlight, with underglow
## Helix pico build
$ make helix/pico:default ## no oled, no backlight, no underglow
$ make helix/pico/back:default ## no oled, with backlight, no underglow
$ make helix/pico/under:default ## no oled, no backlight, with underglow
$ make helix/pico/oled:default ## with oled, no backlight, not underglow
* add temporary test shell-spript
* test end remove test script. Revert "add temporary test shell-spript"
This reverts commit 5dac20cd0f8b4bc192edb2313652c1635f829657.
* test end remove test script. Revert "add temporary test shell-spript"
This reverts commit ec49f63b2dc0f2b3fe8c1c36ffa615cee2f7e3ed.
* Extended the 'HELIX=' option. add keyword 'verbose', 'no_ani'.
No change in build result.
* update keyboards/helix/{rev2,pico}/keymaps/default/readme.md
* rename KEYBOARD_TOP_DIR to HELIX_TOP_DIR in rules.mk
* update keyboards/helix/{rev2,pico}/keymaps/default/readme_jp.md
* rm keyboards/helix/pico/oled/rules.mk
* update helix's readmes. All the ':avrdude' was replaced with ':flash'.
* remove F_CPU, ARCH, F_USB, INTERRUPT_CONTROL_ENDPOINT from helix/rules.mk
No change in build result.
2019-10-17 00:01:49 +06:00
|
|
|
# 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)
|
2018-04-24 22:43:57 +06:00
|
|
|
```
|
|
|
|
|
## Compile
|
|
|
|
|
|
|
|
|
|
go to qmk top directory.
|
|
|
|
|
```
|
|
|
|
|
$ cd qmk_firmware
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
build
|
|
|
|
|
```
|
2020-11-29 02:02:18 +06:00
|
|
|
$ 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
|
2018-04-24 22:43:57 +06:00
|
|
|
```
|
|
|
|
|
|
2020-11-29 02:02:18 +06:00
|
|
|
build (experimental use of split_common with backlight and oled)
|
2020-03-10 14:33:46 +06:00
|
|
|
```
|
|
|
|
|
$ make helix/rev2/sc:default
|
|
|
|
|
```
|
|
|
|
|
|
2018-04-24 22:43:57 +06:00
|
|
|
flash to keyboard
|
|
|
|
|
```
|
2020-11-29 02:02:18 +06:00
|
|
|
$ 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
|
2018-04-24 22:43:57 +06:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 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)
|
2018-01-28 23:14:12 +06:00
|
|
|
|
