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.
23 #define _TOUCHCURSOR 6
26 enum planck_keycodes {
37 // Fillers to make layering more clear
38 #define _______ KC_TRNS
42 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
43 #define LT_TC LT(_TOUCHCURSOR, KC_SPC) // L-ayer T-ap T-ouch C-ursor
44 // ^-- Requires KC_TRNS / _______ for the trigger key in the destination layer
45 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
47 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
50 * ,-----------------------------------------------------------------------------------------.
51 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
52 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
53 * | Ctrl/Esc | A | S | D | F | G | H | J | K | L | ; | " |
54 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
55 * | Shift | Z | X | C | V | B | N | M | , | . | / |Sft/Ent |
56 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
57 * | Brite | Ctrl | Alt | GUI |Lower | TC/Space |Raise | Left | Down | Up | Right |
58 * `-----------------------------------------------------------------------------------------'
61 {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
62 {CTL_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
63 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
64 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
68 * ,-----------------------------------------------------------------------------------------.
69 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
70 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
71 * | Ctrl/Esc | A | R | S | T | D | H | N | E | I | O | " |
72 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
73 * | Shift | Z | X | C | V | B | K | M | , | . | / |Sft/Ent |
74 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
75 * | Brite | Ctrl | Alt | GUI |Lower | TC/Space |Raise | Left | Down | Up | Right |
76 * `-----------------------------------------------------------------------------------------'
79 {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
80 {CTL_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
81 {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT},
82 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
86 * ,-----------------------------------------------------------------------------------------.
87 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
88 * |----------+------+------+------+------+-------------+------+------+------+------+--------|
89 * | Ctrl/Esc | A | O | E | U | I | D | H | T | N | S | / |
90 * |----------+------+------+------+------+------|------+------+------+------+------+--------|
91 * | Shift | ; | Q | J | K | X | B | M | W | V | Z |Sft/Ent |
92 * |----------+------+------+------+------+------+------+------+------+------+------+--------|
93 * | Brite | Ctrl | Alt | GUI |Lower | TC/Space |Raise | Left | Down | Up | Right |
94 * `-----------------------------------------------------------------------------------------'
97 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
98 {CTL_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
99 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, SFT_ENT},
100 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, LT_TC, LT_TC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
104 * ,-----------------------------------------------------------------------------------.
105 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
106 * |------+------+------+------+------+-------------+------+------+------+------+------|
107 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
108 * |------+------+------+------+------+------|------+------+------+------+------+------|
109 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | |Enter |
110 * |------+------+------+------+------+------+------+------+------+------+------+------|
111 * | | | | | | | | Next | Vol- | Vol+ | Play |
112 * `-----------------------------------------------------------------------------------'
115 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
116 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
117 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
118 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
122 * ,-----------------------------------------------------------------------------------.
123 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
124 * |------+------+------+------+------+-------------+------+------+------+------+------|
125 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
126 * |------+------+------+------+------+------|------+------+------+------+------+------|
127 * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / | | |Enter |
128 * |------+------+------+------+------+------+------+------+------+------+------+------|
129 * | | | | | | | | Next | Vol- | Vol+ | Play |
130 * `-----------------------------------------------------------------------------------'
133 {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
134 {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
135 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, _______, _______, _______},
136 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
139 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
140 * ,-----------------------------------------------------------------------------------.
141 * | | | |Shift | GUI | ~ |Insert| Home | Up | End | Bksp | |
142 * |------+------+------+------+------+-------------+------+------+------+------+------|
143 | | Alt |Space | | | | PgUp | Left | Down |Right | | |
144 * |------+------+------+------+------+------|------+------+------+------+------+------|
145 | | | | | | ` | PgDn | Del | | | | |
146 * |------+------+------+------+------+------+------+------+------+------+------+------|
147 | | | | | | | | | | | |
148 * `-----------------------------------------------------------------------------------'
152 {_______, _______, _______, KC_LSFT, KC_LGUI, KC_TILD, KC_INS, KC_HOME, KC_UP, KC_END, KC_BSPC, _______},
153 {_______, KC_LALT, KC_SPC, _______, _______, _______, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
154 {_______, _______, _______, _______, _______, KC_GRV, KC_PGDN, KC_DEL, _______, _______, _______, _______},
155 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
158 /* Plover layer (http://opensteno.org)
159 * ,-----------------------------------------------------------------------------------.
160 * | # | # | # | # | # | # | # | # | # | # | # | # |
161 * |------+------+------+------+------+-------------+------+------+------+------+------|
162 * | | S | T | P | H | * | * | F | P | L | T | D |
163 * |------+------+------+------+------+------|------+------+------+------+------+------|
164 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
165 * |------+------+------+------+------+------+------+------+------+------+------+------|
166 * | Exit | | | A | O | | E | U | | | |
167 * `-----------------------------------------------------------------------------------'
171 {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
172 {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
173 {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
174 {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
177 /* Adjust (Lower + Raise)
178 * ,-----------------------------------------------------------------------------------.
179 * | | Reset| | | | | | | | | | Del |
180 * |------+------+------+------+------+-------------+------+------+------+------+------|
181 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
182 * |------+------+------+------+------+------|------+------+------+------+------+------|
183 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
184 * |------+------+------+------+------+------+------+------+------+------+------+------|
185 * | | | | | | | | | | | |
186 * `-----------------------------------------------------------------------------------'
189 {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
190 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
191 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
192 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
200 float tone_startup[][2] = SONG(STARTUP_SOUND);
201 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
202 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
203 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
204 float tone_plover[][2] = SONG(PLOVER_SOUND);
205 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
206 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
208 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
212 void persistant_default_layer_set(uint16_t default_layer) {
213 eeconfig_update_default_layer(default_layer);
214 default_layer_set(default_layer);
217 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
220 if (record->event.pressed) {
222 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
224 persistant_default_layer_set(1UL<<_QWERTY);
229 if (record->event.pressed) {
231 PLAY_NOTE_ARRAY(tone_colemak, false, 0);
233 persistant_default_layer_set(1UL<<_COLEMAK);
238 if (record->event.pressed) {
240 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
242 persistant_default_layer_set(1UL<<_DVORAK);
247 if (record->event.pressed) {
249 update_tri_layer(_LOWER, _RAISE, _ADJUST);
252 update_tri_layer(_LOWER, _RAISE, _ADJUST);
257 if (record->event.pressed) {
259 update_tri_layer(_LOWER, _RAISE, _ADJUST);
262 update_tri_layer(_LOWER, _RAISE, _ADJUST);
267 if (record->event.pressed) {
268 register_code(KC_RSFT);
269 #ifdef BACKLIGHT_ENABLE
273 unregister_code(KC_RSFT);
278 if (record->event.pressed) {
281 PLAY_NOTE_ARRAY(tone_plover, false, 0);
287 if (!eeconfig_is_enabled()) {
290 keymap_config.raw = eeconfig_read_keymap();
291 keymap_config.nkro = 1;
292 eeconfig_update_keymap(keymap_config.raw);
297 if (record->event.pressed) {
299 PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
309 void matrix_init_user(void) {
319 _delay_ms(20); // gets rid of tick
320 PLAY_NOTE_ARRAY(tone_startup, false, 0);
325 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
330 void music_on_user(void)
335 void music_scale_user(void)
337 PLAY_NOTE_ARRAY(music_scale, false, 0);