1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
2 // this is the style you want to emulate.
5 #include "action_layer.h"
11 extern keymap_config_t keymap_config;
13 // Each layer gets a name for readability, which is then used in the keymap matrix below.
14 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
15 // Layer names don't all need to be of the same length, obviously, and you can also skip them
16 // entirely and just use numbers.
23 #define _TOUCHCURSOR 6
24 #define _MOUSECURSOR 7
28 enum planck_keycodes {
54 // Fillers to make layering more clear
55 #define _______ KC_TRNS
59 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
60 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
61 // Requires KC_TRNS/_______ for the trigger key in the destination layer
62 #define LT_TC LT(_TOUCHCURSOR, KC_SPC) // L-ayer T-ap T-ouch C-ursor
63 #define LT_MC(kc) LT(_MOUSECURSOR, kc) // L-ayer T-ap M-ouse C-ursor
64 #define ALT_TAB M(KC_ALT_TAB) // Macro for Alt-Tab
65 #define CMD_TAB M(KC_CMD_TAB) // Macro for Cmd-Tab
66 #define CTL_TAB M(KC_CTL_TAB) // Macro for Ctl-Tab
67 #define CMD_SLSH M(KC_CMD_SLSH) // Macro for Cmd-Slash (personal shortcut to toggle iTerm2 visibility)
68 #define AG_FIND M(KC_AG_FIND) // Macros for Cmd-[x] vs Ctrl-[x] based on current AG_NORM or AG_SWAP settings
69 #define AG_AGAIN M(KC_AG_AGAIN)
70 #define AG_UNDO M(KC_AG_UNDO)
71 #define AG_CUT M(KC_AG_CUT)
72 #define AG_COPY M(KC_AG_COPY)
73 #define AG_PASTE M(KC_AG_PASTE)
74 #define AG_D_L M(KC_AG_DESK_L) // For Virtual Desktop Switching: Left, and
75 #define AG_D_R M(KC_AG_DESK_R) // Right
77 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
80 * ,-----------------------------------------------------------------------------------------.
81 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
82 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
83 * | Ctrl/Esc | A | S | MC/D | F | G | H | J | K | L | ; | " |
84 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
85 * | Shift | Z | X | C | V | B | N | M | , | . | / |Sft/Ent |
86 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
87 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
88 * `-----------------------------------------------------------------------------------------'
91 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
92 {CTL_ESC, KC_A, KC_S, LT_MC(KC_D),KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
93 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
94 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
98 * ,-----------------------------------------------------------------------------------------.
99 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
100 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
101 * | Ctrl/Esc | A | R | MC/S | T | D | H | N | E | I | O | " |
102 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
103 * | Shift | Z | X | C | V | B | K | M | , | . | / |Sft/Ent |
104 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
105 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
106 * `-----------------------------------------------------------------------------------------'
109 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
110 {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},
111 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
112 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
116 * ,-----------------------------------------------------------------------------------------.
117 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
118 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
119 * | Ctrl/Esc | A | O | MC/E | U | I | D | H | T | N | S | / |
120 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
121 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Sft/Ent |
122 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
123 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
124 * `-----------------------------------------------------------------------------------------'
127 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
128 {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},
129 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, SFT_ENT},
130 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
134 * ,-----------------------------------------------------------------------------------.
135 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
136 * |------+------+------+------+------+-------------+------+------+------+------+------|
137 * | [ | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
138 * |------+------+------+------+------+------|------+------+------+------+------+------|
139 * | ] | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | \ |
140 * |------+------+------+------+------+------+------+------+------+------+------+------|
141 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
142 * `-----------------------------------------------------------------------------------'
145 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
146 {KC_LBRC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
147 {KC_RBRC, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
148 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
152 * ,-----------------------------------------------------------------------------------.
153 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
154 * |------+------+------+------+------+-------------+------+------+------+------+------|
155 * | $ | 4 | 5 | 6 | . | + | . | 4 | 5 | 6 | * | | |
156 * |------+------+------+------+------+------|------+------+------+------+------+------|
157 * | = | 7 | 8 | 9 | 0 | - | . | 1 | 2 | 3 | / | \ |
158 * |------+------+------+------+------+------+------+------+------+------+------+------|
159 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
160 * `-----------------------------------------------------------------------------------'
163 {KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
164 {KC_DLR, KC_4, KC_5, KC_6, KC_DOT, KC_PLUS, KC_DOT, KC_4, KC_5, KC_6, KC_ASTR, KC_PIPE},
165 {KC_EQL, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_DOT, KC_1, KC_2, KC_3, KC_SLSH, KC_BSLS},
166 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
169 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
170 * ,-----------------------------------------------------------------------------------.
171 * |AltTab|CmdTab|CtlTab| GUI |Shift | ~ |Insert| Home | Up | End | Bksp | |
172 * |------+------+------+------+------+-------------+------+------+------+------+------|
173 * | | Alt |Space | | Find |Again | PgUp | Left | Down |Right |Desk_L|Desk_R|
174 * |------+------+------+------+------+------|------+------+------+------+------+------|
175 * | | Undo | Cut | Copy |Paste | ` | PgDn | Del | | | | |
176 * |------+------+------+------+------+------+------+------+------+------+------+------|
177 * | | | | | | | | | | | |
178 * `-----------------------------------------------------------------------------------'
180 * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
181 * seem to work on Mac. Presumably they'll work under Windows.
185 {ALT_TAB, CMD_TAB, CTL_TAB, KC_LGUI, KC_LSFT, KC_TILD, KC_INS, KC_HOME, KC_UP, KC_END, KC_BSPC, _______},
186 {_______, KC_LALT, KC_SPC, _______, AG_FIND,AG_AGAIN, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, AG_D_L, AG_D_R },
187 {_______, AG_UNDO, AG_CUT, AG_COPY, AG_PASTE,KC_GRV, KC_PGDN, KC_DEL, _______, _______, CMD_SLSH,_______},
188 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
192 * ,-----------------------------------------------------------------------------------.
193 * | | |ACCL0 | | | | |WHL_L | Up |WHL_R | BTN2 | |
194 * |------+------+------+------+------+-------------+------+------+------+------+------|
195 * | |ACCL2 | BTN2 | | BTN1 |ACCL1 |WHL_Up| Left | Down |Right | BTN4 | BTN5 |
196 * |------+------+------+------+------+------|------+------+------+------+------+------|
197 * | | | | | BTN3 | |WHL_Dn| BTN1 | | | BTN3 | |
198 * |------+------+------+------+------+------+------+------+------+------+------+------|
199 * | | | | | | | | | | | |
200 * `-----------------------------------------------------------------------------------'
204 {_______, _______, KC_ACL0, _______, _______, _______, _______, KC_WH_L, KC_MS_U, KC_WH_R, KC_BTN2, _______},
205 {_______, KC_ACL2, KC_BTN2, _______, KC_BTN1, KC_ACL1, KC_WH_U, KC_MS_L, KC_MS_D, KC_MS_R, KC_BTN4, KC_BTN5},
206 {_______, _______, _______, _______, KC_BTN3, _______, KC_WH_D, KC_BTN1, _______, _______, KC_BTN3, _______},
207 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
210 /* Plover layer (http://opensteno.org)
211 * ,-----------------------------------------------------------------------------------.
212 * | # | # | # | # | # | # | # | # | # | # | # | # |
213 * |------+------+------+------+------+-------------+------+------+------+------+------|
214 * | | S | T | P | H | * | * | F | P | L | T | D |
215 * |------+------+------+------+------+------|------+------+------+------+------+------|
216 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
217 * |------+------+------+------+------+------+------+------+------+------+------+------|
218 * | Exit | | | A | O | | E | U | | | |
219 * `-----------------------------------------------------------------------------------'
223 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
224 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
225 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
226 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
229 /* Adjust (Lower + Raise)
230 * ,-----------------------------------------------------------------------------------.
231 * | | | | | | | | | | | | Del |
232 * |------+------+------+------+------+-------------+------+------+------+------+------|
233 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
234 * |------+------+------+------+------+------|------+------+------+------+------+------|
235 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
236 * |------+------+------+------+------+------+------+------+------+------+------+------|
237 * | | | | | | | | | | |Reset |
238 * `-----------------------------------------------------------------------------------'
241 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
242 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
243 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
244 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET}
252 float tone_startup[][2] = SONG(STARTUP_SOUND);
253 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
254 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
255 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
256 float tone_plover[][2] = SONG(PLOVER_SOUND);
257 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
258 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
260 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
264 void persistant_default_layer_set(uint16_t default_layer) {
265 eeconfig_update_default_layer(default_layer);
266 default_layer_set(default_layer);
269 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
272 if (record->event.pressed) {
274 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
276 default_layer_set(1UL<<_QWERTY);
281 if (record->event.pressed) {
283 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
285 default_layer_set(1UL<<_COLEMAK);
290 if (record->event.pressed) {
292 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
294 default_layer_set(1UL<<_DVORAK);
299 if (record->event.pressed) {
301 update_tri_layer(_LOWER, _RAISE, _ADJUST);
304 update_tri_layer(_LOWER, _RAISE, _ADJUST);
309 if (record->event.pressed) {
311 update_tri_layer(_LOWER, _RAISE, _ADJUST);
314 update_tri_layer(_LOWER, _RAISE, _ADJUST);
319 if (record->event.pressed) {
320 register_code(KC_RSFT);
321 #ifdef BACKLIGHT_ENABLE
325 unregister_code(KC_RSFT);
330 if (record->event.pressed) {
333 PLAY_NOTE_ARRAY(tone_plover, false, 0);
339 if (!eeconfig_is_enabled()) {
342 keymap_config.raw = eeconfig_read_keymap();
343 keymap_config.nkro = 1;
344 eeconfig_update_keymap(keymap_config.raw);
349 if (record->event.pressed) {
351 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
364 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
366 if (!eeconfig_is_enabled()) {
370 bool use_cmd = true; // Use, for example, Cmd-Tab, Cmd-C, Cmd-V, etc.
371 // Compare to MAGIC_SWAP_ALT_GUI and MAGIC_UNSWAP_ALT_GUI configs, set in:
373 if(keymap_config.swap_lalt_lgui == 1 && keymap_config.swap_ralt_rgui == 1) {
374 use_cmd = false; // ... or, Alt-Tab, Ctrl-C, Ctrl-V, etc.
379 if(use_cmd) { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
380 else { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
382 if(use_cmd) { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
383 else { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
386 return (record->event.pressed ? MACRO( D(LCTRL), D(TAB), END ) : MACRO( U(TAB), END ));
388 return (record->event.pressed ? MACRO( D(LGUI), D(SLSH),END ) : MACRO( U(SLSH),END ));
391 return use_cmd ? MACRODOWN( D(LGUI), T(F), END ) : MACRODOWN( D(LCTRL), T(F), END );
393 return use_cmd ? MACRODOWN( D(LGUI), T(G), END ) : MACRODOWN( D(LCTRL), T(G), END );
395 return use_cmd ? MACRODOWN( D(LGUI), T(Z), END ) : MACRODOWN( D(LCTRL), T(Z), END );
397 return use_cmd ? MACRODOWN( D(LGUI), T(X), END ) : MACRODOWN( D(LCTRL), T(X), END );
399 return use_cmd ? MACRODOWN( D(LGUI), T(C), END ) : MACRODOWN( D(LCTRL), T(C), END );
401 return use_cmd ? MACRODOWN( D(LGUI), T(V), END ) : MACRODOWN( D(LCTRL), T(V), END );
404 return use_cmd ? MACRODOWN( D(LGUI), D(LCTRL), T(SCLN), END ) : MACRODOWN( D(LALT), D(LCTRL), T(SCLN), END );
406 return use_cmd ? MACRODOWN( D(LGUI), D(LCTRL), T(QUOT), END ) : MACRODOWN( D(LALT), D(LCTRL), T(QUOT), END );
412 void matrix_init_user(void) {
422 _delay_ms(20); // gets rid of tick
423 PLAY_NOTE_ARRAY(tone_startup, false, 0);
428 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
433 void music_on_user(void)
438 void music_scale_user(void)
440 PLAY_NOTE_ARRAY(music_scale, false, 0);