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
40 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
43 * ,-----------------------------------------------------------------------------------.
44 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
45 * |------+------+------+------+------+-------------+------+------+------+------+------|
46 * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
47 * |------+------+------+------+------+------|------+------+------+------+------+------|
48 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
49 * |------+------+------+------+------+------+------+------+------+------+------+------|
50 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
51 * `-----------------------------------------------------------------------------------'
54 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
55 {KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
56 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
57 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
61 * ,-----------------------------------------------------------------------------------.
62 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
63 * |------+------+------+------+------+-------------+------+------+------+------+------|
64 * | Esc | A | R | S | T | D | H | N | E | I | O | " |
65 * |------+------+------+------+------+------|------+------+------+------+------+------|
66 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
67 * |------+------+------+------+------+------+------+------+------+------+------+------|
68 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
69 * `-----------------------------------------------------------------------------------'
72 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
73 {KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
74 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
75 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
79 * ,-----------------------------------------------------------------------------------.
80 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
81 * |------+------+------+------+------+-------------+------+------+------+------+------|
82 * | Esc | A | O | E | U | I | D | H | T | N | S | / |
83 * |------+------+------+------+------+------|------+------+------+------+------+------|
84 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
85 * |------+------+------+------+------+------+------+------+------+------+------+------|
86 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
87 * `-----------------------------------------------------------------------------------'
90 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
91 {KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
92 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT },
93 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
97 * ,-----------------------------------------------------------------------------------.
98 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
99 * |------+------+------+------+------+-------------+------+------+------+------+------|
100 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
101 * |------+------+------+------+------+------|------+------+------+------+------+------|
102 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | |Enter |
103 * |------+------+------+------+------+------+------+------+------+------+------+------|
104 * | | | | | | | | Next | Vol- | Vol+ | Play |
105 * `-----------------------------------------------------------------------------------'
108 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
109 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
110 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
111 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
115 * ,-----------------------------------------------------------------------------------.
116 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
117 * |------+------+------+------+------+-------------+------+------+------+------+------|
118 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
119 * |------+------+------+------+------+------|------+------+------+------+------+------|
120 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / | | |Enter |
121 * |------+------+------+------+------+------+------+------+------+------+------+------|
122 * | | | | | | | | Next | Vol- | Vol+ | Play |
123 * `-----------------------------------------------------------------------------------'
126 {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
127 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
128 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, _______, _______, _______},
129 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
132 /* Plover layer (http://opensteno.org)
133 * ,-----------------------------------------------------------------------------------.
134 * | # | # | # | # | # | # | # | # | # | # | # | # |
135 * |------+------+------+------+------+-------------+------+------+------+------+------|
136 * | | S | T | P | H | * | * | F | P | L | T | D |
137 * |------+------+------+------+------+------|------+------+------+------+------+------|
138 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
139 * |------+------+------+------+------+------+------+------+------+------+------+------|
140 * | Exit | | | A | O | | E | U | | | |
141 * `-----------------------------------------------------------------------------------'
145 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
146 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
147 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
148 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
151 /* Adjust (Lower + Raise)
152 * ,-----------------------------------------------------------------------------------.
153 * | | Reset| | | | | | | | | | Del |
154 * |------+------+------+------+------+-------------+------+------+------+------+------|
155 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
156 * |------+------+------+------+------+------|------+------+------+------+------+------|
157 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
158 * |------+------+------+------+------+------+------+------+------+------+------+------|
159 * | | | | | | | | | | | |
160 * `-----------------------------------------------------------------------------------'
163 {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
164 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
165 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
166 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
174 float tone_startup[][2] = SONG(STARTUP_SOUND);
175 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
176 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
177 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
178 float tone_plover[][2] = SONG(PLOVER_SOUND);
179 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
180 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
182 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
186 void persistant_default_layer_set(uint16_t default_layer) {
187 eeconfig_update_default_layer(default_layer);
188 default_layer_set(default_layer);
191 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
194 if (record->event.pressed) {
196 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
198 persistant_default_layer_set(1UL<<_QWERTY);
203 if (record->event.pressed) {
205 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
207 persistant_default_layer_set(1UL<<_COLEMAK);
212 if (record->event.pressed) {
214 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
216 persistant_default_layer_set(1UL<<_DVORAK);
221 if (record->event.pressed) {
223 update_tri_layer(_LOWER, _RAISE, _ADJUST);
226 update_tri_layer(_LOWER, _RAISE, _ADJUST);
231 if (record->event.pressed) {
233 update_tri_layer(_LOWER, _RAISE, _ADJUST);
236 update_tri_layer(_LOWER, _RAISE, _ADJUST);
241 if (record->event.pressed) {
242 register_code(KC_RSFT);
243 #ifdef BACKLIGHT_ENABLE
247 unregister_code(KC_RSFT);
252 if (record->event.pressed) {
255 PLAY_NOTE_ARRAY(tone_plover, false, 0);
261 if (!eeconfig_is_enabled()) {
264 keymap_config.raw = eeconfig_read_keymap();
265 keymap_config.nkro = 1;
266 eeconfig_update_keymap(keymap_config.raw);
271 if (record->event.pressed) {
273 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
283 void matrix_init_user(void) {
293 _delay_ms(20); // gets rid of tick
294 PLAY_NOTE_ARRAY(tone_startup, false, 0);
299 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
304 void music_on_user(void)
309 void music_scale_user(void)
311 PLAY_NOTE_ARRAY(music_scale, false, 0);