Commit | Line | Data |
---|---|---|
3f02637f JH |
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. | |
3 | ||
4 | #include "planck.h" | |
5 | #include "action_layer.h" | |
6 | #ifdef AUDIO_ENABLE | |
7 | #include "audio.h" | |
8 | #endif | |
1a8c0dd2 | 9 | |
3f02637f JH |
10 | #include "eeconfig.h" |
11 | ||
12 | extern keymap_config_t keymap_config; | |
13 | ||
14 | // Each layer gets a name for readability, which is then used in the keymap matrix below. | |
15 | // The underscores don't mean anything - you can have a layer called STUFF or any other name. | |
16 | // Layer names don't all need to be of the same length, obviously, and you can also skip them | |
17 | // entirely and just use numbers. | |
18 | #define _QWERTY 0 | |
19 | #define _COLEMAK 1 | |
20 | #define _DVORAK 2 | |
21 | #define _LOWER 3 | |
22 | #define _RAISE 4 | |
15719f35 | 23 | #define _PLOVER 5 |
3f02637f JH |
24 | #define _ADJUST 16 |
25 | ||
7db2ec15 JH |
26 | enum planck_keycodes { |
27 | QWERTY = SAFE_RANGE, | |
28 | COLEMAK, | |
29 | DVORAK, | |
30 | PLOVER, | |
31 | LOWER, | |
32 | RAISE, | |
33 | BACKLIT, | |
34 | EXT_PLV | |
35 | }; | |
3f02637f JH |
36 | |
37 | // Fillers to make layering more clear | |
38 | #define _______ KC_TRNS | |
39 | #define XXXXXXX KC_NO | |
40 | ||
41 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |
42 | ||
43 | /* Qwerty | |
44 | * ,-----------------------------------------------------------------------------------. | |
45 | * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp | | |
46 | * |------+------+------+------+------+-------------+------+------+------+------+------| | |
47 | * | Esc | A | S | D | F | G | H | J | K | L | ; | " | | |
48 | * |------+------+------+------+------+------|------+------+------+------+------+------| | |
49 | * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter | | |
50 | * |------+------+------+------+------+------+------+------+------+------+------+------| | |
51 | * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | | |
52 | * `-----------------------------------------------------------------------------------' | |
53 | */ | |
54 | [_QWERTY] = { | |
55 | {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC}, | |
56 | {KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT}, | |
57 | {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT }, | |
197f152d | 58 | {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT} |
3f02637f JH |
59 | }, |
60 | ||
61 | /* Colemak | |
62 | * ,-----------------------------------------------------------------------------------. | |
63 | * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp | | |
64 | * |------+------+------+------+------+-------------+------+------+------+------+------| | |
65 | * | Esc | A | R | S | T | D | H | N | E | I | O | " | | |
66 | * |------+------+------+------+------+------|------+------+------+------+------+------| | |
67 | * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter | | |
68 | * |------+------+------+------+------+------+------+------+------+------+------+------| | |
69 | * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | | |
70 | * `-----------------------------------------------------------------------------------' | |
71 | */ | |
72 | [_COLEMAK] = { | |
73 | {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC}, | |
74 | {KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT}, | |
75 | {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT }, | |
1a8c0dd2 | 76 | {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT} |
3f02637f JH |
77 | }, |
78 | ||
79 | /* Dvorak | |
80 | * ,-----------------------------------------------------------------------------------. | |
81 | * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp | | |
82 | * |------+------+------+------+------+-------------+------+------+------+------+------| | |
83 | * | Esc | A | O | E | U | I | D | H | T | N | S | / | | |
84 | * |------+------+------+------+------+------|------+------+------+------+------+------| | |
85 | * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter | | |
86 | * |------+------+------+------+------+------+------+------+------+------+------+------| | |
87 | * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | | |
88 | * `-----------------------------------------------------------------------------------' | |
89 | */ | |
90 | [_DVORAK] = { | |
91 | {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC}, | |
92 | {KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH}, | |
93 | {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT }, | |
197f152d | 94 | {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT} |
3f02637f JH |
95 | }, |
96 | ||
97 | /* Lower | |
98 | * ,-----------------------------------------------------------------------------------. | |
99 | * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp | | |
100 | * |------+------+------+------+------+-------------+------+------+------+------+------| | |
101 | * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | | | |
102 | * |------+------+------+------+------+------|------+------+------+------+------+------| | |
fe9b1482 | 103 | * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | |Enter | |
3f02637f JH |
104 | * |------+------+------+------+------+------+------+------+------+------+------+------| |
105 | * | | | | | | | | Next | Vol- | Vol+ | Play | | |
106 | * `-----------------------------------------------------------------------------------' | |
107 | */ | |
108 | [_LOWER] = { | |
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}, | |
fe9b1482 | 111 | {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______}, |
3f02637f JH |
112 | {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY} |
113 | }, | |
114 | ||
115 | /* Raise | |
116 | * ,-----------------------------------------------------------------------------------. | |
117 | * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp | | |
118 | * |------+------+------+------+------+-------------+------+------+------+------+------| | |
119 | * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ | | |
120 | * |------+------+------+------+------+------|------+------+------+------+------+------| | |
fe9b1482 | 121 | * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / | | |Enter | |
3f02637f JH |
122 | * |------+------+------+------+------+------+------+------+------+------+------+------| |
123 | * | | | | | | | | Next | Vol- | Vol+ | Play | | |
124 | * `-----------------------------------------------------------------------------------' | |
125 | */ | |
126 | [_RAISE] = { | |
127 | {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC}, | |
128 | {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS}, | |
fe9b1482 | 129 | {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUHS, _______, _______, _______}, |
3f02637f JH |
130 | {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY} |
131 | }, | |
132 | ||
3f02637f JH |
133 | /* Plover layer (http://opensteno.org) |
134 | * ,-----------------------------------------------------------------------------------. | |
135 | * | # | # | # | # | # | # | # | # | # | # | # | # | | |
136 | * |------+------+------+------+------+-------------+------+------+------+------+------| | |
137 | * | | S | T | P | H | * | * | F | P | L | T | D | | |
138 | * |------+------+------+------+------+------|------+------+------+------+------+------| | |
139 | * | | S | K | W | R | * | * | R | B | G | S | Z | | |
140 | * |------+------+------+------+------+------+------+------+------+------+------+------| | |
141 | * | Exit | | | A | O | | E | U | | | | | |
142 | * `-----------------------------------------------------------------------------------' | |
143 | */ | |
144 | ||
145 | [_PLOVER] = { | |
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_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC}, | |
148 | {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT}, | |
149 | {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX} | |
150 | }, | |
151 | ||
152 | /* Adjust (Lower + Raise) | |
153 | * ,-----------------------------------------------------------------------------------. | |
154 | * | | Reset| | | | | | | | | | Del | | |
155 | * |------+------+------+------+------+-------------+------+------+------+------+------| | |
156 | * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| | | |
157 | * |------+------+------+------+------+------|------+------+------+------+------+------| | |
158 | * | |Voice-|Voice+|Mus on|Musoff| | | | | | | | | |
159 | * |------+------+------+------+------+------+------+------+------+------+------+------| | |
160 | * | | | | | | | | | | | | | |
161 | * `-----------------------------------------------------------------------------------' | |
162 | */ | |
163 | [_ADJUST] = { | |
164 | {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL}, | |
15719f35 | 165 | {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______}, |
fde477a9 | 166 | {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______}, |
3f02637f JH |
167 | {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______} |
168 | } | |
169 | ||
170 | ||
171 | }; | |
172 | ||
173 | const uint16_t PROGMEM fn_actions[] = { | |
174 | ||
175 | }; | |
176 | ||
177 | #ifdef AUDIO_ENABLE | |
3f02637f | 178 | |
77d083ed | 179 | float tone_startup[][2] = SONG(STARTUP_SOUND); |
3f02637f JH |
180 | float tone_qwerty[][2] = SONG(QWERTY_SOUND); |
181 | float tone_dvorak[][2] = SONG(DVORAK_SOUND); | |
182 | float tone_colemak[][2] = SONG(COLEMAK_SOUND); | |
183 | float tone_plover[][2] = SONG(PLOVER_SOUND); | |
184 | float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND); | |
77d083ed | 185 | float music_scale[][2] = SONG(MUSIC_SCALE_SOUND); |
3f02637f | 186 | |
77d083ed | 187 | float tone_goodbye[][2] = SONG(GOODBYE_SOUND); |
3f02637f JH |
188 | #endif |
189 | ||
190 | ||
77d083ed | 191 | |
3f02637f JH |
192 | void persistant_default_layer_set(uint16_t default_layer) { |
193 | eeconfig_update_default_layer(default_layer); | |
194 | default_layer_set(default_layer); | |
195 | } | |
196 | ||
7db2ec15 JH |
197 | |
198 | bool process_record_user(uint16_t keycode, keyrecord_t *record) { | |
199 | switch (keycode) { | |
200 | case QWERTY: | |
3f02637f JH |
201 | if (record->event.pressed) { |
202 | #ifdef AUDIO_ENABLE | |
203 | PLAY_NOTE_ARRAY(tone_qwerty, false, 0); | |
204 | #endif | |
205 | persistant_default_layer_set(1UL<<_QWERTY); | |
206 | } | |
207 | break; | |
7db2ec15 JH |
208 | return false; |
209 | case COLEMAK: | |
3f02637f JH |
210 | if (record->event.pressed) { |
211 | #ifdef AUDIO_ENABLE | |
212 | PLAY_NOTE_ARRAY(tone_colemak, false, 0); | |
213 | #endif | |
214 | persistant_default_layer_set(1UL<<_COLEMAK); | |
215 | } | |
216 | break; | |
7db2ec15 JH |
217 | return false; |
218 | case DVORAK: | |
3f02637f JH |
219 | if (record->event.pressed) { |
220 | #ifdef AUDIO_ENABLE | |
221 | PLAY_NOTE_ARRAY(tone_dvorak, false, 0); | |
222 | #endif | |
223 | persistant_default_layer_set(1UL<<_DVORAK); | |
224 | } | |
225 | break; | |
7db2ec15 JH |
226 | return false; |
227 | case LOWER: | |
3f02637f JH |
228 | if (record->event.pressed) { |
229 | layer_on(_LOWER); | |
fde477a9 | 230 | #ifdef BACKLIGHT_ENABLE |
3f02637f JH |
231 | breathing_speed_set(2); |
232 | breathing_pulse(); | |
fde477a9 | 233 | #endif |
3f02637f JH |
234 | update_tri_layer(_LOWER, _RAISE, _ADJUST); |
235 | } else { | |
236 | layer_off(_LOWER); | |
237 | update_tri_layer(_LOWER, _RAISE, _ADJUST); | |
238 | } | |
239 | break; | |
7db2ec15 JH |
240 | return false; |
241 | case RAISE: | |
3f02637f JH |
242 | if (record->event.pressed) { |
243 | layer_on(_RAISE); | |
fde477a9 | 244 | #ifdef BACKLIGHT_ENABLE |
3f02637f JH |
245 | breathing_speed_set(2); |
246 | breathing_pulse(); | |
fde477a9 | 247 | #endif |
3f02637f JH |
248 | update_tri_layer(_LOWER, _RAISE, _ADJUST); |
249 | } else { | |
250 | layer_off(_RAISE); | |
251 | update_tri_layer(_LOWER, _RAISE, _ADJUST); | |
252 | } | |
253 | break; | |
7db2ec15 JH |
254 | return false; |
255 | case BACKLIT: | |
3f02637f JH |
256 | if (record->event.pressed) { |
257 | register_code(KC_RSFT); | |
258 | #ifdef BACKLIGHT_ENABLE | |
259 | backlight_step(); | |
260 | #endif | |
261 | } else { | |
262 | unregister_code(KC_RSFT); | |
263 | } | |
264 | break; | |
7db2ec15 JH |
265 | return false; |
266 | case PLOVER: | |
3f02637f JH |
267 | if (record->event.pressed) { |
268 | #ifdef AUDIO_ENABLE | |
269 | stop_all_notes(); | |
270 | PLAY_NOTE_ARRAY(tone_plover, false, 0); | |
271 | #endif | |
272 | layer_off(_RAISE); | |
273 | layer_off(_LOWER); | |
274 | layer_off(_ADJUST); | |
3f02637f JH |
275 | layer_on(_PLOVER); |
276 | if (!eeconfig_is_enabled()) { | |
277 | eeconfig_init(); | |
278 | } | |
279 | keymap_config.raw = eeconfig_read_keymap(); | |
280 | keymap_config.nkro = 1; | |
281 | eeconfig_update_keymap(keymap_config.raw); | |
282 | } | |
283 | break; | |
7db2ec15 JH |
284 | return false; |
285 | case EXT_PLV: | |
3f02637f JH |
286 | if (record->event.pressed) { |
287 | #ifdef AUDIO_ENABLE | |
288 | PLAY_NOTE_ARRAY(tone_plover_gb, false, 0); | |
289 | #endif | |
290 | layer_off(_PLOVER); | |
291 | } | |
292 | break; | |
7db2ec15 | 293 | return false; |
3f02637f JH |
294 | |
295 | } | |
7db2ec15 | 296 | return true; |
3f02637f JH |
297 | }; |
298 | ||
299 | void matrix_init_user(void) { | |
300 | #ifdef AUDIO_ENABLE | |
77d083ed | 301 | startup_user(); |
3f02637f JH |
302 | #endif |
303 | } | |
304 | ||
305 | #ifdef AUDIO_ENABLE | |
77d083ed JH |
306 | void startup_user() |
307 | { | |
308 | _delay_ms(20); // gets rid of tick | |
309 | PLAY_NOTE_ARRAY(tone_startup, false, 0); | |
310 | } | |
311 | ||
312 | void shutdown_user() | |
313 | { | |
314 | PLAY_NOTE_ARRAY(tone_goodbye, false, 0); | |
1a8c0dd2 | 315 | _delay_ms(150); |
77d083ed JH |
316 | stop_all_notes(); |
317 | } | |
318 | ||
319 | void music_on_user(void) | |
320 | { | |
321 | music_scale_user(); | |
322 | } | |
323 | ||
324 | void music_scale_user(void) | |
325 | { | |
326 | PLAY_NOTE_ARRAY(music_scale, false, 0); | |
327 | } | |
328 | ||
1a8c0dd2 | 329 | #endif |
3f02637f | 330 | |
1a8c0dd2 | 331 | LEADER_EXTERNS(); |
3f02637f | 332 | |
1a8c0dd2 EZ |
333 | void matrix_scan_user(void) { |
334 | LEADER_DICTIONARY() { | |
335 | leading = false; | |
336 | leader_end(); | |
337 | ||
197f152d JH |
338 | SEQ_ONE_KEY (KC_R) { |
339 | tap_random_base64(); | |
340 | tap_random_base64(); | |
341 | tap_random_base64(); | |
342 | tap_random_base64(); | |
343 | tap_random_base64(); | |
344 | tap_random_base64(); | |
345 | tap_random_base64(); | |
346 | tap_random_base64(); | |
347 | tap_random_base64(); | |
348 | } | |
77d083ed JH |
349 | SEQ_ONE_KEY (KC_V) { |
350 | SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION); | |
351 | } | |
1a8c0dd2 | 352 | SEQ_ONE_KEY(KC_F) { |
d9e4dad0 | 353 | SEND_STRING("if yes\n\tpeanut butter\nelse\n\trice snacks"); |
1a8c0dd2 EZ |
354 | } |
355 | SEQ_TWO_KEYS(KC_A, KC_S) { | |
356 | register_code(KC_H); | |
357 | unregister_code(KC_H); | |
358 | } | |
359 | SEQ_THREE_KEYS(KC_A, KC_S, KC_D) { | |
360 | register_code(KC_LGUI); | |
361 | register_code(KC_S); | |
362 | unregister_code(KC_S); | |
363 | unregister_code(KC_LGUI); | |
3f02637f JH |
364 | } |
365 | } | |
3f02637f | 366 | } |