2 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
4 #include "action_layer.h"
10 extern keymap_config_t keymap_config;
12 // Each layer gets a name for readability, which is then used in the keymap matrix below.
13 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
14 // Layer names don't all need to be of the same length, obviously, and you can also skip them
15 // entirely and just use numbers.
22 #define _TOUCHCURSOR 6
23 #define _MOUSECURSOR 7
27 enum planck_keycodes {
56 // Fillers to make layering more clear
57 #define _______ KC_TRNS
61 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
62 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
63 #define HPR_TAB ALL_T(KC_TAB) // Tap for Tab, hold for Hyper
64 #define GUI_SEM GUI_T(KC_SCLN) // Tap for Semicolon, hold for GUI
65 #define ALT_QUO ALT_T(KC_QUOT) // Tap for Quote, hold for Alt
66 // Requires KC_TRNS/_______ for the trigger key in the destination layer
67 #define LT_TC LT(_TOUCHCURSOR, KC_SPC) // L-ayer T-ap T-ouch C-ursor
68 #define LT_MC(kc) LT(_MOUSECURSOR, kc) // L-ayer T-ap M-ouse C-ursor
69 #define ALT_TAB M(KC_ALT_TAB) // Macro for Alt-Tab
70 #define CMD_TAB M(KC_CMD_TAB) // Macro for Cmd-Tab
71 #define CTL_TAB M(KC_CTL_TAB) // Macro for Ctl-Tab
72 #define CMD_SLSH M(KC_CMD_SLSH) // Macro for Cmd-Slash (personal shortcut to toggle iTerm2 visibility)
73 #define AG_FIND M(KC_AG_FIND) // Macros for Cmd-[x] vs Ctrl-[x] based on current AG_NORM or AG_SWAP settings
74 #define AG_AGAIN M(KC_AG_AGAIN)
75 #define AG_UNDO M(KC_AG_UNDO)
76 #define AG_CUT M(KC_AG_CUT)
77 #define AG_COPY M(KC_AG_COPY)
78 #define AG_PASTE M(KC_AG_PASTE)
79 #define AG_D_L M(KC_AG_DESK_L) // For Virtual Desktop Switching: Left, and
80 #define AG_D_R M(KC_AG_DESK_R) // Right
81 #define AG_T_C M(KC_AG_TAB_C) // For Chrome, etc. Tab Close,
82 #define AG_T_N M(KC_AG_TAB_N) // Tab New, and
83 #define AG_T_R M(KC_AG_TAB_R) // Tab Reopen Closed
85 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
88 * ,-----------------------------------------------------------------------------------------.
89 * | Hyper/Tab| Q | W | E | R | T | Y | U | I | O | P | Bksp |
90 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
91 * | Ctrl/Esc | A | S | MC/D | F | G | H | J | K | L |GUI/; | Alt/" |
92 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
93 * | Shift | Z | X | C | V | B | N | M | , | . | / |Sft/Ent |
94 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
95 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
96 * `-----------------------------------------------------------------------------------------'
99 {HPR_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
100 {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},
101 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
102 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
106 * ,-----------------------------------------------------------------------------------------.
107 * | Hyper/Tab| Q | W | F | P | G | J | L | U | Y | ; | Bksp |
108 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
109 * | Ctrl/Esc | A | R | MC/S | T | D | H | N | E | I | O | " |
110 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
111 * | Shift | Z | X | C | V | B | K | M | , | . | / |Sft/Ent |
112 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
113 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
114 * `-----------------------------------------------------------------------------------------'
117 {HPR_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
118 {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},
119 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
120 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
124 * ,-----------------------------------------------------------------------------------------.
125 * | Hyper/Tab| " | , | . | P | Y | F | G | C | R | L | Bksp |
126 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
127 * | Ctrl/Esc | A | O | MC/E | U | I | D | H | T | N | S | / |
128 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
129 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Sft/Ent |
130 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
131 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
132 * `-----------------------------------------------------------------------------------------'
135 {HPR_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
136 {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},
137 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, SFT_ENT},
138 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
142 * ,-----------------------------------------------------------------------------------.
143 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
144 * |------+------+------+------+------+-------------+------+------+------+------+------|
145 * | [ | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
146 * |------+------+------+------+------+------|------+------+------+------+------+------|
147 * | ] | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | \ |
148 * |------+------+------+------+------+------+------+------+------+------+------+------|
149 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
150 * `-----------------------------------------------------------------------------------'
153 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
154 {KC_LBRC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
155 {KC_RBRC, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
156 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
160 * ,-----------------------------------------------------------------------------------.
161 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
162 * |------+------+------+------+------+-------------+------+------+------+------+------|
163 * | $ | 4 | 5 | 6 | . | + | . | 4 | 5 | 6 | * | | |
164 * |------+------+------+------+------+------|------+------+------+------+------+------|
165 * | = | 7 | 8 | 9 | 0 | - | . | 1 | 2 | 3 | / | \ |
166 * |------+------+------+------+------+------+------+------+------+------+------+------|
167 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
168 * `-----------------------------------------------------------------------------------'
171 {KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
172 {KC_DLR, KC_4, KC_5, KC_6, KC_DOT, KC_PLUS, KC_DOT, KC_4, KC_5, KC_6, KC_ASTR, KC_PIPE},
173 {KC_EQL, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_DOT, KC_1, KC_2, KC_3, KC_SLSH, KC_BSLS},
174 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
177 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
178 * ,-----------------------------------------------------------------------------------.
179 * |AltTab|CmdTab|CtlTab| GUI |Shift | ~ |Insert| Home | Up | End | Bksp | |
180 * |------+------+------+------+------+-------------+------+------+------+------+------|
181 * | | Alt |Space |Tab_C | Find |Again | PgUp | Left | Down |Right |Desk_L|Desk_R|
182 * |------+------+------+------+------+------|------+------+------+------+------+------|
183 * | | Undo | Cut | Copy |Paste | ` | PgDn | Del |Tab_N |Tab_R |iTerm2| |
184 * |------+------+------+------+------+------+------+------+------+------+------+------|
185 * | | | | | | | | | | | |
186 * `-----------------------------------------------------------------------------------'
188 * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
189 * seem to work on Mac. Presumably they'll work under Windows.
193 {ALT_TAB, CMD_TAB, CTL_TAB, KC_LGUI, KC_LSFT, KC_TILD, KC_INS, KC_HOME, KC_UP, KC_END, KC_BSPC, _______},
194 {_______, 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 },
195 {_______, AG_UNDO, AG_CUT, AG_COPY, AG_PASTE,KC_GRV, KC_PGDN, KC_DEL, AG_T_N, AG_T_R, CMD_SLSH,_______},
196 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
200 * ,-----------------------------------------------------------------------------------.
201 * | | |ACCL0 | | | | |WHL_L | Up |WHL_R | BTN2 | |
202 * |------+------+------+------+------+-------------+------+------+------+------+------|
203 * | |ACCL2 | BTN2 | | BTN1 |ACCL1 |WHL_Up| Left | Down |Right | BTN4 | BTN5 |
204 * |------+------+------+------+------+------|------+------+------+------+------+------|
205 * | | | | | BTN3 | |WHL_Dn| BTN1 | | | BTN3 | |
206 * |------+------+------+------+------+------+------+------+------+------+------+------|
207 * | | | | | | | | | | | |
208 * `-----------------------------------------------------------------------------------'
212 {_______, _______, KC_ACL0, _______, _______, _______, _______, KC_WH_L, KC_MS_U, KC_WH_R, KC_BTN2, _______},
213 {_______, KC_ACL2, KC_BTN2, _______, KC_BTN1, KC_ACL1, KC_WH_U, KC_MS_L, KC_MS_D, KC_MS_R, KC_BTN4, KC_BTN5},
214 {_______, _______, _______, _______, KC_BTN3, _______, KC_WH_D, KC_BTN1, _______, _______, KC_BTN3, _______},
215 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
218 /* Plover layer (http://opensteno.org)
219 * ,-----------------------------------------------------------------------------------.
220 * | # | # | # | # | # | # | # | # | # | # | # | # |
221 * |------+------+------+------+------+-------------+------+------+------+------+------|
222 * | | S | T | P | H | * | * | F | P | L | T | D |
223 * |------+------+------+------+------+------|------+------+------+------+------+------|
224 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
225 * |------+------+------+------+------+------+------+------+------+------+------+------|
226 * | Exit | | | A | O | | E | U | | | |
227 * `-----------------------------------------------------------------------------------'
231 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
232 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
233 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
234 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
237 /* Adjust (Lower + Raise)
238 * ,-----------------------------------------------------------------------------------.
239 * | | | | | | | | | | | | Del |
240 * |------+------+------+------+------+-------------+------+------+------+------+------|
241 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
242 * |------+------+------+------+------+------|------+------+------+------+------+------|
243 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
244 * |------+------+------+------+------+------+------+------+------+------+------+------|
245 * | | | | | | | | | | |Reset |
246 * `-----------------------------------------------------------------------------------'
249 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
250 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
251 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
252 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET}
260 float tone_startup[][2] = SONG(STARTUP_SOUND);
261 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
262 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
263 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
264 float tone_plover[][2] = SONG(PLOVER_SOUND);
265 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
266 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
268 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
272 void persistent_default_layer_set(uint16_t default_layer) {
273 eeconfig_update_default_layer(default_layer);
274 default_layer_set(default_layer);
277 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
280 if (record->event.pressed) {
282 PLAY_SONG(tone_qwerty);
284 default_layer_set(1UL<<_QWERTY);
289 if (record->event.pressed) {
291 PLAY_SONG(tone_colemak);
293 default_layer_set(1UL<<_COLEMAK);
298 if (record->event.pressed) {
300 PLAY_SONG(tone_dvorak);
302 default_layer_set(1UL<<_DVORAK);
307 if (record->event.pressed) {
309 update_tri_layer(_LOWER, _RAISE, _ADJUST);
312 update_tri_layer(_LOWER, _RAISE, _ADJUST);
317 if (record->event.pressed) {
319 update_tri_layer(_LOWER, _RAISE, _ADJUST);
322 update_tri_layer(_LOWER, _RAISE, _ADJUST);
327 if (record->event.pressed) {
328 register_code(KC_RSFT);
329 #ifdef BACKLIGHT_ENABLE
333 unregister_code(KC_RSFT);
338 if (record->event.pressed) {
341 PLAY_SONG(tone_plover);
347 if (!eeconfig_is_enabled()) {
350 keymap_config.raw = eeconfig_read_keymap();
351 keymap_config.nkro = 1;
352 eeconfig_update_keymap(keymap_config.raw);
357 if (record->event.pressed) {
359 PLAY_SONG(tone_plover_gb);
372 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
374 if (!eeconfig_is_enabled()) {
378 bool use_cmd = true; // Use, for example, Cmd-Tab, Cmd-C, Cmd-V, etc.
379 // Compare to MAGIC_SWAP_ALT_GUI and MAGIC_UNSWAP_ALT_GUI configs, set in:
381 if(keymap_config.swap_lalt_lgui == 1 && keymap_config.swap_ralt_rgui == 1) {
382 use_cmd = false; // ... or, Alt-Tab, Ctrl-C, Ctrl-V, etc.
387 if(use_cmd) { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
388 else { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
390 if(use_cmd) { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
391 else { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
394 return (record->event.pressed ? MACRO( D(LCTRL), D(TAB), END ) : MACRO( U(TAB), END ));
396 return (record->event.pressed ? MACRO( D(LGUI), D(SLSH),END ) : MACRO( U(SLSH),END ));
399 return use_cmd ? MACRODOWN( D(LGUI), T(F), END ) : MACRODOWN( D(LCTRL), T(F), END );
401 return use_cmd ? MACRODOWN( D(LGUI), T(G), END ) : MACRODOWN( D(LCTRL), T(G), END );
403 return use_cmd ? MACRODOWN( D(LGUI), T(Z), END ) : MACRODOWN( D(LCTRL), T(Z), END );
405 return use_cmd ? MACRODOWN( D(LGUI), T(X), END ) : MACRODOWN( D(LCTRL), T(X), END );
407 return use_cmd ? MACRODOWN( D(LGUI), T(C), END ) : MACRODOWN( D(LCTRL), T(C), END );
409 return use_cmd ? MACRODOWN( D(LGUI), T(V), END ) : MACRODOWN( D(LCTRL), T(V), END );
412 return use_cmd ? MACRODOWN( D(LGUI), D(LCTRL), T(SCLN), END ) : MACRODOWN( D(LALT), D(LCTRL), T(SCLN), END );
414 return use_cmd ? MACRODOWN( D(LGUI), D(LCTRL), T(QUOT), END ) : MACRODOWN( D(LALT), D(LCTRL), T(QUOT), END );
417 return use_cmd ? MACRODOWN( D(LGUI), T(W), END ) : MACRODOWN( D(LCTRL), T(W), END );
419 return use_cmd ? MACRODOWN( D(LGUI), T(T), END ) : MACRODOWN( D(LCTRL), T(T), END );
421 return use_cmd ? MACRODOWN( D(LGUI), D(LSHIFT), T(T), END ) : MACRODOWN( D(LCTRL), D(LSHIFT), T(T), END );
427 void matrix_init_user(void) {
437 _delay_ms(20); // gets rid of tick
438 PLAY_SONG(tone_startup);
443 PLAY_SONG(tone_goodbye);
448 void music_on_user(void)
453 void music_scale_user(void)
455 PLAY_SONG(music_scale);