mirror of
https://github.com/qmk/qmk_firmware.git
synced 2026-09-23 02:16:36 +08:00
New keymap for The Helix keyboard("five_rows") (#2592)
* duplicate keyboards/helix/rev2/keymaps/default to keyboards/helix/rev2/keymaps/five_rows
* OLED Layer display 'Qwerty','Colemak','Dvorak'
* set Qwerty, Lower, Raise map
* set Colemak map
* set Dvorak map
* OLED Layer display 'Raise','Lower' change to 'Extra char','Function'
* fix ExtraChar Layer Shift-key disable
* Raise,Lower,Adjust layer modify
some key change KC_TRNS to KC_NO
add KANA, EISU key
* refine keymaps/five_rows/{config.h,rules.mk} for easy and safe customize
* modify Adjust layer: all function into left hand, remove F1..F12,DEL
* Add Helix five_rows keymap README.md and README_jp.md
* Raise Layer modify: enable Raise(Extr)+Lower(Func)==Adjust
* fix image file url in README.md,README_jp.md
* change Layer display on OLED
* change OLED display base name position
This commit is contained in:
Takeshi ISHII
committed by
Drashna Jaelre
Drashna Jaelre
parent
3a49ad06cd
commit
824d584d8c
@@ -0,0 +1,73 @@
|
||||
# Keymap for 5 rows Helix keyboard
|
||||
|
||||
This keymap is only for 5 rows Helix keyboard.
|
||||
|
||||
## Layout
|
||||
|
||||
|
||||
|
||||
## Layer
|
||||
|
||||
|Priority|Number|Name|Discription|
|
||||
| ---- | ---- | --- | --- |
|
||||
|high|16|Adjust| keyboard local functions|
|
||||
||4|Extra char| some charactors |
|
||||
||3|Function| function keys |
|
||||
||2|Dvorak|Dvorak|
|
||||
||1|Colemak|Colemak|
|
||||
|low|0|Qwerty|QWERTY (base)|
|
||||
|
||||
### Adjust Layer
|
||||
|
||||
Adjust Layer has keyboard local function keys.
|
||||
|
||||
* LED control.
|
||||
* Mac/Win mode change.
|
||||
* Qwerty/Colemak/Dvorak change.
|
||||
|
||||
### Mac mode and Win mode
|
||||
|
||||
Mac mode swap Alt/Win(GUI) key.
|
||||
|
||||
|mode|key|code|
|
||||
| ---- | ---- | --- |
|
||||
|Mac mode|Adjust + g(Qwerty)|AG_NORM|
|
||||
|Win mode|Adjust + h(Qwerty)|AG_SWAP|
|
||||
| |Adjust + t(Qwerty)| |
|
||||
|
||||
### LED control
|
||||
|
||||
|command|key|code|
|
||||
| ---- | ---- | --- |
|
||||
|on/off|Adjust + ,(Qwerty)|RGB_TOG|
|
||||
| |Adjust + v(Qwerty)| |
|
||||
|change mode|Adjust + Right option |RGB_SMOD|
|
||||
| |Adjust + c(Qwerty)| |
|
||||
|HUE +|Adjust + .(Qwerty) |RGB_HUI|
|
||||
| |Adjust + Left Control| |
|
||||
|HUE -|Adjust + menu |RGB_HUD|
|
||||
| |Adjust + Left Shift | |
|
||||
|SAT +|Adjust + /(Qwerty) |RGB_SAI|
|
||||
| |Adjust + a(Qwerty) | |
|
||||
|SAT -|Adjust + right hand left side Fn|RGB_SAD|
|
||||
| |Adjust + z(Qwerty) | |
|
||||
|Bright +|Adjust + Right Shift |RGB_VAI|
|
||||
| |Adjust + s(Qwerty)| |
|
||||
|Bright -|Adjust + right hand right side Fn|RGB_VAD|
|
||||
| |Adjust + x(Qwerty) | |
|
||||
|reset|Adjust + w(Qwerty)|RGBRST|
|
||||
|
||||
### Qwerty, Colemak, Dvorak selection
|
||||
|
||||
|char layout|key|
|
||||
| ---- | ---- |
|
||||
|Qwerty | Adjust + j(Qwerty) |
|
||||
| | Adjust + 5|
|
||||
|Calemak| Adjust + k(Qwerty) |
|
||||
| | Adjust + 4|
|
||||
|Dvorak | Adjust + l(Qwerty) |
|
||||
| | Adjust + 3|
|
||||
|
||||
## Note
|
||||
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
# Keymap for 5 rows Helix keyboard
|
||||
|
||||
本キーマップは、Helix キーボードの5行版専用のキーマップです。
|
||||
|
||||
普通のキーボード使用者が、Helix キーボードを使うときになるべく違いが少なく戸惑いが少なくなるように意図したキーマップです。（意図通り成功しているかどうかは使用する人の判断で、、、)
|
||||
|
||||
## キー配置
|
||||
以下に、Qwerty配列時の、文字配列の図を示します。
|
||||
|
||||
|
||||
|
||||
## レイヤー
|
||||
|
||||
|優先順位|番号|名称|内容|
|
||||
| ---- | ---- | --- | --- |
|
||||
|高い|16|Adjust|機能キー（紫）|
|
||||
||4|Extra char|記号類（赤）|
|
||||
||3|Function|ファンクションキー類（青）|
|
||||
||2|Dvorak|Dvorak配列|
|
||||
||1|Colemak|Colemak配列|
|
||||
|低い|0|Qwerty|QWERTY配列（ベース）|
|
||||
|
||||
Qwerty/Colemak/Dvorak の各レイヤーは、後述する、Ajuest キーによる選択で、いずれか一つだけが有効になり、標準のキーマップとなります。
|
||||
|
||||
Adjust レイヤーは、Adjust キーを押している間だけ有効になり、標準のキーマップの上にかぶさるように一部のキーが置き換わります。
|
||||
|
||||
Function レイヤーは、Fn キーを押している間だけ有効になり、標準のキーマップの上にかぶさるように一部のキーが置き換わります。
|
||||
|
||||
Extra レイヤーは、Enter キーを一定時間(0.1秒)以上押していると押している間だけ有効になり、標準のキーマップの上にかぶさるように一部のキーが置き換わります。
|
||||
このため、Enterキーで Enter を入力するには、Enterキーを押して短時間ですぐ離してください。
|
||||
|
||||
### Adjust レイヤー
|
||||
Ajust レイヤーは、Helix の標準キーマップ "default" から F1,F2..F12 を除き、右側にあった機能キーを
|
||||
左側にも追加したものとなっています。
|
||||
|
||||
LEDコントロール、Mac/Win モードの切り替え、Qwerty配列, Colemak配列, Dvorak配列の切り替えが行えます。
|
||||
|
||||
### MacモードとWinモード
|
||||
キーボードには、Mac モードと、Win モードの二つのモードがあります。
|
||||
|
||||
現在のモードはOLEDにアイコンとして表示されます。
|
||||
(以下の指定キーは、Qwerty配列時の文字を使ってキーを表示しています）
|
||||
|
||||
|コマンド|指定キー|コード|
|
||||
| ---- | ---- | --- |
|
||||
|Macモード|Adjust + g(Qwerty)|AG_NORM|
|
||||
|Winモード|Adjust + h(Qwerty)|AG_SWAP|
|
||||
| |Adjust + t(Qwerty)| |
|
||||
|
||||
Mac モードと Win モードでは、AltキーとWin(GUI)キーが入れ替わります。
|
||||
|
||||
Mac モードでは、上の配列図の「英数キー」と「かなキー」で英語モードと日本語モードの切り替えができます。。
|
||||
|
||||
Winモードでは、該当のキーはどちらも共に Alt + `（日本語IMEの切り替え）として入力されます。
|
||||
|
||||
### LEDコントロール
|
||||
|
||||
バックライトやUnderglowをコントロールするにはAdjustレイヤーにある機能キーを使います。
|
||||
(以下の指定キーは、Qwerty配列時の文字を使ってキーを表示しています）
|
||||
|
||||
|コマンド|指定キー|コード|
|
||||
| ---- | ---- | --- |
|
||||
|オン／オフ|Adjust + ,(Qwerty)|RGB_TOG|
|
||||
| |Adjust + v(Qwerty)| |
|
||||
|モード切り替え|Adjust + Right option |RGB_SMOD|
|
||||
| |Adjust + c(Qwerty)| |
|
||||
|色相 +|Adjust + .(Qwerty)|RGB_HUI|
|
||||
| |Adjust + Left Control| |
|
||||
|色相 -|Adjust + menu|RGB_HUD|
|
||||
| |Adjust + Left Shift | |
|
||||
|彩度 +|Adjust + /(Qwerty) |RGB_SAI|
|
||||
| |Adjust + a(Qwerty) | |
|
||||
|彩度 -|Adjust + 右手Fnの左側|RGB_SAD|
|
||||
| |Adjust + z(Qwerty) | |
|
||||
|明度 +|Adjust + Right Shift|RGB_VAI|
|
||||
| |Adjust + s(Qwerty) | |
|
||||
|明度 -|Adjust + 右手Fnの右側|RGB_VAD|
|
||||
| |Adjust + x(Qwerty) | |
|
||||
|リセット|Adjust + w|RGBRST|
|
||||
|
||||
### 文字配列選択
|
||||
Qwerty, Colemak, Dvorak それぞれの文字配列の選択は以下のキーを使います。
|
||||
|
||||
|選択配列|指定キー|
|
||||
| ---- | ---- |
|
||||
|Qwerty | Adjust + j(Qwerty) |
|
||||
| | Adjust + 5|
|
||||
|Calemak| Adjust + k(Qwerty) |
|
||||
| | Adjust + 4|
|
||||
|Dvorak | Adjust + l(Qwerty) |
|
||||
| | Adjust + 3|
|
||||
|
||||
## 備考
|
||||
本キーマップは、通常のキーボードの主要部分のホームポジション周辺をなるべくそのまま踏襲する方針で作成しました。
|
||||
変更点は以下の通りです。
|
||||
|
||||
* 右手小指により多く割り当たっていた5つの記号と左上の1つの記号を中央に集め人差し指の担当とする。
|
||||
* Enter キーを親指担当として中央手前に移動。
|
||||
* Control キーを左右共にホームポジションの行に移動。
|
||||
* 左手親指に BackSpace キーを割り当てる。
|
||||
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
/*
|
||||
This is the c configuration file for the keymap
|
||||
|
||||
Copyright 2012 Jun Wako <wakojun@gmail.com>
|
||||
Copyright 2015 Jack Humbert
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef CONFIG_USER_H
|
||||
#define CONFIG_USER_H
|
||||
|
||||
#include "../../config.h"
|
||||
|
||||
/* Use I2C or Serial */
|
||||
|
||||
#define USE_I2C
|
||||
#define USE_SERIAL
|
||||
//#define USE_MATRIX_I2C
|
||||
|
||||
/* Select hand configuration */
|
||||
|
||||
#define MASTER_LEFT
|
||||
// #define MASTER_RIGHT
|
||||
// #define EE_HANDS
|
||||
|
||||
// Helix keyboard OLED support
|
||||
// see ./rules.mk: OLED_ENABLE=yes or no
|
||||
#ifdef OLED_ENABLE
|
||||
#define SSD1306OLED
|
||||
#endif
|
||||
|
||||
/* Select rows configuration */
|
||||
#define HELIX_ROWS 5
|
||||
|
||||
/* key matrix size */
|
||||
// Rows are doubled-up
|
||||
#if HELIX_ROWS == 4
|
||||
#define MATRIX_ROWS 8
|
||||
#define MATRIX_COLS 7
|
||||
#define MATRIX_ROW_PINS { D4, C6, D7, E6 }
|
||||
#elif HELIX_ROWS == 5
|
||||
#define MATRIX_ROWS 10
|
||||
#define MATRIX_COLS 7
|
||||
#define MATRIX_ROW_PINS { D4, C6, D7, E6, B4 }
|
||||
#else
|
||||
#error "expected HELIX_ROWS 4 or 5"
|
||||
#endif
|
||||
|
||||
#define USE_SERIAL_PD2
|
||||
|
||||
#define PREVENT_STUCK_MODIFIERS
|
||||
#define TAPPING_FORCE_HOLD
|
||||
#define TAPPING_TERM 100
|
||||
|
||||
#undef RGBLED_NUM
|
||||
// Helix keyboard RGB LED support
|
||||
//#define RGBLIGHT_ANIMATIONS : see ./rules.mk: LED_ANIMATIONS = yes or no
|
||||
// see ./rules.mk: LED_BACK_ENABLE or LED_UNDERGLOW_ENABLE set yes
|
||||
#ifdef RGBLED_BACK
|
||||
#if HELIX_ROWS == 4
|
||||
#define RGBLED_NUM 25
|
||||
#elif HELIX_ROWS == 5
|
||||
#define RGBLED_NUM 32
|
||||
#endif
|
||||
#else
|
||||
#define RGBLED_NUM 6
|
||||
#endif
|
||||
|
||||
#if RGBLED_NUM <= 6
|
||||
#define RGBLIGHT_LIMIT_VAL 255
|
||||
#else
|
||||
#if HELIX_ROWS == 5
|
||||
#define RGBLIGHT_LIMIT_VAL 120
|
||||
#else
|
||||
#define RGBLIGHT_LIMIT_VAL 130
|
||||
#endif
|
||||
#endif
|
||||
#define RGBLIGHT_HUE_STEP 10
|
||||
#define RGBLIGHT_SAT_STEP 17
|
||||
#define RGBLIGHT_VAL_STEP 17
|
||||
#endif
|
||||
|
||||
#ifdef RGBLIGHT_ENABLE
|
||||
// USB_MAX_POWER_CONSUMPTION value for Helix keyboard
|
||||
// 120 RGBoff, OLEDoff
|
||||
// 120 OLED
|
||||
// 330 RGB 6
|
||||
// 300 RGB 32
|
||||
// 310 OLED & RGB 32
|
||||
#define USB_MAX_POWER_CONSUMPTION 330
|
||||
#else
|
||||
// fix iPhone and iPad power adapter issue
|
||||
// iOS device need lessthan 100
|
||||
#define USB_MAX_POWER_CONSUMPTION 100
|
||||
#endif
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,75 @@
|
||||
|
||||
# Build Options
|
||||
# change to "no" to disable the options, or define them in the Makefile in
|
||||
# the appropriate keymap folder that will get included automatically
|
||||
#
|
||||
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
|
||||
MOUSEKEY_ENABLE = no # Mouse keys(+4700)
|
||||
EXTRAKEY_ENABLE = no # Audio control and System control(+450)
|
||||
CONSOLE_ENABLE = no # Console for debug(+400)
|
||||
COMMAND_ENABLE = no # Commands for debug and configuration
|
||||
NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
|
||||
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
|
||||
MIDI_ENABLE = no # MIDI controls
|
||||
AUDIO_ENABLE = no # Audio output on port C6
|
||||
UNICODE_ENABLE = no # Unicode
|
||||
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
|
||||
RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. Do not enable this with audio at the same time.
|
||||
SWAP_HANDS_ENABLE = no # Enable one-hand typing
|
||||
|
||||
define HELIX_CUSTOMISE_MSG
|
||||
$(info Helix customize)
|
||||
$(info - OLED_ENABLE=$(OLED_ENABLE))
|
||||
$(info - LED_BACK_ENABLE=$(LED_BACK_ENABLE))
|
||||
$(info - LED_UNDERGLOW_ENABLE=$(LED_UNDERGLOW_ENABLE))
|
||||
$(info - LED_ANIMATION=$(LED_ANIMATIONS))
|
||||
endef
|
||||
|
||||
# Helix keyboard customize
|
||||
# you can edit follows 4 Variables
|
||||
# jp: 以下の4つの変数を必要に応じて編集します。
|
||||
OLED_ENABLE = no # OLED_ENABLE
|
||||
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
|
||||
|
||||
#### LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE.
|
||||
#### Do not enable these with audio at the same time.
|
||||
|
||||
# Uncomment these for checking
|
||||
# jp: コンパイル時にカスタマイズの状態を表示したい時はコメントをはずします。
|
||||
# $(eval $(call HELIX_CUSTOMISE_MSG))
|
||||
# $(info )
|
||||
|
||||
ifeq ($(strip $(LED_BACK_ENABLE)), yes)
|
||||
RGBLIGHT_ENABLE = yes
|
||||
OPT_DEFS += -DRGBLED_BACK
|
||||
ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
|
||||
$(eval $(call HELIX_CUSTOMISE_MSG))
|
||||
$(error LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE both 'yes')
|
||||
endif
|
||||
else ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
|
||||
RGBLIGHT_ENABLE = yes
|
||||
else
|
||||
RGBLIGHT_ENABLE = no
|
||||
endif
|
||||
|
||||
ifeq ($(strip $(LED_ANIMATIONS)), yes)
|
||||
OPT_DEFS += -DRGBLIGHT_ANIMATIONS
|
||||
endif
|
||||
|
||||
ifeq ($(strip $(OLED_ENABLE)), yes)
|
||||
OPT_DEFS += -DOLED_ENABLE
|
||||
endif
|
||||
|
||||
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
|
||||
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
|
||||
|
||||
ifndef QUANTUM_DIR
|
||||
include ../../../../Makefile
|
||||
endif
|
||||
|
||||
# Uncomment these for debugging
|
||||
# $(info -- RGBLIGHT_ENABLE=$(RGBLIGHT_ENABLE))
|
||||
# $(info -- OPT_DEFS=$(OPT_DEFS))
|
||||
# $(info )
|
||||
Reference in New Issue
Block a user