2 #include QMK_KEYBOARD_H
4 extern keymap_config_t keymap_config
;
6 // Each layer gets a name for readability, which is then used in the keymap matrix below.
7 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
8 // Layer names don't all need to be of the same length, obviously, and you can also skip them
9 // entirely and just use numbers.
16 #define _TOUCHCURSOR 6
17 #define _MOUSECURSOR 7
21 enum planck_keycodes
{
51 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
52 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
53 #define HPR_TAB ALL_T(KC_TAB) // Tap for Tab, hold for Hyper
54 #define GUI_SEM GUI_T(KC_SCLN) // Tap for Semicolon, hold for GUI
55 #define ALT_QUO ALT_T(KC_QUOT) // Tap for Quote, hold for Alt
56 // Requires KC_TRNS/_______ for the trigger key in the destination layer
57 #define LT_TC LT(_TOUCHCURSOR, KC_SPC) // L-ayer T-ap T-ouch C-ursor
58 #define LT_MC(kc) LT(_MOUSECURSOR, kc) // L-ayer T-ap M-ouse C-ursor
59 #define ALT_TAB M(KC_ALT_TAB) // Macro for Alt-Tab
60 #define CMD_TAB M(KC_CMD_TAB) // Macro for Cmd-Tab
61 #define CTL_TAB M(KC_CTL_TAB) // Macro for Ctl-Tab
62 #define CMD_SLSH M(KC_CMD_SLSH) // Macro for Cmd-Slash (personal shortcut to toggle iTerm2 visibility)
63 #define AG_FIND M(KC_AG_FIND) // Macros for Cmd-[x] vs Ctrl-[x] based on current AG_NORM or AG_SWAP settings
64 #define AG_AGAIN M(KC_AG_AGAIN)
65 #define AG_UNDO M(KC_AG_UNDO)
66 #define AG_CUT M(KC_AG_CUT)
67 #define AG_COPY M(KC_AG_COPY)
68 #define AG_PASTE M(KC_AG_PASTE)
69 #define AG_D_L M(KC_AG_DESK_L) // For Virtual Desktop Switching: Left, and
70 #define AG_D_R M(KC_AG_DESK_R) // Right
71 #define AG_T_C M(KC_AG_TAB_C) // For Chrome, etc. Tab Close,
72 #define AG_T_N M(KC_AG_TAB_N) // Tab New, and
73 #define AG_T_R M(KC_AG_TAB_R) // Tab Reopen Closed
75 const uint16_t PROGMEM keymaps
[][MATRIX_ROWS
][MATRIX_COLS
] = {
78 * ,-----------------------------------------------------------------------------------------.
79 * | Hyper/Tab| Q | W | E | R | T | Y | U | I | O | P | Bksp |
80 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
81 * | Ctrl/Esc | A | S | MC/D | F | G | H | J | K | L |GUI/; | Alt/" |
82 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
83 * | Shift | Z | X | C | V | B | N | M | , | . | / |Sft/Ent |
84 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
85 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
86 * `-----------------------------------------------------------------------------------------'
88 [_QWERTY
] = LAYOUT_planck_grid(
89 HPR_TAB
, KC_Q
, KC_W
, KC_E
, KC_R
, KC_T
, KC_Y
, KC_U
, KC_I
, KC_O
, KC_P
, KC_BSPC
,
90 CTL_ESC
, KC_A
, KC_S
, LT_MC(KC_D
),KC_F
, KC_G
, KC_H
, KC_J
, KC_K
, KC_L
, GUI_SEM
, ALT_QUO
,
91 KC_LSFT
, KC_Z
, KC_X
, KC_C
, KC_V
, KC_B
, KC_N
, KC_M
, KC_COMM
, KC_DOT
, KC_SLSH
, SFT_ENT
,
92 KC_PSCR
, KC_RGUI
, KC_LALT
, KC_LGUI
, LOWER
, LT_TC
, LT_TC
, RAISE
, KC_MNXT
, KC_VOLD
, KC_VOLU
, KC_MPLY
96 * ,-----------------------------------------------------------------------------------------.
97 * | Hyper/Tab| Q | W | F | P | G | J | L | U | Y | ; | Bksp |
98 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
99 * | Ctrl/Esc | A | R | MC/S | T | D | H | N | E | I | O | " |
100 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
101 * | Shift | Z | X | C | V | B | K | M | , | . | / |Sft/Ent |
102 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
103 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
104 * `-----------------------------------------------------------------------------------------'
106 [_COLEMAK
] = LAYOUT_planck_grid(
107 HPR_TAB
, KC_Q
, KC_W
, KC_F
, KC_P
, KC_G
, KC_J
, KC_L
, KC_U
, KC_Y
, KC_SCLN
, KC_BSPC
,
108 CTL_ESC
, KC_A
, KC_R
, LT_MC(KC_S
),KC_T
, KC_D
, KC_H
, KC_N
, KC_E
, KC_I
, KC_O
, KC_QUOT
,
109 KC_LSFT
, KC_Z
, KC_X
, KC_C
, KC_V
, KC_B
, KC_K
, KC_M
, KC_COMM
, KC_DOT
, KC_SLSH
, SFT_ENT
,
110 KC_PSCR
, KC_RGUI
, KC_LALT
, KC_LGUI
, LOWER
, LT_TC
, LT_TC
, RAISE
, KC_MNXT
, KC_VOLD
, KC_VOLU
, KC_MPLY
114 * ,-----------------------------------------------------------------------------------------.
115 * | Hyper/Tab| " | , | . | P | Y | F | G | C | R | L | Bksp |
116 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
117 * | Ctrl/Esc | A | O | MC/E | U | I | D | H | T | N | S | / |
118 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
119 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Sft/Ent |
120 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
121 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
122 * `-----------------------------------------------------------------------------------------'
124 [_DVORAK
] = LAYOUT_planck_grid(
125 HPR_TAB
, KC_QUOT
, KC_COMM
, KC_DOT
, KC_P
, KC_Y
, KC_F
, KC_G
, KC_C
, KC_R
, KC_L
, KC_BSPC
,
126 CTL_ESC
, KC_A
, KC_O
, LT_MC(KC_E
),KC_U
, KC_I
, KC_D
, KC_H
, KC_T
, KC_N
, KC_S
, KC_SLSH
,
127 KC_LSFT
, KC_SCLN
, KC_Q
, KC_J
, KC_K
, KC_X
, KC_B
, KC_M
, KC_W
, KC_V
, KC_Z
, SFT_ENT
,
128 KC_PSCR
, KC_RGUI
, KC_LALT
, KC_LGUI
, LOWER
, LT_TC
, LT_TC
, RAISE
, KC_MNXT
, KC_VOLD
, KC_VOLU
, KC_MPLY
132 * ,-----------------------------------------------------------------------------------.
133 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
134 * |------+------+------+------+------+-------------+------+------+------+------+------|
135 * | [ | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
136 * |------+------+------+------+------+------|------+------+------+------+------+------|
137 * | ] | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | \ |
138 * |------+------+------+------+------+------+------+------+------+------+------+------|
139 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
140 * `-----------------------------------------------------------------------------------'
142 [_LOWER
] = LAYOUT_planck_grid(
143 KC_TILD
, KC_EXLM
, KC_AT
, KC_HASH
, KC_DLR
, KC_PERC
, KC_CIRC
, KC_AMPR
, KC_ASTR
, KC_LPRN
, KC_RPRN
, KC_BSPC
,
144 KC_LBRC
, KC_F1
, KC_F2
, KC_F3
, KC_F4
, KC_F5
, KC_F6
, KC_UNDS
, KC_PLUS
, KC_LCBR
, KC_RCBR
, KC_PIPE
,
145 KC_RBRC
, KC_F7
, KC_F8
, KC_F9
, KC_F10
, KC_F11
, KC_F12
, KC_MINS
, KC_EQL
, KC_LBRC
, KC_RBRC
, KC_BSLS
,
146 BACKLIT
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, KC_MPRV
, KC_MSTP
, KC_MSEL
, KC_MUTE
150 * ,-----------------------------------------------------------------------------------.
151 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
152 * |------+------+------+------+------+-------------+------+------+------+------+------|
153 * | $ | 4 | 5 | 6 | . | + | . | 4 | 5 | 6 | * | | |
154 * |------+------+------+------+------+------|------+------+------+------+------+------|
155 * | = | 7 | 8 | 9 | 0 | - | . | 1 | 2 | 3 | / | \ |
156 * |------+------+------+------+------+------+------+------+------+------+------+------|
157 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
158 * `-----------------------------------------------------------------------------------'
160 [_RAISE
] = LAYOUT_planck_grid(
161 KC_0
, KC_1
, KC_2
, KC_3
, KC_4
, KC_5
, KC_6
, KC_7
, KC_8
, KC_9
, KC_0
, KC_BSPC
,
162 KC_DLR
, KC_4
, KC_5
, KC_6
, KC_DOT
, KC_PLUS
, KC_DOT
, KC_4
, KC_5
, KC_6
, KC_ASTR
, KC_PIPE
,
163 KC_EQL
, KC_7
, KC_8
, KC_9
, KC_0
, KC_MINS
, KC_DOT
, KC_1
, KC_2
, KC_3
, KC_SLSH
, KC_BSLS
,
164 BACKLIT
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, KC_MPRV
, KC_MSTP
, KC_MSEL
, KC_MUTE
167 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
168 * ,-----------------------------------------------------------------------------------.
169 * |AltTab|CmdTab|CtlTab| GUI |Shift | ~ |Insert| Home | Up | End | Bksp | |
170 * |------+------+------+------+------+-------------+------+------+------+------+------|
171 * | | Alt |Space |Tab_C | Find |Again | PgUp | Left | Down |Right |Desk_L|Desk_R|
172 * |------+------+------+------+------+------|------+------+------+------+------+------|
173 * | | Undo | Cut | Copy |Paste | ` | PgDn | Del |Tab_N |Tab_R |iTerm2| |
174 * |------+------+------+------+------+------+------+------+------+------+------+------|
175 * | | | | | | | | | | | |
176 * `-----------------------------------------------------------------------------------'
178 * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
179 * seem to work on Mac. Presumably they'll work under Windows.
182 [_TOUCHCURSOR
] = LAYOUT_planck_grid(
183 ALT_TAB
, CMD_TAB
, CTL_TAB
, KC_LGUI
, KC_LSFT
, KC_TILD
, KC_INS
, KC_HOME
, KC_UP
, KC_END
, KC_BSPC
, _______
,
184 _______
, KC_LALT
, KC_SPC
, AG_T_C
, AG_FIND
,AG_AGAIN
, KC_PGUP
, KC_LEFT
, KC_DOWN
, KC_RGHT
, AG_D_L
, AG_D_R
,
185 _______
, AG_UNDO
, AG_CUT
, AG_COPY
, AG_PASTE
,KC_GRV
, KC_PGDN
, KC_DEL
, AG_T_N
, AG_T_R
, CMD_SLSH
,_______
,
186 _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
190 * ,-----------------------------------------------------------------------------------.
191 * | | |ACCL0 | | | | |WHL_L | Up |WHL_R | BTN2 | |
192 * |------+------+------+------+------+-------------+------+------+------+------+------|
193 * | |ACCL2 | BTN2 | | BTN1 |ACCL1 |WHL_Up| Left | Down |Right | BTN4 | BTN5 |
194 * |------+------+------+------+------+------|------+------+------+------+------+------|
195 * | | | | | BTN3 | |WHL_Dn| BTN1 | | | BTN3 | |
196 * |------+------+------+------+------+------+------+------+------+------+------+------|
197 * | | | | | | | | | | | |
198 * `-----------------------------------------------------------------------------------'
201 [_MOUSECURSOR
] = LAYOUT_planck_grid(
202 _______
, _______
, KC_ACL0
, _______
, _______
, _______
, _______
, KC_WH_L
, KC_MS_U
, KC_WH_R
, KC_BTN2
, _______
,
203 _______
, KC_ACL2
, KC_BTN2
, _______
, KC_BTN1
, KC_ACL1
, KC_WH_U
, KC_MS_L
, KC_MS_D
, KC_MS_R
, KC_BTN4
, KC_BTN5
,
204 _______
, _______
, _______
, _______
, KC_BTN3
, _______
, KC_WH_D
, KC_BTN1
, _______
, _______
, KC_BTN3
, _______
,
205 _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
208 /* Plover layer (http://opensteno.org)
209 * ,-----------------------------------------------------------------------------------.
210 * | # | # | # | # | # | # | # | # | # | # | # | # |
211 * |------+------+------+------+------+-------------+------+------+------+------+------|
212 * | | S | T | P | H | * | * | F | P | L | T | D |
213 * |------+------+------+------+------+------|------+------+------+------+------+------|
214 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
215 * |------+------+------+------+------+------+------+------+------+------+------+------|
216 * | Exit | | | A | O | | E | U | | | |
217 * `-----------------------------------------------------------------------------------'
220 [_PLOVER
] = LAYOUT_planck_grid(
221 KC_1
, KC_1
, KC_1
, KC_1
, KC_1
, KC_1
, KC_1
, KC_1
, KC_1
, KC_1
, KC_1
, KC_1
,
222 XXXXXXX
, KC_Q
, KC_W
, KC_E
, KC_R
, KC_T
, KC_Y
, KC_U
, KC_I
, KC_O
, KC_P
, KC_LBRC
,
223 XXXXXXX
, KC_A
, KC_S
, KC_D
, KC_F
, KC_G
, KC_H
, KC_J
, KC_K
, KC_L
, KC_SCLN
, KC_QUOT
,
224 EXT_PLV
, XXXXXXX
, XXXXXXX
, KC_C
, KC_V
, XXXXXXX
, XXXXXXX
, KC_N
, KC_M
, XXXXXXX
, XXXXXXX
, XXXXXXX
227 /* Adjust (Lower + Raise)
228 * ,-----------------------------------------------------------------------------------.
229 * | | | | | | | | | | | | Del |
230 * |------+------+------+------+------+-------------+------+------+------+------+------|
231 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
232 * |------+------+------+------+------+------|------+------+------+------+------+------|
233 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
234 * |------+------+------+------+------+------+------+------+------+------+------+------|
235 * | | | | | | | | | | |Reset |
236 * `-----------------------------------------------------------------------------------'
238 [_ADJUST
] = LAYOUT_planck_grid(
239 _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, KC_DEL
,
240 _______
, _______
, _______
, AU_ON
, AU_OFF
, AG_NORM
, AG_SWAP
, QWERTY
, COLEMAK
, DVORAK
, PLOVER
, _______
,
241 _______
, MUV_DE
, MUV_IN
, MU_ON
, MU_OFF
, MI_ON
, MI_OFF
, _______
, _______
, _______
, _______
, _______
,
242 _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, _______
, RESET
250 float tone_startup
[][2] = SONG(STARTUP_SOUND
);
251 float tone_qwerty
[][2] = SONG(QWERTY_SOUND
);
252 float tone_dvorak
[][2] = SONG(DVORAK_SOUND
);
253 float tone_colemak
[][2] = SONG(COLEMAK_SOUND
);
254 float tone_plover
[][2] = SONG(PLOVER_SOUND
);
255 float tone_plover_gb
[][2] = SONG(PLOVER_GOODBYE_SOUND
);
256 float music_scale
[][2] = SONG(MUSIC_SCALE_SOUND
);
258 float tone_goodbye
[][2] = SONG(GOODBYE_SOUND
);
262 void persistent_default_layer_set(uint16_t default_layer
) {
263 eeconfig_update_default_layer(default_layer
);
264 default_layer_set(default_layer
);
267 bool process_record_user(uint16_t keycode
, keyrecord_t
*record
) {
270 if (record
->event
.pressed
) {
272 PLAY_SONG(tone_qwerty
);
274 default_layer_set(1UL<<_QWERTY
);
279 if (record
->event
.pressed
) {
281 PLAY_SONG(tone_colemak
);
283 default_layer_set(1UL<<_COLEMAK
);
288 if (record
->event
.pressed
) {
290 PLAY_SONG(tone_dvorak
);
292 default_layer_set(1UL<<_DVORAK
);
297 if (record
->event
.pressed
) {
299 update_tri_layer(_LOWER
, _RAISE
, _ADJUST
);
302 update_tri_layer(_LOWER
, _RAISE
, _ADJUST
);
307 if (record
->event
.pressed
) {
309 update_tri_layer(_LOWER
, _RAISE
, _ADJUST
);
312 update_tri_layer(_LOWER
, _RAISE
, _ADJUST
);
317 if (record
->event
.pressed
) {
318 register_code(KC_RSFT
);
319 #ifdef BACKLIGHT_ENABLE
323 unregister_code(KC_RSFT
);
328 if (record
->event
.pressed
) {
331 PLAY_SONG(tone_plover
);
337 if (!eeconfig_is_enabled()) {
340 keymap_config
.raw
= eeconfig_read_keymap();
341 keymap_config
.nkro
= 1;
342 eeconfig_update_keymap(keymap_config
.raw
);
347 if (record
->event
.pressed
) {
349 PLAY_SONG(tone_plover_gb
);
362 const macro_t
*action_get_macro(keyrecord_t
*record
, uint8_t id
, uint8_t opt
)
364 if (!eeconfig_is_enabled()) {
368 bool use_cmd
= true; // Use, for example, Cmd-Tab, Cmd-C, Cmd-V, etc.
369 // Compare to MAGIC_SWAP_ALT_GUI and MAGIC_UNSWAP_ALT_GUI configs, set in:
371 if(keymap_config
.swap_lalt_lgui
== 1 && keymap_config
.swap_ralt_rgui
== 1) {
372 use_cmd
= false; // ... or, Alt-Tab, Ctrl-C, Ctrl-V, etc.
377 if(use_cmd
) { return (record
->event
.pressed
? MACRO( D(LALT
), D(TAB
), END
) : MACRO( U(TAB
), END
)); }
378 else { return (record
->event
.pressed
? MACRO( D(LGUI
), D(TAB
), END
) : MACRO( U(TAB
), END
)); }
380 if(use_cmd
) { return (record
->event
.pressed
? MACRO( D(LGUI
), D(TAB
), END
) : MACRO( U(TAB
), END
)); }
381 else { return (record
->event
.pressed
? MACRO( D(LALT
), D(TAB
), END
) : MACRO( U(TAB
), END
)); }
384 return (record
->event
.pressed
? MACRO( D(LCTRL
), D(TAB
), END
) : MACRO( U(TAB
), END
));
386 return (record
->event
.pressed
? MACRO( D(LGUI
), D(SLSH
),END
) : MACRO( U(SLSH
),END
));
389 return use_cmd
? MACRODOWN( D(LGUI
), T(F
), END
) : MACRODOWN( D(LCTRL
), T(F
), END
);
391 return use_cmd
? MACRODOWN( D(LGUI
), T(G
), END
) : MACRODOWN( D(LCTRL
), T(G
), END
);
393 return use_cmd
? MACRODOWN( D(LGUI
), T(Z
), END
) : MACRODOWN( D(LCTRL
), T(Z
), END
);
395 return use_cmd
? MACRODOWN( D(LGUI
), T(X
), END
) : MACRODOWN( D(LCTRL
), T(X
), END
);
397 return use_cmd
? MACRODOWN( D(LGUI
), T(C
), END
) : MACRODOWN( D(LCTRL
), T(C
), END
);
399 return use_cmd
? MACRODOWN( D(LGUI
), T(V
), END
) : MACRODOWN( D(LCTRL
), T(V
), END
);
402 return use_cmd
? MACRODOWN( D(LGUI
), D(LCTRL
), T(SCLN
), END
) : MACRODOWN( D(LALT
), D(LCTRL
), T(SCLN
), END
);
404 return use_cmd
? MACRODOWN( D(LGUI
), D(LCTRL
), T(QUOT
), END
) : MACRODOWN( D(LALT
), D(LCTRL
), T(QUOT
), END
);
407 return use_cmd
? MACRODOWN( D(LGUI
), T(W
), END
) : MACRODOWN( D(LCTRL
), T(W
), END
);
409 return use_cmd
? MACRODOWN( D(LGUI
), T(T
), END
) : MACRODOWN( D(LCTRL
), T(T
), END
);
411 return use_cmd
? MACRODOWN( D(LGUI
), D(LSHIFT
), T(T
), END
) : MACRODOWN( D(LCTRL
), D(LSHIFT
), T(T
), END
);
417 void matrix_init_user(void) {
427 _delay_ms(20); // gets rid of tick
428 PLAY_SONG(tone_startup
);
433 PLAY_SONG(tone_goodbye
);
438 void music_on_user(void)
443 void music_scale_user(void)
445 PLAY_SONG(music_scale
);