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 {
36 // Fillers to make layering more clear
37 #define _______ KC_TRNS
41 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
43 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
46 * ,---------------------------------------------------------------------------------------.
47 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
48 * |----------+------+------+------+------+-------------+------+------+------+------+------|
49 * | Ctrl/Esc | A | S | D | F | G | H | J | K | L | ; | " |
50 * |----------+------+------+------+------+------|------+------+------+------+------+------|
51 * | Shift | Z | X | C | V | B | N | M | , | . | / |Enter |
52 * |----------+------+------+------+------+------+------+------+------+------+------+------|
53 * | Brite | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
54 * `---------------------------------------------------------------------------------------'
57 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
58 {CTL_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
59 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
60 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
64 * ,---------------------------------------------------------------------------------------.
65 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
66 * |----------+------+------+------+------+-------------+------+------+------+------+------|
67 * | Ctrl/Esc | A | R | S | T | D | H | N | E | I | O | " |
68 * |----------+------+------+------+------+------|------+------+------+------+------+------|
69 * | Shift | Z | X | C | V | B | K | M | , | . | / |Enter |
70 * |----------+------+------+------+------+------+------+------+------+------+------+------|
71 * | Brite | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
72 * `---------------------------------------------------------------------------------------'
75 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
76 {CTL_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
77 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
78 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
82 * ,---------------------------------------------------------------------------------------.
83 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
84 * |----------+------+------+------+------+-------------+------+------+------+------+------|
85 * | Ctrl/Esc | A | O | E | U | I | D | H | T | N | S | / |
86 * |----------+------+------+------+------+------|------+------+------+------+------+------|
87 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Enter |
88 * |----------+------+------+------+------+------+------+------+------+------+------+------|
89 * | Brite | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
90 * `---------------------------------------------------------------------------------------'
93 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
94 {CTL_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
95 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT },
96 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
100 * ,-----------------------------------------------------------------------------------.
101 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
102 * |------+------+------+------+------+-------------+------+------+------+------+------|
103 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
104 * |------+------+------+------+------+------|------+------+------+------+------+------|
105 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | |Enter |
106 * |------+------+------+------+------+------+------+------+------+------+------+------|
107 * | | | | | | | | Next | Vol- | Vol+ | Play |
108 * `-----------------------------------------------------------------------------------'
111 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
112 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
113 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
114 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
118 * ,-----------------------------------------------------------------------------------.
119 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
120 * |------+------+------+------+------+-------------+------+------+------+------+------|
121 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
122 * |------+------+------+------+------+------|------+------+------+------+------+------|
123 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / | | |Enter |
124 * |------+------+------+------+------+------+------+------+------+------+------+------|
125 * | | | | | | | | Next | Vol- | Vol+ | Play |
126 * `-----------------------------------------------------------------------------------'
129 {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
130 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
131 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, _______, _______, _______},
132 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
135 /* Plover layer (http://opensteno.org)
136 * ,-----------------------------------------------------------------------------------.
137 * | # | # | # | # | # | # | # | # | # | # | # | # |
138 * |------+------+------+------+------+-------------+------+------+------+------+------|
139 * | | S | T | P | H | * | * | F | P | L | T | D |
140 * |------+------+------+------+------+------|------+------+------+------+------+------|
141 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
142 * |------+------+------+------+------+------+------+------+------+------+------+------|
143 * | Exit | | | A | O | | E | U | | | |
144 * `-----------------------------------------------------------------------------------'
148 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
149 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
150 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
151 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
154 /* Adjust (Lower + Raise)
155 * ,-----------------------------------------------------------------------------------.
156 * | | Reset| | | | | | | | | | Del |
157 * |------+------+------+------+------+-------------+------+------+------+------+------|
158 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
159 * |------+------+------+------+------+------|------+------+------+------+------+------|
160 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
161 * |------+------+------+------+------+------+------+------+------+------+------+------|
162 * | | | | | | | | | | | |
163 * `-----------------------------------------------------------------------------------'
166 {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
167 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
168 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
169 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
177 float tone_startup[][2] = SONG(STARTUP_SOUND);
178 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
179 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
180 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
181 float tone_plover[][2] = SONG(PLOVER_SOUND);
182 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
183 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
185 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
189 void persistant_default_layer_set(uint16_t default_layer) {
190 eeconfig_update_default_layer(default_layer);
191 default_layer_set(default_layer);
194 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
197 if (record->event.pressed) {
199 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
201 persistant_default_layer_set(1UL<<_QWERTY);
206 if (record->event.pressed) {
208 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
210 persistant_default_layer_set(1UL<<_COLEMAK);
215 if (record->event.pressed) {
217 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
219 persistant_default_layer_set(1UL<<_DVORAK);
224 if (record->event.pressed) {
226 update_tri_layer(_LOWER, _RAISE, _ADJUST);
229 update_tri_layer(_LOWER, _RAISE, _ADJUST);
234 if (record->event.pressed) {
236 update_tri_layer(_LOWER, _RAISE, _ADJUST);
239 update_tri_layer(_LOWER, _RAISE, _ADJUST);
244 if (record->event.pressed) {
245 register_code(KC_RSFT);
246 #ifdef BACKLIGHT_ENABLE
250 unregister_code(KC_RSFT);
255 if (record->event.pressed) {
258 PLAY_NOTE_ARRAY(tone_plover, false, 0);
264 if (!eeconfig_is_enabled()) {
267 keymap_config.raw = eeconfig_read_keymap();
268 keymap_config.nkro = 1;
269 eeconfig_update_keymap(keymap_config.raw);
274 if (record->event.pressed) {
276 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
286 void matrix_init_user(void) {
296 _delay_ms(20); // gets rid of tick
297 PLAY_NOTE_ARRAY(tone_startup, false, 0);
302 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
307 void music_on_user(void)
312 void music_scale_user(void)
314 PLAY_NOTE_ARRAY(music_scale, false, 0);