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"
13 extern keymap_config_t keymap_config;
15 // Each layer gets a name for readability, which is then used in the keymap matrix below.
16 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
17 // Layer names don't all need to be of the same length, obviously, and you can also skip them
18 // entirely and just use numbers.
27 enum planck_keycodes {
46 // Fillers to make layering more clear
47 #define _______ KC_TRNS
50 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
52 {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
53 {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
54 {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
55 {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL}
59 ,-----------------------------------------------------------------------------------.
60 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
61 * |------+------+------+------+------+-------------+------+------+------+------+------|
62 * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
63 * |------+------+------+------+------+------|------+------+------+------+------+------|
64 * | Shift| Z | X | C | V | B | N | M |, | . | / |Enter |
65 * |------+------+------+------+------+------+------+------+------+------+------+------|
66 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
67 * `-----------------------------------------------------------------------------------'
70 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
71 {KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
72 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
73 {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_FN0, KC_FN0, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
77 * ,-----------------------------------------------------------------------------------.
78 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
79 * |------+------+------+------+------+-------------+------+------+------+------+------|
80 * | Esc | A | R | S | T | D | H | N | E | I | O | " |
81 * |------+------+------+------+------+------|------+------+------+------+------+------|
82 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
83 * |------+------+------+------+------+------+------+------+------+------+------+------|
84 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
85 * `-----------------------------------------------------------------------------------'
88 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
89 {KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
90 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
91 {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_FN0, KC_FN0, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
95 * ,-----------------------------------------------------------------------------------.
96 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
97 * |------+------+------+------+------+-------------+------+------+------+------+------|
98 * | Esc | A | O | E | U | I | D | H | T | N | S | / |
99 * |------+------+------+------+------+------|------+------+------+------+------+------|
100 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
101 * |------+------+------+------+------+------+------+------+------+------+------+------|
102 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
103 * `-----------------------------------------------------------------------------------'
106 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
107 {KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
108 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT },
109 {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_FN0, KC_FN0, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
113 * ,-----------------------------------------------------------------------------------.
114 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
115 * |------+------+------+------+------+-------------+------+------+------+------+------|
116 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
117 * |------+------+------+------+------+------|------+------+------+------+------+------|
118 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | |Enter |
119 * |------+------+------+------+------+------+------+------+------+------+------+------|
120 * | | | | | | | | Next | Vol- | Vol+ | Play |
121 * `-----------------------------------------------------------------------------------'
124 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
125 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
126 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
127 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
131 * ,-----------------------------------------------------------------------------------.
132 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
133 * |------+------+------+------+------+-------------+------+------+------+------+------|
134 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
135 * |------+------+------+------+------+------|------+------+------+------+------+------|
136 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / | | |Enter |
137 * |------+------+------+------+------+------+------+------+------+------+------+------|
138 * | | | | | | | | Next | Vol- | Vol+ | Play |
139 * `-----------------------------------------------------------------------------------'
142 {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
143 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
144 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUHS, _______, _______, _______},
145 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
148 /* Plover layer (http://opensteno.org)
149 * ,-----------------------------------------------------------------------------------.
150 * | # | # | # | # | # | # | # | # | # | # | # | # |
151 * |------+------+------+------+------+-------------+------+------+------+------+------|
152 * | | S | T | P | H | * | * | F | P | L | T | D |
153 * |------+------+------+------+------+------|------+------+------+------+------+------|
154 * | | S | K | W | R | * | * | R | B | G | S | Z |
155 * |------+------+------+------+------+------+------+------+------+------+------+------|
156 * | Exit | | | A | O | | E | U | | | |
157 * `-----------------------------------------------------------------------------------'
161 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
162 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
163 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
164 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
167 /* Adjust (Lower + Raise)
168 * ,-----------------------------------------------------------------------------------.
169 * | | Reset| | | | | | | | | | Del |
170 * |------+------+------+------+------+-------------+------+------+------+------+------|
171 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
172 * |------+------+------+------+------+------|------+------+------+------+------+------|
173 * | |Voice-|Voice+|Mus on|Musoff| | | | | | | |
174 * |------+------+------+------+------+------+------+------+------+------+------+------|
175 * | | | | | | | | | | | |
176 * `-----------------------------------------------------------------------------------'
179 {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
180 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
181 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
182 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
188 const uint16_t PROGMEM fn_actions[] = {
189 ACTION_SWAP_HANDS_TAP_KEY(KC_SPC),
194 float tone_startup[][2] = SONG(STARTUP_SOUND);
195 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
196 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
197 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
198 float tone_plover[][2] = SONG(PLOVER_SOUND);
199 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
200 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
202 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
207 void persistant_default_layer_set(uint16_t default_layer) {
208 eeconfig_update_default_layer(default_layer);
209 default_layer_set(default_layer);
213 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
216 if (record->event.pressed) {
218 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
220 persistant_default_layer_set(1UL<<_QWERTY);
225 if (record->event.pressed) {
227 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
229 persistant_default_layer_set(1UL<<_COLEMAK);
234 if (record->event.pressed) {
236 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
238 persistant_default_layer_set(1UL<<_DVORAK);
243 if (record->event.pressed) {
245 #ifdef BACKLIGHT_ENABLE
246 breathing_speed_set(2);
249 update_tri_layer(_LOWER, _RAISE, _ADJUST);
252 update_tri_layer(_LOWER, _RAISE, _ADJUST);
257 if (record->event.pressed) {
259 #ifdef BACKLIGHT_ENABLE
260 breathing_speed_set(2);
263 update_tri_layer(_LOWER, _RAISE, _ADJUST);
266 update_tri_layer(_LOWER, _RAISE, _ADJUST);
271 if (record->event.pressed) {
272 register_code(KC_RSFT);
273 #ifdef BACKLIGHT_ENABLE
277 unregister_code(KC_RSFT);
282 if (record->event.pressed) {
285 PLAY_NOTE_ARRAY(tone_plover, false, 0);
291 if (!eeconfig_is_enabled()) {
294 keymap_config.raw = eeconfig_read_keymap();
295 keymap_config.nkro = 1;
296 eeconfig_update_keymap(keymap_config.raw);
301 if (record->event.pressed) {
303 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
312 if (record->event.pressed) {
317 case RGBLED_INCREASE_HUE:
318 if (record->event.pressed) {
319 rgblight_increase_hue();
323 case RGBLED_DECREASE_HUE:
324 if (record->event.pressed) {
325 rgblight_decrease_hue();
329 case RGBLED_INCREASE_SAT:
330 if (record->event.pressed) {
331 rgblight_increase_sat();
335 case RGBLED_DECREASE_SAT:
336 if (record->event.pressed) {
337 rgblight_decrease_sat();
341 case RGBLED_INCREASE_VAL:
342 if (record->event.pressed) {
343 rgblight_increase_val();
347 case RGBLED_DECREASE_VAL:
348 if (record->event.pressed) {
349 rgblight_decrease_val();
353 case RGBLED_STEP_MODE:
354 if (record->event.pressed) {
365 void matrix_init_user(void) {
374 _delay_ms(20); // gets rid of tick
375 PLAY_NOTE_ARRAY(tone_startup, false, 0);
380 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
385 void music_on_user(void)
390 void music_scale_user(void)
392 PLAY_NOTE_ARRAY(music_scale, false, 0);
399 void matrix_scan_user(void) {
400 LEADER_DICTIONARY() {
416 SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
419 SEND_STRING("if yes\n\tpeanut butter\nelse\n\trice snacks");
421 SEQ_TWO_KEYS(KC_A, KC_S) {
423 unregister_code(KC_H);
425 SEQ_THREE_KEYS(KC_A, KC_S, KC_D) {
426 register_code(KC_LGUI);
428 unregister_code(KC_S);
429 unregister_code(KC_LGUI);