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.
25 enum planck_keycodes {
31 // Fillers to make layering more clear
32 #define _______ KC_TRNS
35 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
37 /* Workman Alpha-numeric
38 * ,-----------------------------------------------------------------------------------------------.
39 * | Q | D | R | W | B | F | U | P | J | 7 | 8 | 9 |
40 * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
41 * | A | S | H | T | G | N | E | O | I | 4 | 5 | 6 |
42 * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
43 * | Z | X | M | C | V | L | Y | K | Up | 1 | 2 | 3 |
44 * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
45 * |Alt/Tab|Gui/Esc| , |CTL/Bsp| Fn/Ent|SFT/SPC| . | Left | Down | Right | 0 |Adj/Ent|
46 * `-----------------------------------------------------------------------------------------------'
50 {KC_Q, KC_D, KC_R, KC_W, KC_B, KC_F, KC_U, KC_P, KC_J, KC_KP_7, KC_KP_8, KC_KP_9},
51 {KC_A, KC_S, KC_H, KC_T, KC_G, KC_N, KC_E, KC_O, KC_I, KC_KP_4, KC_KP_5, KC_KP_6},
52 {KC_Z, KC_X, KC_M, KC_C, KC_V, KC_L, KC_Y, KC_K, KC_UP, KC_KP_1, KC_KP_2, KC_KP_3},
53 {ALT_T(KC_TAB), GUI_T(KC_ESC), KC_COMM, CTL_T(KC_BSPC), LT(_FN, KC_ENT), SFT_T(KC_SPC), KC_DOT, KC_LEFT, KC_DOWN, KC_RGHT, KC_KP_0, LT(_ADJ, KC_ENT)}
56 /* FN-key held (Workman)
57 * ,-----------------------------------------------------------------------------------------------.
58 * | ! | @ | # | $ | % | ^ | & | * | F12 | F7 | F8 | F9 |
59 * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
60 * | Tab | [ | ] | - | Del | ' | ( | ) | F11 | F4 | F5 | F6 |
61 * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
62 * | Menu | | | = | \ | / | | | PgUp | F1 | F2 | F3 |
63 * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
64 * |Alt/Tab| Gui | ~ |CTL/Bsp| Fn/Ent|SFT/Spc| ; | Home | PgDn | End | F10 |Adj/Ent|
65 * `-----------------------------------------------------------------------------------------------'
69 {KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_F12, KC_F7, KC_F8, KC_F9},
70 {KC_TAB, KC_LBRACKET, KC_RBRACKET, KC_MINUS, KC_DELETE, KC_QUOT, KC_LPRN, KC_RPRN, KC_F11, KC_F4, KC_F5, KC_F6},
71 {KC_MENU, _______, _______, KC_EQUAL, KC_BSLS, KC_SLSH, XXXXXXX, XXXXXXX, KC_PGUP, KC_F1, KC_F2, KC_F3},
72 {_______, KC_LGUI, KC_GRAVE, _______, _______, _______, KC_SCOLON, KC_HOME, KC_PGDN, KC_END, KC_F10, _______}
76 * ,-----------------------------------------------------------------------------------------------.
77 * |Gui/Esc| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
78 * |-------+-------+-------+-------+-------+---------------+-------+-------+-------+-------+-------|
79 * | Ctrl | Q | W | E | R | T | Y | U | I | O | P | / |
80 * |-------+-------+-------+-------+-------+---------------+-------+-------+-------+-------+-------|
81 * | Shift | A | S | D | F | G | H | J | K | L | ; | " |
82 * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
83 * |Alt/Tab| Z | X | C | V | Fn/SPC| B | N | M | , | . |Adj/Ent|
84 * `-----------------------------------------------------------------------------------------------'
88 {GUI_T(KC_ESC), KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
89 {KC_LCTL, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_ENT},
90 {KC_LSFT, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
91 {ALT_T(KC_TAB), KC_Z, KC_X, KC_C, KC_V, LT(_QW_FN, KC_SPC), KC_B, KC_N, KC_M, KC_COMM, KC_DOT, LT(_ADJ, KC_ENT)},
94 /* FN-key held (Qwerty)
95 * ,-----------------------------------------------------------------------------------------------.
96 * | Gui | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 |
97 * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
98 * | Ctrl | ~ | [ | PgUp | ] | | | - | Up | = | | F12 |
99 * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
100 * | Shift | Tab | Home | PgDn | End | Del | | Left | Down | Right | | |
101 * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
102 * |Alt/Tab| | | | | Fn/Spc| | | | | Menu |Adj/Ent|
103 * `-----------------------------------------------------------------------------------------------'
107 {KC_LGUI, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11},
108 {_______, KC_GRAVE, KC_LBRC, KC_PGUP, KC_RBRC, XXXXXXX, XXXXXXX, KC_MINS, KC_UP, KC_EQUAL, XXXXXXX, KC_F12},
109 {_______, KC_TAB, KC_HOME, KC_PGDN, KC_END, KC_DELETE, XXXXXXX, KC_LEFT, KC_DOWN, KC_RIGHT, XXXXXXX, XXXXXXX},
110 {_______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX, _______, _______, _______, KC_MENU, _______}
113 /* Plover layer (http://opensteno.org)
114 * ,-----------------------------------------------------------------------------------------------.
115 * | S | T | P | H | * | F | P | L | T | D | | |
116 * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
117 * | S | K | W | R | * | R | B | G | S | Z | | |
118 * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
119 * | # | # | # | # | | # | # | # | # | # | | |
120 * |-------+-------+-------+-------+-------+---------------+-------+-------+-------+-------+-------|
121 * | | | A | O | | E | U | | | | |Adj/Ent|
122 * `-----------------------------------------------------------------------------------------------'
126 {KC_Q, KC_W, KC_E, KC_R, KC_T, KC_U, KC_I, KC_O, KC_P, KC_LBRC, XXXXXXX, XXXXXXX},
127 {KC_A, KC_S, KC_D, KC_F, KC_G, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, XXXXXXX, XXXXXXX},
128 {KC_1, KC_1, KC_1, KC_1, XXXXXXX, KC_1, KC_1, KC_1, KC_1, KC_1, XXXXXXX, XXXXXXX},
129 {XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, LT(_ADJ, KC_ENT)}
133 * ,-----------------------------------------------------------------------------------------------.
134 * | | | | | | | | | Insert| PrtSc | Pause | RESET |
135 * |-------+-------+-------+-------+-------+---------------+-------+-------+-------+-------+-------|
136 * | | | | | | | | CapLk |Voice +| Audio |MIDIoff| |
137 * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
138 * | | | | | | | | ScrLk |Voice -| Music |MIDI on| |
139 * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
140 * | | | | | | | | Numlk |Workman| Qwerty| Plover|Adj/Ent|
141 * `-----------------------------------------------------------------------------------------------'
145 {_______, _______, _______, _______, _______, _______, _______, _______, KC_INS, KC_PSCR, KC_PAUSE, RESET},
146 {_______, _______, _______, _______, _______, _______, _______, KC_CLCK, MUV_IN, AU_TOG, MI_OFF, _______},
147 {_______, _______, _______, _______, _______, _______, _______, KC_SLCK, MUV_DE, MU_TOG, MI_ON, _______},
148 {_______, _______, _______, _______, _______, _______, _______, KC_NLCK, WORKMAN, QWERTY, PLOVER, _______}
155 float tone_startup[][2] = SONG(STARTUP_SOUND);
156 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
158 float tone_workman[][2] = SONG(QWERTY_SOUND);
159 float tone_qwerty[][2] = SONG(COLEMAK_SOUND);
160 float tone_plover[][2] = SONG(PLOVER_SOUND);
162 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
167 void persistent_default_layer_set(uint16_t default_layer) {
168 eeconfig_update_default_layer(default_layer);
169 default_layer_set(default_layer);
172 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
175 if (record->event.pressed) {
177 PLAY_SONG(tone_workman);
179 persistent_default_layer_set(1UL<<_WORKMAN);
184 if (record->event.pressed) {
186 PLAY_SONG(tone_qwerty);
188 persistent_default_layer_set(1UL<<_QWERTY);
193 if (record->event.pressed) {
195 PLAY_SONG(tone_plover);
197 if (!eeconfig_is_enabled()) {
200 keymap_config.raw = eeconfig_read_keymap();
201 keymap_config.nkro = 1;
202 eeconfig_update_keymap(keymap_config.raw);
203 persistent_default_layer_set(1UL<<_PLOVER);
211 void matrix_init_user(void) {
221 _delay_ms(20); // gets rid of tick
222 PLAY_SONG(tone_startup);
227 PLAY_SONG(tone_goodbye);
232 void music_on_user(void)
237 void music_scale_user(void)
239 PLAY_SONG(music_scale);