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] = {
44 * ,-----------------------------------------------------------------------------------.
45 * | Tab | Q | D | R | W | B | J | F | U | P | ; | Bksp |
46 * |------+------+------+------+------+-------------+------+------+------+------+------|
47 * | Esc | A | S | H | T | G | Y | N | E | O | I | " |
48 * |------+------+------+------+------+------|------+------+------+------+------+------|
49 * | Shift| Z | X | M | C | V | K | L | Dead | . | / |Enter |
50 * |------+------+------+------+------+------+------+------+------+------+------+------|
51 * | Ctrl | RAlt | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
52 * `-----------------------------------------------------------------------------------'
55 {KC_TAB, KC_Q, KC_D, KC_R, KC_W, KC_B, KC_J, KC_F, KC_U, KC_P, KC_SCLN, KC_BSPC},
56 {MT(MOD_LCTL,KC_ESC), KC_A, KC_S, KC_H, KC_T, KC_G, KC_Y, KC_N, KC_E, KC_O, KC_I, KC_QUOT},
57 {KC_LSFT, KC_Z, KC_X, KC_M, KC_C, KC_V, KC_K, KC_L, DEAD, KC_DOT, KC_SLSH, KC_ENT},
58 {KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
62 * ,-----------------------------------------------------------------------------------.
63 * | | % | & | ? | + | @ | $ | _ | [ | ] | ! | |
64 * |------+------+------+------+------+-------------+------+------+------+------+------|
65 * | | / | ( | = | 0 | { | } | 1 | * | ) | - | " |
66 * |------+------+------+------+------+------|------+------+------+------+------+------|
67 * | | 6 | 7 | 8 | 9 | | | \ | 2 | 3 | 4 | 5 | |
68 * |------+------+------+------+------+------+------+------+------+------+------+------|
69 * | | | < | ~ | ` | , | # | ^ | > | | |
70 * `-----------------------------------------------------------------------------------'
73 {XXXXXXX, KC_PERC, KC_AMPR, KC_QUES, KC_PLUS, KC_AT, KC_DLR, KC_UNDS, KC_LBRC, KC_RBRC, KC_EXLM, XXXXXXX},
74 {XXXXXXX, KC_SLSH, KC_LPRN, KC_EQL, KC_0, KC_LCBR, KC_RCBR, KC_1, KC_ASTR, KC_RPRN, KC_MINS, XXXXXXX},
75 {XXXXXXX, KC_6, KC_7, KC_8, KC_9, KC_PIPE, KC_BSLS, KC_2, KC_3, KC_4, KC_5, XXXXXXX},
76 {XXXXXXX, XXXXXXX, KC_LT, KC_TILD, KC_GRV, KC_COMM, KC_COMM, KC_HASH, KC_CIRC, KC_GT, XXXXXXX, XXXXXXX}
80 * ,-----------------------------------------------------------------------------------.
81 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
82 * |------+------+------+------+------+-------------+------+------+------+------+------|
83 * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
84 * |------+------+------+------+------+------|------+------+------+------+------+------|
85 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
86 * |------+------+------+------+------+------+------+------+------+------+------+------|
87 * | Ctrl | RAlt | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
88 * `-----------------------------------------------------------------------------------'
91 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
92 {KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
93 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
94 {KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
98 * ,-----------------------------------------------------------------------------------.
99 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
100 * |------+------+------+------+------+-------------+------+------+------+------+------|
101 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
102 * |------+------+------+------+------+------|------+------+------+------+------+------|
103 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | Vol+ |Enter |
104 * |------+------+------+------+------+------+------+------+------+------+------+------|
105 * | | | | | | | | Prev | Next | Vol- | Play |
106 * `-----------------------------------------------------------------------------------'
109 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
110 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
111 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS), _______, KC_VOLU, _______},
112 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MNXT, KC_VOLD, KC_MPLY}
115 /* Raise - KWM Interaction
116 * ,-----------------------------------------------------------------------------------.
117 * |Restrt| |TgSplt|Flotng|Parent|FlScrn|InsMrk| InsW | InsS | InsN | InsE | |
118 * |------+------+------+------+------+-------------+------+------+------+------+------|
119 * | | Mark |Rotate|Prefix| Term | BSP |SwpMrk|SwapW |SwapS |SwapN |SwapE | |
120 * |------+------+------+------+------+------|------+------+------+------+------+------|
121 * | |MarkW |MarkS |MarkN |MarkE |Monocl|Float |FocusW|FocusS|FocusN|FocusE| |
122 * |------+------+------+------+------+------+------+------+------+------+------+------|
123 * | | | | | | | | | | | |
124 * `-----------------------------------------------------------------------------------'
127 {LCAG(KC_Q), XXXXXXX, LCAG(KC_S), LCAG(KC_W), LCAG(KC_D), LCAG(KC_F), LCTL(S(KC_X)), LCTL(S(KC_H)), LCTL(S(KC_J)), LCTL(S(KC_K)), LCTL(S(KC_L)), XXXXXXX},
128 {XXXXXXX, LCAG(KC_M), LGUI(LCTL(KC_R)), LCAG(KC_DOT), LCAG(KC_T), LGUI(LCTL(KC_A)), LCTL(LALT(KC_M)), LCTL(LALT(KC_H)), LCTL(LALT(KC_J)), LCTL(LALT(KC_K)), LCTL(LALT(KC_L)), XXXXXXX},
129 {_______, LCAG(KC_H), LCAG(KC_J), LCAG(KC_K), LCAG(KC_L), LGUI(LCTL(KC_S)), LGUI(LCTL(KC_D)), LGUI(LALT(KC_H)), LGUI(LALT(KC_J)), LGUI(LALT(KC_K)), LGUI(LALT(KC_L)), _______},
130 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
133 /* Plover layer (http://opensteno.org)
134 * ,-----------------------------------------------------------------------------------.
135 * | # | # | # | # | # | # | # | # | # | # | # | # |
136 * |------+------+------+------+------+-------------+------+------+------+------+------|
137 * | | S | T | P | H | * | * | F | P | L | T | D |
138 * |------+------+------+------+------+------|------+------+------+------+------+------|
139 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
140 * |------+------+------+------+------+------+------+------+------+------+------+------|
141 * | Exit | | | A | O | | E | U | | | |
142 * `-----------------------------------------------------------------------------------'
146 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
147 {XXXXXXX, KC_Q, KC_D, KC_R, KC_W, KC_B, KC_J, KC_F, KC_U, KC_P, KC_SCLN, KC_BSPC},
148 {TOG_PLV, KC_A, KC_S, KC_H, KC_T, KC_G, KC_Y, KC_N, KC_E, KC_O, KC_I, KC_QUOT},
149 {EXT_PLV, XXXXXXX, XXXXXXX, KC_M, KC_C, XXXXXXX, XXXXXXX, KC_L, KC_COMM, XXXXXXX, XXXXXXX, XXXXXXX}
152 /* Adjust (Lower + Raise)
153 * ,-----------------------------------------------------------------------------------.
154 * | | Reset| | | | | | | | | | Del |
155 * |------+------+------+------+------+-------------+------+------+------+------+------|
156 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Workmn|Plover| | |
157 * |------+------+------+------+------+------|------+------+------+------+------+------|
158 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
159 * |------+------+------+------+------+------+------+------+------+------+------+------|
160 * | | | | | | | | | | | |
161 * `-----------------------------------------------------------------------------------'
164 {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
165 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, WORKMAN, PLOVER, _______, _______},
166 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
167 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
175 float tone_startup[][2] = SONG(STARTUP_SOUND);
176 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
177 float tone_workman[][2] = SONG(WORKMAN_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 persistent_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_workman, false, 0);
198 persistent_default_layer_set(1UL<<_WORKMAN);
203 if (record->event.pressed) {
205 set_oneshot_layer(_DEAD, ONESHOT_START);
206 clear_oneshot_layer_state(ONESHOT_PRESSED);
211 if (record->event.pressed) {
213 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
215 persistent_default_layer_set(1UL<<_QWERTY);
220 if (record->event.pressed) {
222 update_tri_layer(_LOWER, _RAISE, _ADJUST);
225 update_tri_layer(_LOWER, _RAISE, _ADJUST);
230 if (record->event.pressed) {
232 update_tri_layer(_LOWER, _RAISE, _ADJUST);
235 update_tri_layer(_LOWER, _RAISE, _ADJUST);
240 if (record->event.pressed) {
243 PLAY_NOTE_ARRAY(tone_plover, false, 0);
249 if (!eeconfig_is_enabled()) {
252 keymap_config.raw = eeconfig_read_keymap();
253 keymap_config.nkro = 1;
254 eeconfig_update_keymap(keymap_config.raw);
259 if (record->event.pressed) {
261 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
268 if (record->event.pressed) {
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);