2020 February 29 Breaking Changes Update (#8064)
[jackhill/qmk/firmware.git] / keyboards / planck / keymaps / smt / keymap.c
1 #include QMK_KEYBOARD_H
2
3 extern keymap_config_t keymap_config;
4
5 // Each layer gets a name for readability, which is then used in the keymap matrix below.
6 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
7 // Layer names don't all need to be of the same length, obviously, and you can also skip them
8 // entirely and just use numbers.
9 #define _QWERTY 0
10 #define _COLEMAK 1
11 #define _DVORAK 2
12 #define _LOWER 3
13 #define _RAISE 4
14 #define _ADJUST 16
15
16 enum planck_keycodes {
17 QWERTY = SAFE_RANGE,
18 COLEMAK,
19 DVORAK,
20 LOWER,
21 RAISE,
22 BACKLIT
23 };
24
25 // Custom macros
26 #define CTL_ESC CTL_T(KC_ESC) // Tap for Esc, hold for Ctrl
27 #define SFT_ENT SFT_T(KC_ENT) // Tap for Enter, hold for Shift
28 #define HPR_TAB ALL_T(KC_TAB) // Tap for Tab, hold for Hyper (Super+Ctrl+Alt+Shift)
29 #define MEH_GRV MEH_T(KC_GRV) // Tap for Backtick, hold for Meh (Ctrl+Alt+Shift)
30
31 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
32
33 /* Qwerty
34 * ,-----------------------------------------------------------------------------------.
35 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
36 * |------+------+------+------+------+-------------+------+------+------+------+------|
37 * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
38 * |------+------+------+------+------+------|------+------+------+------+------+------|
39 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
40 * |------+------+------+------+------+------+------+------+------+------+------+------|
41 * | ` | Ctrl | Alt | GUI |Lower |Space |Space |Raise | Left | Down | Up |Right |
42 * `-----------------------------------------------------------------------------------'
43 */
44 [_QWERTY] = LAYOUT_planck_grid(
45 HPR_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
46 CTL_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
47 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT,
48 MEH_GRV, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
49 ),
50
51 /* Colemak
52 * ,-----------------------------------------------------------------------------------.
53 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
54 * |------+------+------+------+------+-------------+------+------+------+------+------|
55 * | Esc | A | R | S | T | D | H | N | E | I | O | " |
56 * |------+------+------+------+------+------|------+------+------+------+------+------|
57 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
58 * |------+------+------+------+------+------+------+------+------+------+------+------|
59 * | ` | Ctrl | Alt | GUI |Lower |Space |Space |Raise | Left | Down | Up |Right |
60 * `-----------------------------------------------------------------------------------'
61 */
62 [_COLEMAK] = LAYOUT_planck_grid(
63 HPR_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
64 CTL_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
65 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_ENT,
66 MEH_GRV, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
67 ),
68
69 /* Dvorak
70 * ,-----------------------------------------------------------------------------------.
71 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
72 * |------+------+------+------+------+-------------+------+------+------+------+------|
73 * | Esc | A | O | E | U | I | D | H | T | N | S | - |
74 * |------+------+------+------+------+------|------+------+------+------+------+------|
75 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
76 * |------+------+------+------+------+------+------+------+------+------+------+------|
77 * | ` | Ctrl | Alt | GUI |Lower |Space |Space |Raise | Left | Down | Up |Right |
78 * `-----------------------------------------------------------------------------------'
79 */
80 [_DVORAK] = LAYOUT_planck_grid(
81 HPR_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
82 CTL_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_MINS,
83 KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, SFT_ENT,
84 MEH_GRV, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
85 ),
86
87 /* Lower
88 * ,-----------------------------------------------------------------------------------.
89 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
90 * |------+------+------+------+------+-------------+------+------+------+------+------|
91 * | $ | F1 | F2 | F3 | F4 | F5 | F6 | 4 | 5 | 6 | | |
92 * |------+------+------+------+------+------|------+------+------+------+------+------|
93 * | | F7 | F8 | F9 | F10 | F11 | F12 | 1 | 2 | 3 | | |
94 * |------+------+------+------+------+------+------+------+------+------+------+------|
95 * | | | | | | | | Next | Vol- | Vol+ | Play |
96 * `-----------------------------------------------------------------------------------'
97 */
98 [_LOWER] = LAYOUT_planck_grid(
99 ALL_T(KC_0), KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL,
100 CTL_T(KC_DLR), KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_4, KC_5, KC_6, _______, _______,
101 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_1, KC_2, KC_3, _______, _______,
102 _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
103 ),
104
105 /* Raise
106 * ,-----------------------------------------------------------------------------------.
107 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del |
108 * |------+------+------+------+------+-------------+------+------+------+------+------|
109 * | | | | | | | _ | ? | + | { | } | | |
110 * |------+------+------+------+------+------|------+------+------+------+------+------|
111 * | | | | | | | - | / | = | [ | ] | \ |
112 * |------+------+------+------+------+------+------+------+------+------+------+------|
113 * | | | | | | | | | Home |PageDn|PageUp| End |
114 * `-----------------------------------------------------------------------------------'
115 */
116 [_RAISE] = LAYOUT_planck_grid(
117 ALL_T(KC_TILD), KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL,
118 _______, _______, _______, _______, _______, _______, KC_UNDS, KC_QUES, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
119 _______, _______, _______, _______, _______, _______, KC_MINS, KC_SLSH, KC_EQL, KC_LBRC, KC_RBRC, SFT_T(KC_BSLS),
120 _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END
121 ),
122
123 /* Adjust (Lower + Raise)
124 * ,-----------------------------------------------------------------------------------.
125 * | | Reset| | | | | | | | | | Reset|
126 * |------+------+------+------+------+-------------+------+------+------+------+------|
127 * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak| | |
128 * |------+------+------+------+------+------|------+------+------+------+------+------|
129 * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
130 * |------+------+------+------+------+------+------+------+------+------+------+------|
131 * | | | | | | | | | | | |
132 * `-----------------------------------------------------------------------------------'
133 */
134 [_ADJUST] = LAYOUT_planck_grid(
135 _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET,
136 _______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, _______, _______,
137 _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______,
138 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
139 )
140
141
142 };
143
144 #ifdef AUDIO_ENABLE
145
146 float tone_startup[][2] = SONG(STARTUP_SOUND);
147 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
148 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
149 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
150 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
151
152 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
153 #endif
154
155
156 void persistent_default_layer_set(uint16_t default_layer) {
157 eeconfig_update_default_layer(default_layer);
158 default_layer_set(default_layer);
159 }
160
161 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
162 switch (keycode) {
163 case QWERTY:
164 if (record->event.pressed) {
165 #ifdef AUDIO_ENABLE
166 PLAY_SONG(tone_qwerty);
167 #endif
168 persistent_default_layer_set(1UL<<_QWERTY);
169 }
170 return false;
171 break;
172 case COLEMAK:
173 if (record->event.pressed) {
174 #ifdef AUDIO_ENABLE
175 PLAY_SONG(tone_colemak);
176 #endif
177 persistent_default_layer_set(1UL<<_COLEMAK);
178 }
179 return false;
180 break;
181 case DVORAK:
182 if (record->event.pressed) {
183 #ifdef AUDIO_ENABLE
184 PLAY_SONG(tone_dvorak);
185 #endif
186 persistent_default_layer_set(1UL<<_DVORAK);
187 }
188 return false;
189 break;
190 case LOWER:
191 if (record->event.pressed) {
192 layer_on(_LOWER);
193 update_tri_layer(_LOWER, _RAISE, _ADJUST);
194 } else {
195 layer_off(_LOWER);
196 update_tri_layer(_LOWER, _RAISE, _ADJUST);
197 }
198 return false;
199 break;
200 case RAISE:
201 if (record->event.pressed) {
202 layer_on(_RAISE);
203 update_tri_layer(_LOWER, _RAISE, _ADJUST);
204 } else {
205 layer_off(_RAISE);
206 update_tri_layer(_LOWER, _RAISE, _ADJUST);
207 }
208 return false;
209 break;
210 case BACKLIT:
211 if (record->event.pressed) {
212 register_code(KC_RSFT);
213 #ifdef BACKLIGHT_ENABLE
214 backlight_step();
215 #endif
216 } else {
217 unregister_code(KC_RSFT);
218 }
219 return false;
220 break;
221 }
222 return true;
223 }
224
225 void matrix_init_user(void) {
226 #ifdef AUDIO_ENABLE
227 startup_user();
228 #endif
229 }
230
231 #ifdef AUDIO_ENABLE
232
233 void startup_user()
234 {
235 _delay_ms(20); // gets rid of tick
236 PLAY_SONG(tone_startup);
237 }
238
239 void shutdown_user()
240 {
241 PLAY_SONG(tone_goodbye);
242 _delay_ms(150);
243 stop_all_notes();
244 }
245
246 void music_on_user(void)
247 {
248 music_scale_user();
249 }
250
251 void music_scale_user(void)
252 {
253 PLAY_SONG(music_scale);
254 }
255
256 #endif