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
28 enum planck_keycodes {
52 // Fillers to make layering more clear
53 #define _______ KC_TRNS
57 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
58 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
59 // Requires KC_TRNS/_______ for the trigger key in the destination layer
60 #define LT_TC LT(_TOUCHCURSOR, KC_SPC) // L-ayer T-ap T-ouch C-ursor.
61 #define LT_ML LT(_MOUSE, KC_A) // L-ayer T-ap M-ouse C-ursor (on A)
62 #define ALT_TAB M(KC_ALT_TAB) // Macro for Alt-Tab
63 #define CMD_TAB M(KC_CMD_TAB) // Macro for Cmd-Tab
64 #define CTL_TAB M(KC_CTL_TAB) // Macro for Ctl-Tab
65 #define CMD_SLSH M(KC_CMD_SLSH) // Macro for Cmd-Slash (personal shortcut to toggle iTerm2 visibility)
66 #define AG_FIND M(KC_AG_FIND) // Macros for Cmd-[x] vs Ctrl-[x] based on current AG_NORM or AG_SWAP settings
67 #define AG_AGAIN M(KC_AG_AGAIN)
68 #define AG_UNDO M(KC_AG_UNDO)
69 #define AG_CUT M(KC_AG_CUT)
70 #define AG_COPY M(KC_AG_COPY)
71 #define AG_PASTE M(KC_AG_PASTE)
73 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
76 * ,-----------------------------------------------------------------------------------------.
77 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
78 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
79 * | Ctrl/Esc | ML/A | S | D | F | G | H | J | K | L | ; | " |
80 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
81 * | Shift | Z | X | C | V | B | N | M | , | . | / |Sft/Ent |
82 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
83 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
84 * `-----------------------------------------------------------------------------------------'
87 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
88 {CTL_ESC, LT_ML, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
89 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
90 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
94 * ,-----------------------------------------------------------------------------------------.
95 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
96 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
97 * | Ctrl/Esc | ML/A | R | S | T | D | H | N | E | I | O | " |
98 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
99 * | Shift | Z | X | C | V | B | K | M | , | . | / |Sft/Ent |
100 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
101 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
102 * `-----------------------------------------------------------------------------------------'
105 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
106 {CTL_ESC, LT_ML, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
107 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
108 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
112 * ,-----------------------------------------------------------------------------------------.
113 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
114 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
115 * | Ctrl/Esc | ML/A | O | E | U | I | D | H | T | N | S | / |
116 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
117 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Sft/Ent |
118 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
119 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
120 * `-----------------------------------------------------------------------------------------'
123 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
124 {CTL_ESC, LT_ML, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
125 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, SFT_ENT},
126 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
130 * ,-----------------------------------------------------------------------------------.
131 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
132 * |------+------+------+------+------+-------------+------+------+------+------+------|
133 * | [ | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
134 * |------+------+------+------+------+------|------+------+------+------+------+------|
135 * | ] | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | \ |
136 * |------+------+------+------+------+------+------+------+------+------+------+------|
137 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
138 * `-----------------------------------------------------------------------------------'
141 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
142 {KC_LBRC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
143 {KC_RBRC, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
144 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
148 * ,-----------------------------------------------------------------------------------.
149 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
150 * |------+------+------+------+------+-------------+------+------+------+------+------|
151 * | $ | 4 | 5 | 6 | . | + | . | 4 | 5 | 6 | * | | |
152 * |------+------+------+------+------+------|------+------+------+------+------+------|
153 * | = | 7 | 8 | 9 | 0 | - | . | 1 | 2 | 3 | / | \ |
154 * |------+------+------+------+------+------+------+------+------+------+------+------|
155 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
156 * `-----------------------------------------------------------------------------------'
159 {KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
160 {KC_DLR, KC_4, KC_5, KC_6, KC_DOT, KC_PLUS, KC_DOT, KC_4, KC_5, KC_6, KC_ASTR, KC_PIPE},
161 {KC_EQL, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_DOT, KC_1, KC_2, KC_3, KC_SLSH, KC_BSLS},
162 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
165 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
166 * ,-----------------------------------------------------------------------------------.
167 * |AltTab|CmdTab|CtlTab| GUI |Shift | ~ |Insert| Home | Up | End | Bksp | |
168 * |------+------+------+------+------+-------------+------+------+------+------+------|
169 * | | Alt |Space | | Find |Again | PgUp | Left | Down |Right | | |
170 * |------+------+------+------+------+------|------+------+------+------+------+------|
171 * | | Undo | Cut | Copy |Paste | ` | PgDn | Del | | | | |
172 * |------+------+------+------+------+------+------+------+------+------+------+------|
173 * | | | | | | | | | | | |
174 * `-----------------------------------------------------------------------------------'
176 * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
177 * seem to work on Mac. Presumably they'll work under Windows.
181 {ALT_TAB, CMD_TAB, CTL_TAB, KC_LGUI, KC_LSFT, KC_TILD, KC_INS, KC_HOME, KC_UP, KC_END, KC_BSPC, _______},
182 {_______, KC_LALT, KC_SPC, _______, AG_FIND,AG_AGAIN, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
183 {_______, AG_UNDO, AG_CUT, AG_COPY, AG_PASTE,KC_GRV, KC_PGDN, KC_DEL, _______, _______, CMD_SLSH,_______},
184 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
188 * ,-----------------------------------------------------------------------------------.
189 * | | |ACCL0 |ACCL1 |ACCL2 |ACCL2 | |WHL_L | Up |WHL_R | BTN2 | |
190 * |------+------+------+------+------+-------------+------+------+------+------+------|
191 * | | | | BTN3 | BTN1 | BTN4 |WHL_Up| Left | Down |Right | | |
192 * |------+------+------+------+------+------|------+------+------+------+------+------|
193 * | | | | | BTN2 | BTN5 |WHL_Dn| BTN1 | | | | |
194 * |------+------+------+------+------+------+------+------+------+------+------+------|
195 * | | | | | | | | | | | |
196 * `-----------------------------------------------------------------------------------'
200 {_______, _______, KC_ACL0, KC_ACL1, KC_ACL2, KC_ACL2, _______, KC_WH_L, KC_MS_U, KC_WH_R, KC_BTN2, _______},
201 {_______, _______, _______, KC_BTN3, KC_BTN1, KC_BTN4, KC_WH_U, KC_MS_L, KC_MS_D, KC_MS_R, _______, _______},
202 {_______, _______, _______, _______, KC_BTN2, KC_BTN5, KC_WH_D, KC_BTN1, _______, _______, _______, _______},
203 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
206 /* Plover layer (http://opensteno.org)
207 * ,-----------------------------------------------------------------------------------.
208 * | # | # | # | # | # | # | # | # | # | # | # | # |
209 * |------+------+------+------+------+-------------+------+------+------+------+------|
210 * | | S | T | P | H | * | * | F | P | L | T | D |
211 * |------+------+------+------+------+------|------+------+------+------+------+------|
212 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
213 * |------+------+------+------+------+------+------+------+------+------+------+------|
214 * | Exit | | | A | O | | E | U | | | |
215 * `-----------------------------------------------------------------------------------'
219 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
220 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
221 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
222 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
225 /* Adjust (Lower + Raise)
226 * ,-----------------------------------------------------------------------------------.
227 * | | | | | | | | | | | | Del |
228 * |------+------+------+------+------+-------------+------+------+------+------+------|
229 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
230 * |------+------+------+------+------+------|------+------+------+------+------+------|
231 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
232 * |------+------+------+------+------+------+------+------+------+------+------+------|
233 * | | | | | | | | | | |Reset |
234 * `-----------------------------------------------------------------------------------'
237 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
238 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
239 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
240 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET}
248 float tone_startup[][2] = SONG(STARTUP_SOUND);
249 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
250 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
251 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
252 float tone_plover[][2] = SONG(PLOVER_SOUND);
253 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
254 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
256 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
260 void persistant_default_layer_set(uint16_t default_layer) {
261 eeconfig_update_default_layer(default_layer);
262 default_layer_set(default_layer);
265 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
268 if (record->event.pressed) {
270 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
272 default_layer_set(1UL<<_QWERTY);
277 if (record->event.pressed) {
279 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
281 default_layer_set(1UL<<_COLEMAK);
286 if (record->event.pressed) {
288 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
290 default_layer_set(1UL<<_DVORAK);
295 if (record->event.pressed) {
297 update_tri_layer(_LOWER, _RAISE, _ADJUST);
300 update_tri_layer(_LOWER, _RAISE, _ADJUST);
305 if (record->event.pressed) {
307 update_tri_layer(_LOWER, _RAISE, _ADJUST);
310 update_tri_layer(_LOWER, _RAISE, _ADJUST);
315 if (record->event.pressed) {
316 register_code(KC_RSFT);
317 #ifdef BACKLIGHT_ENABLE
321 unregister_code(KC_RSFT);
326 if (record->event.pressed) {
329 PLAY_NOTE_ARRAY(tone_plover, false, 0);
335 if (!eeconfig_is_enabled()) {
338 keymap_config.raw = eeconfig_read_keymap();
339 keymap_config.nkro = 1;
340 eeconfig_update_keymap(keymap_config.raw);
345 if (record->event.pressed) {
347 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
360 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
362 if (!eeconfig_is_enabled()) {
366 bool use_cmd = true; // Use, for example, Cmd-Tab, Cmd-C, Cmd-V, etc.
367 // Compare to MAGIC_SWAP_ALT_GUI and MAGIC_UNSWAP_ALT_GUI configs, set in:
369 if(keymap_config.swap_lalt_lgui == 1 && keymap_config.swap_ralt_rgui == 1) {
370 use_cmd = false; // ... or, Alt-Tab, Ctrl-C, Ctrl-V, etc.
375 if(use_cmd) { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
376 else { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
378 if(use_cmd) { return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END )); }
379 else { return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END )); }
382 return (record->event.pressed ? MACRO( D(LCTRL), D(TAB), END ) : MACRO( U(TAB), END ));
384 return (record->event.pressed ? MACRO( D(LGUI), D(SLSH),END ) : MACRO( U(SLSH),END ));
387 return use_cmd ? MACRODOWN( D(LGUI), T(F), END ) : MACRODOWN( D(LCTRL), T(F), END );
389 return use_cmd ? MACRODOWN( D(LGUI), T(G), END ) : MACRODOWN( D(LCTRL), T(G), END );
391 return use_cmd ? MACRODOWN( D(LGUI), T(Z), END ) : MACRODOWN( D(LCTRL), T(Z), END );
393 return use_cmd ? MACRODOWN( D(LGUI), T(X), END ) : MACRODOWN( D(LCTRL), T(X), END );
395 return use_cmd ? MACRODOWN( D(LGUI), T(C), END ) : MACRODOWN( D(LCTRL), T(C), END );
397 return use_cmd ? MACRODOWN( D(LGUI), T(V), END ) : MACRODOWN( D(LCTRL), T(V), END );
403 void matrix_init_user(void) {
413 _delay_ms(20); // gets rid of tick
414 PLAY_NOTE_ARRAY(tone_startup, false, 0);
419 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
424 void music_on_user(void)
429 void music_scale_user(void)
431 PLAY_NOTE_ARRAY(music_scale, false, 0);