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.
4 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
6 #include "action_layer.h"
7 // #include "dynamic_macro.h"
14 #if (__has_include("macros_private.h") && !defined(SECRETS))
15 #include "macros_private.h"
17 #include "macros_public.h"
20 extern keymap_config_t keymap_config;
22 // Each layer gets a name for readability, which is then used in the keymap matrix below.
23 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
24 // Layer names don't all need to be of the same length, obviously, and you can also skip them
25 // entirely and just use numbers.
34 #define _MOUSECURSOR 8
37 enum planck_keycodes {
49 // Fillers to make layering more clear
50 #define _______ KC_TRNS
53 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
54 #define CTL_TTAB CTL_T(KC_TAB) // Tap for Esc, hold for Ctrl
55 #define CTL_ENT CTL_T(KC_ENT) // Tap for Enter, hold for Ctrl
56 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
57 // Requires KC_TRNS/_______ for the trigger key in the destination layer
58 #define LT_FN(kc) LT(_FNLAYER, kc) // L-ayer T-ap Function Layer
59 #define LT_MC(kc) LT(_MOUSECURSOR, kc) // L-ayer T-ap M-ouse C-ursor
60 #define LT_RAI(kc) LT(_RAISE, kc) // L-ayer T-ap to Raise
61 #define TG_NUMLAY TG(_NUMLAY) //Toggle for layer _NUMLAY
62 #define P_CITRIX M(KC_CITRIX) // My login macros
63 #define P_MPASS M(KC_MPASS)
64 #define P_META M(KC_META)
65 #define O_DAYRN M(KC_DAYRN) // My work macros
66 #define O_AUTODC M(KC_AUTODC)
67 #define O_RTQ6H M(KC_RTQ6H)
68 #define M_EMAIL M(KC_EMAIL) // My personal email
69 #define M_EMAIL2 M(KC_EMAIL2) // My work email
71 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
73 ,-----------------------------------------------------------------------------------.
74 * |Tab/FN| Q | W | E | R | T | Y | U | I | O | P | Bksp |
75 * |------+------+------+------+------+-------------+------+------+------+------+------|
76 * | LCtl | A | S | D | F | G | H | J | K | L | ; |Ctl/Et|
77 * |------+------+------+------+------+------|------+------+------+------+------+------|
78 * | Shift| Z | X | C | V | B | N | M | , | . | / | - |
79 * |------+------+------+------+------+------+------+------+------+------+------+------|
80 * | Esc | Caps | Alt | GUI |Lower | Space |Raise |NumLay| RAlt | Men | Del |
81 * `-----------------------------------------------------------------------------------'
83 [_QWERTY] = LAYOUT_planck_grid(
84 LT_FN(KC_TAB), KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
85 KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, LT_MC(KC_SCLN), CTL_ENT,
86 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, LT_RAI(KC_MINS),
87 KC_ESC, KC_CAPS, KC_LGUI, KC_LALT, LOWER, KC_SPC, KC_SPC, RAISE, KC_RALT, TG_NUMLAY, KC_APP, KC_DEL
91 * ,-----------------------------------------------------------------------------------.
92 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
93 * |------+------+------+------+------+-------------+------+------+------+------+------|
94 * | Esc | A | R | S | T | D | H | N | E | I | O |Ctl/Et|
95 * |------+------+------+------+------+------|------+------+------+------+------+------|
96 * | Shift| Z | X | C | V | B | K | M | , | . | / | - |
97 * |------+------+------+------+------+------+------+------+------+------+------+------|
98 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
99 * `-----------------------------------------------------------------------------------'
101 [_COLEMAK] = LAYOUT_planck_grid(
102 LT_FN(KC_TAB), KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
103 KC_LCTL, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, LT_MC(KC_O), KC_ENT,
104 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, LT_RAI(KC_MINS),
105 KC_ESC, KC_CAPS, KC_LGUI, KC_LALT, LOWER, KC_SPC, KC_SPC, RAISE, KC_RALT, TG_NUMLAY, KC_APP, KC_DEL
109 * ,-----------------------------------------------------------------------------------.
110 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
111 * |------+------+------+------+------+-------------+------+------+------+------+------|
112 * | Esc | A | O | E | U | I | D | H | T | N | S |Ctl/Et|
113 * |------+------+------+------+------+------|------+------+------+------+------+------|
114 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
115 * |------+------+------+------+------+------+------+------+------+------+------+------|
116 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
117 * `-----------------------------------------------------------------------------------'
119 [_DVORAK] = LAYOUT_planck_grid(
120 LT_FN(KC_TAB), KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
121 KC_LCTL, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, LT_MC(KC_S), KC_ENT,
122 KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, LT_RAI(KC_MINS),
123 KC_ESC, KC_CAPS, KC_LGUI, KC_LALT, LOWER, KC_SPC, KC_SPC, RAISE, KC_RALT, TG_NUMLAY, KC_APP, KC_DEL
127 * ,-----------------------------------------------------------------------------------.
128 * | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | ~ | \ |
129 * |------+------+------+------+------+-------------+------+------+------+------+------|
130 * | | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
131 * |------+------+------+------+------+------|------+------+------+------+------+------|
132 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | [ | ] | |
133 * |------+------+------+------+------+------+------+------+------+------+------+------|
134 * | | | | | | | | Next | Vol- | Vol+ | Play |
135 * `-----------------------------------------------------------------------------------'
137 [_LOWER] = LAYOUT_planck_grid(
138 KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_GRV, KC_BSLS,
139 _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_EQL, KC_LBRC, KC_RBRC, KC_PIPE,
140 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),KC_LCBR, KC_RCBR, _______,
141 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
145 * ,-----------------------------------------------------------------------------------.
146 * | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | * | \ |
147 * |------+------+------+------+------+-------------+------+------+------+------+------|
148 * | | A | Up | D | | Vol+ | 4 | 5 | 6 | + | : | ' |
149 * |------+------+------+------+------+------|------+------+------+------+------+------|
150 * | | Lt | Dn | Rt | Mute | Vol- | 1 | 2 | 3 | Up | / | |
151 * |------+------+------+------+------+------+------+------+------+------+------+------|
152 * | | | | | | | 0 | | Left | Down | Right| NumLk|
153 * `-----------------------------------------------------------------------------------'
155 [_RAISE] = LAYOUT_planck_grid(
156 KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_PLUS, KC_BSLS,
157 _______, KC_A, KC_UP, KC_D, KC_PSCR, KC_VOLU, KC_4, KC_5, KC_6, KC_PAST, KC_COLN, KC_QUOT,
158 _______, KC_LEFT, KC_DOWN, KC_RIGHT,KC__MUTE, KC_VOLD, KC_1, KC_2, KC_3, KC_UP, KC_SLSH, _______,
159 _______, _______, _______, _______, _______, KC_SPC, KC_0, _______, KC_LEFT, KC_DOWN, KC_RIGHT, KC_NLCK
162 /* Plover layer (http://opensteno.org)
163 * ,-----------------------------------------------------------------------------------.
164 * | # | # | # | # | # | # | # | # | # | # | # | # |
165 * |------+------+------+------+------+-------------+------+------+------+------+------|
166 * | | S | T | P | H | * | * | F | P | L | T | D |
167 * |------+------+------+------+------+------|------+------+------+------+------+------|
168 * | | S | K | W | R | * | * | R | B | G | S | Z |
169 * |------+------+------+------+------+------+------+------+------+------+------+------|
170 * | Exit | | | A | O | | E | U | | | |
171 * `-----------------------------------------------------------------------------------'
174 [_PLOVER] = LAYOUT_planck_grid(
175 KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
176 XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
177 XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
178 EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
181 /* FN layer on Esc key
182 * ,-----------------------------------------------------------------------------------.
183 * | | ! | @ | # | $ | % | ^ | & | * | ( | ) | + |
184 * |------+------+------+------+------+-------------+------+------+------+------+------|
185 * | | F1 | F2 | F3 | F4 | F5 | F6 | _ | = | [ | ] | ' |
186 * |------+------+------+------+------+------|------+------+------+------+------+------|
187 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | { | } |Enter |
188 * |------+------+------+------+------+------+------+------+------+------+------+------|
189 * | | | | | | | | Next | Vol- | Vol+ | Play |
190 * `-----------------------------------------------------------------------------------'
192 [_FNLAYER] = LAYOUT_planck_grid(
193 _______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PLUS,
194 _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_EQL, KC_LBRC, KC_RBRC, KC_QUOT,
195 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),KC_LCBR, KC_RCBR, _______,
196 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
200 * ,-----------------------------------------------------------------------------------.
201 * | | Q | Up | 4 | | | 7 | 8 | 9 | - | + | Bksp |
202 * |------+------+------+------+------+-------------+------+------+------+------+------|
203 * | | Lt | Dn | Rt | | | 4 | 5 | 6 | * | : | ENT |
204 * |------+------+------+------+------+------|------+------+------+------+------+------|
205 * | | Z | X | C | V | | 1 | 2 | 3 | . | / | |
206 * |------+------+------+------+------+------+------+------+------+------+------+------|
207 * | | | | | | | 0 | . | Exit | Vol- | Vol+ | Play |
208 * `-----------------------------------------------------------------------------------'
210 [_NUMLAY] = LAYOUT_planck_grid(
211 _______, KC_Q, KC_UP, KC_H, XXXXXXX, XXXXXXX, KC_P7, KC_P8, KC_P9, KC_MINS, KC_PLUS, KC_BSPC,
212 _______, KC_LEFT, KC_DOWN, KC_RIGHT, XXXXXXX, XXXXXXX, KC_P4, KC_P5, KC_P6, KC_PAST, KC_COLN, KC_ENT,
213 _______, KC_Z, KC_X, KC_C, KC_V, XXXXXXX, KC_P1, KC_P2, KC_P3, KC_PDOT, KC_PSLS, _______,
214 _______, _______, _______, _______, _______, _______, KC_P0, KC_PDOT, _______, _______, KC_NLCK, KC_MPLY
217 /* Mouse Layer (semi-col)
218 * ,-----------------------------------------------------------------------------------.
219 * | ACCL0| ACCL1| ACCL2|Email |Email2| Home | Wh_Up| WHL_L| M_Up | WHL_R|PASS| Meta |
220 * |------+------+------+------+------+-------------+------+------+------+------+------|
221 * | | | | |RT Q6H| End | Wh_Dn| M_Lft| M_Dn | M_Rt | | DayRn|
222 * |------+------+------+------+------+------|------+------+------+------+------+------|
223 * | | | | | | | BTN2 | BTN3 | BTN4 | BTN5 | | |
224 * |------+------+------+------+------+------+------+------+------+------+------+------|
225 * | | | | | | BTN1 | | | | Citx | |
226 * `-----------------------------------------------------------------------------------'
229 [_MOUSECURSOR] = LAYOUT_planck_grid(
230 KC_ACL0, KC_ACL1, KC_ACL2, M_EMAIL,M_EMAIL2, KC_HOME, KC_PGUP, KC_WH_L, KC_MS_U, KC_WH_R, P_MPASS, P_META,
231 _______, XXXXXXX, XXXXXXX, XXXXXXX, O_RTQ6H, KC_END , KC_PGDN, KC_MS_L, KC_MS_D, KC_MS_R, _______, O_DAYRN,
232 _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, KC_BTN2, KC_BTN3, KC_BTN4, KC_BTN5, _______, _______,
233 _______, _______, _______, _______, _______, KC_BTN1, KC_BTN1, _______, _______, _______, P_CITRIX, O_AUTODC
236 /* Adjust (Lower + Raise)
237 * ,-----------------------------------------------------------------------------------.
238 * | Reset|RGB TG|RGB ST|RGBH -|RGBH +|RGBS -|RGBS +|RGBV -|RGBV +| | | Del |
239 * |------+------+------+------+------+-------------+------+------+------+------+------|
240 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
241 * |------+------+------+------+------+------|------+------+------+------+------+------|
242 * | |Voice-|Voice+|Mus on|Musoff| | | | | BL + |BL ST |BL TG |
243 * |------+------+------+------+------+------+------+------+------+------+------+------|
244 * | | | | | | | | | | | |
245 * `-----------------------------------------------------------------------------------'
247 [_ADJUST] = LAYOUT_planck_grid(
248 DFU, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, KC_DEL,
249 _______, MAGIC_TOGGLE_NKRO, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
250 _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, BL_DEC, BL_INC, BL_STEP, BL_TOGG,
251 _______, _______, _______, _______, _______, _______, _______, _______, CK_RST, CK_DOWN, CK_UP, CK_TOGG
257 const uint16_t PROGMEM fn_actions[] = {
258 ACTION_SWAP_HANDS_TAP_KEY(KC_SPC),
263 float tone_startup[][2] = SONG(STARTUP_SOUND);
264 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
265 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
266 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
267 float tone_plover[][2] = SONG(PLOVER_SOUND);
268 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
269 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
271 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
275 void persistant_default_layer_set(uint16_t default_layer) {
276 eeconfig_update_default_layer(default_layer);
277 default_layer_set(default_layer);
281 void tap(uint16_t keycode){ register_code(keycode); unregister_code(keycode); };
284 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
287 if (record->event.pressed) {
289 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
291 persistant_default_layer_set(1UL<<_QWERTY);
296 if (record->event.pressed) {
298 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
300 persistant_default_layer_set(1UL<<_COLEMAK);
305 if (record->event.pressed) {
307 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
309 persistant_default_layer_set(1UL<<_DVORAK);
314 if (record->event.pressed) {
316 update_tri_layer(_LOWER, _RAISE, _ADJUST);
319 update_tri_layer(_LOWER, _RAISE, _ADJUST);
324 if (record->event.pressed) {
326 update_tri_layer(_LOWER, _RAISE, _ADJUST);
329 update_tri_layer(_LOWER, _RAISE, _ADJUST);
334 if (record->event.pressed) {
335 register_code(KC_RSFT);
336 #ifdef BACKLIGHT_ENABLE
340 unregister_code(KC_RSFT);
345 if (record->event.pressed) {
348 PLAY_NOTE_ARRAY(tone_plover, false, 0);
354 if (!eeconfig_is_enabled()) {
357 keymap_config.raw = eeconfig_read_keymap();
358 keymap_config.nkro = 1;
359 eeconfig_update_keymap(keymap_config.raw);
364 if (record->event.pressed) {
366 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
373 if (record->event.pressed) {
375 #if defined(MIDI_ENABLE) && defined(MIDI_BASIC)
376 process_midi_all_notes_off();
378 #if defined(AUDIO_ENABLE) && !defined(NO_MUSIC_MODE)
379 music_all_notes_off();
380 uint16_t timer_start = timer_read();
381 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
383 while(timer_elapsed(timer_start) < 250)
389 // this is also done later in bootloader.c - not sure if it's neccesary here
390 #ifdef BOOTLOADER_CATERINA
391 *(uint16_t *)0x0800 = 0x7777; // these two are a-star-specific
401 void matrix_init_user(void) {
411 rgblight_mode(RGB_MATRIX_CYCLE_ALL);
412 wait_ms(20); // gets rid of tick
413 PLAY_NOTE_ARRAY(tone_startup, false, 0);
418 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
423 void music_on_user(void)
428 void music_scale_user(void)
430 PLAY_NOTE_ARRAY(music_scale, false, 0);