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
27 enum planck_keycodes {
38 // Fillers to make layering more clear
39 #define _______ KC_TRNS
43 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
44 #define LT_TC LT(_TOUCHCURSOR, KC_SPC) // L-ayer T-ap T-ouch C-ursor
45 // ^-- Requires KC_TRNS / _______ for the trigger key in the destination layer
46 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
47 #define LT_ML LT(_MOUSE, KC_A) // L-ayer T-ap M-ouse C-ursor (on A)
49 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
52 * ,-----------------------------------------------------------------------------------------.
53 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
54 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
55 * | Ctrl/Esc | ML/A | S | D | F | G | H | J | K | L | ; | " |
56 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
57 * | Shift | Z | X | C | V | B | N | M | , | . | / |Sft/Ent |
58 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
59 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
60 * `-----------------------------------------------------------------------------------------'
63 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
64 {CTL_ESC, LT_ML, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
65 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
66 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
70 * ,-----------------------------------------------------------------------------------------.
71 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
72 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
73 * | Ctrl/Esc | ML/A | R | S | T | D | H | N | E | I | O | " |
74 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
75 * | Shift | Z | X | C | V | B | K | M | , | . | / |Sft/Ent |
76 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
77 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
78 * `-----------------------------------------------------------------------------------------'
81 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
82 {CTL_ESC, LT_ML, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
83 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
84 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
88 * ,-----------------------------------------------------------------------------------------.
89 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
90 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
91 * | Ctrl/Esc | ML/A | O | E | U | I | D | H | T | N | S | / |
92 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
93 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Sft/Ent |
94 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
95 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
96 * `-----------------------------------------------------------------------------------------'
99 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
100 {CTL_ESC, LT_ML, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
101 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, 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 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
108 * |------+------+------+------+------+-------------+------+------+------+------+------|
109 * | [ | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
110 * |------+------+------+------+------+------|------+------+------+------+------+------|
111 * | ] | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | \ |
112 * |------+------+------+------+------+------+------+------+------+------+------+------|
113 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
114 * `-----------------------------------------------------------------------------------'
117 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
118 {KC_LBRC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
119 {KC_RBRC, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
120 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
124 * ,-----------------------------------------------------------------------------------.
125 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
126 * |------+------+------+------+------+-------------+------+------+------+------+------|
127 * | $ | 4 | 5 | 6 | . | + | * | 4 | 5 | 6 | - | | |
128 * |------+------+------+------+------+------|------+------+------+------+------+------|
129 * | = | 7 | 8 | 9 | 0 | - | / | 1 | 2 | 3 | . | \ |
130 * |------+------+------+------+------+------+------+------+------+------+------+------|
131 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
132 * `-----------------------------------------------------------------------------------'
135 {KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
136 {KC_DLR, KC_4, KC_5, KC_6, KC_DOT, KC_PLUS, KC_ASTR, KC_4, KC_5, KC_6, KC_MINS, KC_PIPE},
137 {KC_EQL, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_SLSH, KC_1, KC_2, KC_3, KC_DOT, KC_BSLS},
138 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
141 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
142 * ,-----------------------------------------------------------------------------------.
143 * | | | |Shift | GUI | ~ |Insert| Home | Up | End | Bksp | |
144 * |------+------+------+------+------+-------------+------+------+------+------+------|
145 * | | Alt |Space | | Find |Again | PgUp | Left | Down |Right | | |
146 * |------+------+------+------+------+------|------+------+------+------+------+------|
147 * | | Undo | Cut | Copy |Paste | ` | PgDn | Del | | | | |
148 * |------+------+------+------+------+------+------+------+------+------+------+------|
149 * | | | | | | | | | | | |
150 * `-----------------------------------------------------------------------------------'
152 * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
153 * seem to work on Mac. Presumably they'll work under Windows.
157 {_______, _______, _______, KC_LSFT, KC_LGUI, KC_TILD, KC_INS, KC_HOME, KC_UP, KC_END, KC_BSPC, _______},
158 {_______, KC_LALT, KC_SPC, _______, KC_FIND,KC_AGAIN, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
159 {_______, KC_UNDO, KC_CUT, KC_COPY, KC_PASTE,KC_GRV, KC_PGDN, KC_DEL, _______, _______, _______, _______},
160 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
164 * ,-----------------------------------------------------------------------------------.
165 * | | |ACCL0 |ACCL1 |ACCL2 |ACCL2 | |WHL_L | Up |WHL_R | BTN2 | |
166 * |------+------+------+------+------+-------------+------+------+------+------+------|
167 * | | | | BTN3 | BTN1 | BTN4 |WHL_Up| Left | Down |Right | | |
168 * |------+------+------+------+------+------|------+------+------+------+------+------|
169 * | | | | | BTN2 | BTN5 |WHL_Dn| BTN1 | | | | |
170 * |------+------+------+------+------+------+------+------+------+------+------+------|
171 * | | | | | | | | | | | |
172 * `-----------------------------------------------------------------------------------'
176 {_______, _______, KC_ACL0, KC_ACL1, KC_ACL2, KC_ACL2, _______, KC_WH_L, KC_MS_U, KC_WH_R, KC_BTN2, _______},
177 {_______, _______, _______, KC_BTN3, KC_BTN1, KC_BTN4, KC_WH_U, KC_MS_L, KC_MS_D, KC_MS_R, _______, _______},
178 {_______, _______, _______, _______, KC_BTN2, KC_BTN5, KC_WH_D, KC_BTN1, _______, _______, _______, _______},
179 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
182 /* Plover layer (http://opensteno.org)
183 * ,-----------------------------------------------------------------------------------.
184 * | # | # | # | # | # | # | # | # | # | # | # | # |
185 * |------+------+------+------+------+-------------+------+------+------+------+------|
186 * | | S | T | P | H | * | * | F | P | L | T | D |
187 * |------+------+------+------+------+------|------+------+------+------+------+------|
188 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
189 * |------+------+------+------+------+------+------+------+------+------+------+------|
190 * | Exit | | | A | O | | E | U | | | |
191 * `-----------------------------------------------------------------------------------'
195 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
196 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
197 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
198 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
201 /* Adjust (Lower + Raise)
202 * ,-----------------------------------------------------------------------------------.
203 * | | | | | | | | | | | | Del |
204 * |------+------+------+------+------+-------------+------+------+------+------+------|
205 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
206 * |------+------+------+------+------+------|------+------+------+------+------+------|
207 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
208 * |------+------+------+------+------+------+------+------+------+------+------+------|
209 * | | | | | | | | | | |Reset |
210 * `-----------------------------------------------------------------------------------'
213 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
214 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
215 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
216 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET}
224 float tone_startup[][2] = SONG(STARTUP_SOUND);
225 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
226 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
227 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
228 float tone_plover[][2] = SONG(PLOVER_SOUND);
229 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
230 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
232 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
236 void persistant_default_layer_set(uint16_t default_layer) {
237 eeconfig_update_default_layer(default_layer);
238 default_layer_set(default_layer);
241 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
244 if (record->event.pressed) {
246 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
248 default_layer_set(1UL<<_QWERTY);
253 if (record->event.pressed) {
255 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
257 default_layer_set(1UL<<_COLEMAK);
262 if (record->event.pressed) {
264 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
266 default_layer_set(1UL<<_DVORAK);
271 if (record->event.pressed) {
273 update_tri_layer(_LOWER, _RAISE, _ADJUST);
276 update_tri_layer(_LOWER, _RAISE, _ADJUST);
281 if (record->event.pressed) {
283 update_tri_layer(_LOWER, _RAISE, _ADJUST);
286 update_tri_layer(_LOWER, _RAISE, _ADJUST);
291 if (record->event.pressed) {
292 register_code(KC_RSFT);
293 #ifdef BACKLIGHT_ENABLE
297 unregister_code(KC_RSFT);
302 if (record->event.pressed) {
305 PLAY_NOTE_ARRAY(tone_plover, false, 0);
311 if (!eeconfig_is_enabled()) {
314 keymap_config.raw = eeconfig_read_keymap();
315 keymap_config.nkro = 1;
316 eeconfig_update_keymap(keymap_config.raw);
321 if (record->event.pressed) {
323 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
333 void matrix_init_user(void) {
343 _delay_ms(20); // gets rid of tick
344 PLAY_NOTE_ARRAY(tone_startup, false, 0);
349 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
354 void music_on_user(void)
359 void music_scale_user(void)
361 PLAY_NOTE_ARRAY(music_scale, false, 0);