mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-27 11:59:54 +00:00
2d14d12c74
* is_master, has_usb() move to rev2.[hc]
* Do recent helix/rev2 changes to helix/pico as well.
helix/pico/matrix.c: remove 'is_master'
helix/pico/pico.c: add 'is_master'
helix/pico/pico.h: add 'has_usb()' macro
helix/pico/split_util.c: remove 'setup_handedness()' 'has_usb()', add 'is_helix_master()' etc
* add HELIX=scan option into {rev2/pico}/local_features.mk
Made DEBUG_MATRIX_SCAN_RATE easy to use.
* Changed rules.mk to link "helix/local_drivers/ssd1306.c" only when OLED_ENABLE = yes.
* Added option to use split_common for helix/rev2, helix/pico keyboard.
how to build:
### build helix/pico (HelixPico) with helix current codes
$ make helix/pico:KEY_MAP
$ make helix/pico/back:KEY_MAP
### build helix/rev2 (Helix or Helix beta) with helix current codes
$ make helix:KEY_MAP
$ make helix/rev2/back:KEY_MAP
$ make helix/rev2/under:KEY_MAP
$ make helix/rev2/oled:KEY_MAP
$ make helix/rev2/oled/back:KEY_MAP
$ make helix/rev2/oled/under:KEY_MAP
### build helix/pico (HelixPico) with split_common codes
$ make helix/pico/sc:KEY_MAP
$ make helix/pico/sc/back:KEY_MAP
$ make helix/pico/sc/under:KEY_MAP
### build helix/rev2 (Helix) with split_common codes
$ make helix/rev2/sc:KEY_MAP
$ make helix/rev2/sc/back:KEY_MAP
$ make helix/rev2/sc/under:KEY_MAP
$ make helix/rev2/sc/oled:KEY_MAP
$ make helix/rev2/sc/oledback:KEY_MAP
$ make helix/rev2/sc/oledunder:KEY_MAP
* add matrix_slave_scan_user() to helix/rev2/rev2.c, helix/pico/pico.h
* Changed 'helix:xulkal' to always use split_common and removed ad hoc code.
Added the following line to 'helix/rev2/keymaps/xulkal/rules.mk':
SPLIT_KEYBOARD = yes
Removed the following ad hoc code from 'users/xulkal/custom_oled.c':
#if KEYBOARD_helix_rev2
extern uint8_t is_master;
bool is_keyboard_master(void) { return is_master; }
#endif
* add '#define DIODE_DIRECTION COL2ROW' into helix/{rev2|pico}/config.h
This commit does not change the build result.
* update helix readme
* keyboards/helix/readme.md
* keyboards/helix/pico/keymaps/default/readme.md
* keyboards/helix/rev2/keymaps/default/readme.md
Co-authored-by: mtei <2170248+mtei@users.noreply.github.com>
166 lines
9.1 KiB
Markdown
166 lines
9.1 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 = no # 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
|
|
$ make helix/rev2/back:default # with backlight
|
|
$ make HELIX=no_ani helix/rev2/back:default # with backlight without animation
|
|
$ make helix/rev2/under:default # with underglow
|
|
$ make helix/rev2/oled:default # with oled
|
|
$ make helix/rev2/oled/back:default # with oled and backlight
|
|
$ make helix/rev2/oled/under:default # with oled and underglow
|
|
```
|
|
|
|
build (experimental use of split_common)
|
|
```
|
|
$ make helix/rev2/sc:default
|
|
$ make helix/rev2/sc/back:default
|
|
$ make helix/rev2/sc/under:default
|
|
$ make helix/rev2/sc/oled:default
|
|
$ make helix/rev2/sc/oledback:default
|
|
$ make helix/rev2/sc/oledunder:default
|
|
```
|
|
|
|
flash to keyboard
|
|
```
|
|
$ make helix:default:flash
|
|
$ make helix/rev2/back:default:flash # with backlight
|
|
$ make HELIX=no_ani helix/rev2/back:default:flash # with backlight without animation
|
|
$ make helix/rev2/under:default:flash # with underglow
|
|
$ make helix/rev2/oled:default:flash # with oled
|
|
$ make helix/rev2/oled/back:default:flash # with oled and backlight
|
|
$ make helix/rev2/oled/under:default:flash # with oled and underglow
|
|
|
|
```
|
|
|
|
## 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)
|
|
|