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 {
45 // Fillers to make layering more clear
46 #define _______ KC_TRNS
50 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
51 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
52 // Requires KC_TRNS/_______ for the trigger key in the destination layer
53 #define LT_TC LT(_TOUCHCURSOR, KC_SPC) // L-ayer T-ap T-ouch C-ursor.
54 #define LT_ML LT(_MOUSE, KC_A) // L-ayer T-ap M-ouse C-ursor (on A)
55 #define ALT_TAB M(KC_ALT_TAB) // Macro for Alt-Tab
56 #define CMD_TAB M(KC_CMD_TAB) // Macro for Cmd-Tab
57 #define CTL_TAB M(KC_CTL_TAB) // Macro for Ctl-Tab
59 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
62 * ,-----------------------------------------------------------------------------------------.
63 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
64 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
65 * | Ctrl/Esc | ML/A | S | D | F | G | H | J | K | L | ; | " |
66 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
67 * | Shift | Z | X | C | V | B | N | M | , | . | / |Sft/Ent |
68 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
69 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
70 * `-----------------------------------------------------------------------------------------'
73 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
74 {CTL_ESC, LT_ML, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
75 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
76 {KC_PSCR, KC_RGUI, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
80 * ,-----------------------------------------------------------------------------------------.
81 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
82 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
83 * | Ctrl/Esc | ML/A | R | S | T | D | H | N | E | I | O | " |
84 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
85 * | Shift | Z | X | C | V | B | K | 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_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
92 {CTL_ESC, LT_ML, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
93 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, 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 | " | , | . | P | Y | F | G | C | R | L | Bksp |
100 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
101 * | Ctrl/Esc | ML/A | O | E | U | I | D | H | T | N | S | / |
102 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
103 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Sft/Ent |
104 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
105 * | PrntScrn | RGUI | Alt | GUI |Lower | TC/Space |Raise | Next | Vol- | Vol+ | Play |
106 * `-----------------------------------------------------------------------------------------'
109 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
110 {CTL_ESC, LT_ML, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
111 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, 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 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
118 * |------+------+------+------+------+-------------+------+------+------+------+------|
119 * | [ | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
120 * |------+------+------+------+------+------|------+------+------+------+------+------|
121 * | ] | F7 | F8 | F9 | F10 | F11 | F12 | - | = | [ | ] | \ |
122 * |------+------+------+------+------+------+------+------+------+------+------+------|
123 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
124 * `-----------------------------------------------------------------------------------'
127 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
128 {KC_LBRC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
129 {KC_RBRC, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
130 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
134 * ,-----------------------------------------------------------------------------------.
135 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
136 * |------+------+------+------+------+-------------+------+------+------+------+------|
137 * | $ | 4 | 5 | 6 | . | + | * | 4 | 5 | 6 | - | | |
138 * |------+------+------+------+------+------|------+------+------+------+------+------|
139 * | = | 7 | 8 | 9 | 0 | - | / | 1 | 2 | 3 | . | \ |
140 * |------+------+------+------+------+------+------+------+------+------+------+------|
141 * |Brite | | | | | | | Prev | Stop | Slct | Mute |
142 * `-----------------------------------------------------------------------------------'
145 {KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
146 {KC_DLR, KC_4, KC_5, KC_6, KC_DOT, KC_PLUS, KC_ASTR, KC_4, KC_5, KC_6, KC_MINS, KC_PIPE},
147 {KC_EQL, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_SLSH, KC_1, KC_2, KC_3, KC_DOT, KC_BSLS},
148 {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MSTP, KC_MSEL, KC_MUTE}
151 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
152 * ,-----------------------------------------------------------------------------------.
153 * |AltTab|CmdTab|CtlTab| GUI |Shift | ~ |Insert| Home | Up | End | Bksp | |
154 * |------+------+------+------+------+-------------+------+------+------+------+------|
155 * | | Alt |Space | | Find |Again | PgUp | Left | Down |Right | | |
156 * |------+------+------+------+------+------|------+------+------+------+------+------|
157 * | | Undo | Cut | Copy |Paste | ` | PgDn | Del | | | | |
158 * |------+------+------+------+------+------+------+------+------+------+------+------|
159 * | | | | | | | | | | | |
160 * `-----------------------------------------------------------------------------------'
162 * The KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND, and KC_AGAIN keycodes don't
163 * seem to work on Mac. Presumably they'll work under Windows.
167 {ALT_TAB, CMD_TAB, CTL_TAB, KC_LGUI, KC_LSFT, KC_TILD, KC_INS, KC_HOME, KC_UP, KC_END, KC_BSPC, _______},
168 {_______, KC_LALT, KC_SPC, _______, KC_FIND,KC_AGAIN, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
169 {_______, KC_UNDO, KC_CUT, KC_COPY, KC_PASTE,KC_GRV, KC_PGDN, KC_DEL, _______, _______, _______, _______},
170 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
174 * ,-----------------------------------------------------------------------------------.
175 * | | |ACCL0 |ACCL1 |ACCL2 |ACCL2 | |WHL_L | Up |WHL_R | BTN2 | |
176 * |------+------+------+------+------+-------------+------+------+------+------+------|
177 * | | | | BTN3 | BTN1 | BTN4 |WHL_Up| Left | Down |Right | | |
178 * |------+------+------+------+------+------|------+------+------+------+------+------|
179 * | | | | | BTN2 | BTN5 |WHL_Dn| BTN1 | | | | |
180 * |------+------+------+------+------+------+------+------+------+------+------+------|
181 * | | | | | | | | | | | |
182 * `-----------------------------------------------------------------------------------'
186 {_______, _______, KC_ACL0, KC_ACL1, KC_ACL2, KC_ACL2, _______, KC_WH_L, KC_MS_U, KC_WH_R, KC_BTN2, _______},
187 {_______, _______, _______, KC_BTN3, KC_BTN1, KC_BTN4, KC_WH_U, KC_MS_L, KC_MS_D, KC_MS_R, _______, _______},
188 {_______, _______, _______, _______, KC_BTN2, KC_BTN5, KC_WH_D, KC_BTN1, _______, _______, _______, _______},
189 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
192 /* Plover layer (http://opensteno.org)
193 * ,-----------------------------------------------------------------------------------.
194 * | # | # | # | # | # | # | # | # | # | # | # | # |
195 * |------+------+------+------+------+-------------+------+------+------+------+------|
196 * | | S | T | P | H | * | * | F | P | L | T | D |
197 * |------+------+------+------+------+------|------+------+------+------+------+------|
198 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
199 * |------+------+------+------+------+------+------+------+------+------+------+------|
200 * | Exit | | | A | O | | E | U | | | |
201 * `-----------------------------------------------------------------------------------'
205 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
206 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
207 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
208 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
211 /* Adjust (Lower + Raise)
212 * ,-----------------------------------------------------------------------------------.
213 * | | | | | | | | | | | | Del |
214 * |------+------+------+------+------+-------------+------+------+------+------+------|
215 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
216 * |------+------+------+------+------+------|------+------+------+------+------+------|
217 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
218 * |------+------+------+------+------+------+------+------+------+------+------+------|
219 * | | | | | | | | | | |Reset |
220 * `-----------------------------------------------------------------------------------'
223 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
224 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
225 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
226 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET}
234 float tone_startup[][2] = SONG(STARTUP_SOUND);
235 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
236 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
237 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
238 float tone_plover[][2] = SONG(PLOVER_SOUND);
239 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
240 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
242 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
246 void persistant_default_layer_set(uint16_t default_layer) {
247 eeconfig_update_default_layer(default_layer);
248 default_layer_set(default_layer);
251 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
254 if (record->event.pressed) {
256 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
258 default_layer_set(1UL<<_QWERTY);
263 if (record->event.pressed) {
265 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
267 default_layer_set(1UL<<_COLEMAK);
272 if (record->event.pressed) {
274 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
276 default_layer_set(1UL<<_DVORAK);
281 if (record->event.pressed) {
283 update_tri_layer(_LOWER, _RAISE, _ADJUST);
286 update_tri_layer(_LOWER, _RAISE, _ADJUST);
291 if (record->event.pressed) {
293 update_tri_layer(_LOWER, _RAISE, _ADJUST);
296 update_tri_layer(_LOWER, _RAISE, _ADJUST);
301 if (record->event.pressed) {
302 register_code(KC_RSFT);
303 #ifdef BACKLIGHT_ENABLE
307 unregister_code(KC_RSFT);
312 if (record->event.pressed) {
315 PLAY_NOTE_ARRAY(tone_plover, false, 0);
321 if (!eeconfig_is_enabled()) {
324 keymap_config.raw = eeconfig_read_keymap();
325 keymap_config.nkro = 1;
326 eeconfig_update_keymap(keymap_config.raw);
331 if (record->event.pressed) {
333 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
346 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
350 return (record->event.pressed ? MACRO( D(LALT), D(TAB), END ) : MACRO( U(TAB), END ));
352 return (record->event.pressed ? MACRO( D(LGUI), D(TAB), END ) : MACRO( U(TAB), END ));
354 return (record->event.pressed ? MACRO( D(LCTRL), D(TAB), END ) : MACRO( U(TAB), END ));
360 void matrix_init_user(void) {
370 _delay_ms(20); // gets rid of tick
371 PLAY_NOTE_ARRAY(tone_startup, false, 0);
376 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
381 void music_on_user(void)
386 void music_scale_user(void)
388 PLAY_NOTE_ARRAY(music_scale, false, 0);