2020 February 29 Breaking Changes Update (#8064)
[jackhill/qmk/firmware.git] / keyboards / planck / keymaps / chance / keymap.c
CommitLineData
1a8042ae 1
26eef35f 2#include QMK_KEYBOARD_H
1a8042ae 3
4extern keymap_config_t keymap_config;
5
6// Each layer gets a name for readability, which is then used in the keymap matrix below.
7// The underscores don't mean anything - you can have a layer called STUFF or any other name.
8// Layer names don't all need to be of the same length, obviously, and you can also skip them
9// entirely and just use numbers.
10#define _QWERTY 0
11#define _COLEMAK 1
12#define _DVORAK 2
13#define _LOWER 3
14#define _RAISE 4
15#define _PLOVER 5
16#define _NUMPAD 6
17#define _ADJUST 16
18
19enum planck_keycodes {
20 QWERTY = SAFE_RANGE,
21 NUMPAD,
22 EXT_NUM,
23 COLEMAK,
24 DVORAK,
25 PLOVER,
26 LOWER,
27 RAISE,
28 BACKLIT,
29 EXT_PLV
30};
31
1a8042ae 32const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
33
34/* Qwerty
35 * ,-----------------------------------------------------------------------------------.
36 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
37 * |------+------+------+------+------+-------------+------+------+------+------+------|
38 * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
39 * |------+------+------+------+------+------|------+------+------+------+------+------|
40 * | Shift| Z | X | C | V | B | N | M | , | . | / |En/sh |
41 * |------+------+------+------+------+------+------+------+------+------+------+------|
42 * | Ctrl | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
43 * `-----------------------------------------------------------------------------------'
44 */
26eef35f
JY
45[_QWERTY] = LAYOUT_planck_grid(
46 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
47 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
48 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, F(0) ,
49 KC_LCTRL,KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
50),
1a8042ae 51
52/* Colemak
53 * ,-----------------------------------------------------------------------------------.
54 * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
55 * |------+------+------+------+------+-------------+------+------+------+------+------|
56 * | Esc | A | R | S | T | D | H | N | E | I | O | " |
57 * |------+------+------+------+------+------|------+------+------+------+------+------|
58 * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
59 * |------+------+------+------+------+------+------+------+------+------+------+------|
60 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
61 * `-----------------------------------------------------------------------------------'
62 */
26eef35f
JY
63[_COLEMAK] = LAYOUT_planck_grid(
64 KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
65 KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
66 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
67 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
68),
1a8042ae 69
70/* Dvorak
71 * ,-----------------------------------------------------------------------------------.
72 * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
73 * |------+------+------+------+------+-------------+------+------+------+------+------|
74 * | Esc | A | O | E | U | I | D | H | T | N | S | / |
75 * |------+------+------+------+------+------|------+------+------+------+------+------|
76 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
77 * |------+------+------+------+------+------+------+------+------+------+------+------|
78 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
79 * `-----------------------------------------------------------------------------------'
80 */
26eef35f
JY
81[_DVORAK] = LAYOUT_planck_grid(
82 KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
83 KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH,
84 KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT ,
85 BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
86),
1a8042ae 87
88/* Lower
89 * ,-----------------------------------------------------------------------------------.
90 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
91 * |------+------+------+------+------+-------------+------+------+------+------+------|
92 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
93 * |------+------+------+------+------+------|------+------+------+------+------+------|
94 * | Shift | F7 | F8 | F9 | F10 | F11 | F12 | | | Home | End |Enter |
95 * |------+------+------+------+------+------+------+------+------+------+------+------|
96 * | Brite| | | | | | | Play | Vol- | Vol+ | Next |
97 * `-----------------------------------------------------------------------------------'
98 */
26eef35f
JY
99[_LOWER] = LAYOUT_planck_grid(
100 KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
101 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
102 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______,KC_HOME, KC_END, _______,
103 BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPLY, KC_VOLD, KC_VOLU, KC_MNXT
104),
1a8042ae 105\
106/* Raise
107 * ,-----------------------------------------------------------------------------------.
108 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
109 * |------+------+------+------+------+-------------+------+------+------+------+------|
110 * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
111 * |------+------+------+------+------+------|------+------+------+------+------+------|
112 * | Shift | F7 | F8 | F9 | F10 | F11 | F12 | | | PgUp | PgDn |Enter |
113 * |------+------+------+------+------+------+------+------+------+------+------+------|
114 * | Brite| | | | | | | Play | Vol- | Vol+ | Next |
115 * `-----------------------------------------------------------------------------------'
116 */
26eef35f
JY
117[_RAISE] = LAYOUT_planck_grid(
118 KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
119 KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
120 _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, KC_PGUP, KC_PGDN, _______,
121 BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPLY, KC_VOLD, KC_VOLU, KC_MNXT
122),
1a8042ae 123
124/* Plover layer (http://opensteno.org)
125 * ,-----------------------------------------------------------------------------------.
126 * | # | # | # | # | # | # | # | # | # | # | # | # |
127 * |------+------+------+------+------+-------------+------+------+------+------+------|
128 * | | S | T | P | H | * | * | F | P | L | T | D |
129 * |------+------+------+------+------+------|------+------+------+------+------+------|
130 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
131 * |------+------+------+------+------+------+------+------+------+------+------+------|
132 * | Exit | | | A | O | | E | U | | | |
133 * `-----------------------------------------------------------------------------------'
134 */
135
26eef35f
JY
136[_PLOVER] = LAYOUT_planck_grid(
137 KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
138 XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
139 XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
140 EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
141),
1a8042ae 142
143/* Numpad
144 * ,-----------------------------------------------------------------------------------.
145 * | Tab | | | ^ | / | 7 | 8 | 9 | - | = | | Bksp |
146 * |------+------+------+------+------+-------------+------+------+------+------+------|
147 * | Esc | | | % | * | 4 | 5 | 6 | + | ( | ) | |
148 * |------+------+------+------+------+------|------+------+------+------+------+------|
149 * | Shft | | | $ | Del | 1 | 2 | 3 |Enter | [ | ] |Enter |
150 * |------+------+------+------+------+------+------+------+------+------+------+------|
151 * | Exit | Ctrl | Alt | Gui | | 0 | . | Left | Down | Up |Right |
152 * `-----------------------------------------------------------------------------------'
153 */
26eef35f
JY
154[_NUMPAD] = LAYOUT_planck_grid(
155 KC_TAB, XXXXXXX, XXXXXXX, KC_CIRC, KC_PSLS, KC_P7, KC_P8, KC_P9, KC_PMNS, KC_EQL, XXXXXXX, KC_BSPC,
156 KC_ESC, XXXXXXX, XXXXXXX, KC_PERC, KC_PAST, KC_P4, KC_P5, KC_P6, KC_PPLS, KC_LPRN, KC_RPRN, XXXXXXX,
157 KC_LSFT, XXXXXXX, XXXXXXX, KC_DLR, KC_DEL, KC_P1, KC_P2, KC_P3, KC_PENT, KC_LBRC, KC_RBRC, KC_ENT ,
158 EXT_NUM, KC_LCTL, KC_LALT, KC_LGUI, XXXXXXX, KC_P0, KC_P0, KC_PDOT, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
159),
1a8042ae 160
161/* Adjust (Lower + Raise)
162 * ,-----------------------------------------------------------------------------------.
163 * | | Reset| | | | | | | | | | Del |
164 * |------+------+------+------+------+-------------+------+------+------+------+------|
165 * | Login| | | | | | Num |Qwerty|Colemk|Dvorak|Plover| |
166 * |------+------+------+------+------+------|------+------+------+------+------+------|
167 * | Caps |RGBTOG|RGBMOD| Hue+ | Hue- | Sat+ | Sat- | Val+ | Val- | | | |
168 * |------+------+------+------+------+------+------+------+------+------+------+------|
169 * | | | | | | | | | | | |
170 * `-----------------------------------------------------------------------------------'
171 */
26eef35f
JY
172[_ADJUST] = LAYOUT_planck_grid(
173 _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL ,
174 M(1) , _______, _______, _______, _______, _______, NUMPAD, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
175 KC_CAPS, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______,
176 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
177)
1a8042ae 178
179
180};
181
182const uint16_t PROGMEM fn_actions[] = {
183 [0] = ACTION_MODS_TAP_KEY(MOD_RSFT, KC_ENT),
184};
185
186const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
187{
188 // MACRODOWN only works in this function
189 switch(id) {
190 case 0:
191 if (record->event.pressed) {
192 register_code(KC_RSFT);
193 register_code(KC_RCTL);
194 register_code(KC_ESC);
195 }
196 else{
197 clear_keyboard();
198 }
199 break;
200 case 1:
201 if (record->event.pressed) {
202 register_code(KC_LCTL);
203 register_code(KC_LALT);
204 register_code(KC_DEL);
205 }
206 else{
207 clear_keyboard();
208 }
209 break;
210 }
211 return MACRO_NONE;
212};
213
214
215#ifdef AUDIO_ENABLE
216
217float tone_startup[][2] = SONG(STARTUP_SOUND);
218float tone_qwerty[][2] = SONG(QWERTY_SOUND);
219float tone_dvorak[][2] = SONG(DVORAK_SOUND);
220float tone_colemak[][2] = SONG(COLEMAK_SOUND);
221float tone_plover[][2] = SONG(PLOVER_SOUND);
222float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
223float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
224
225float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
226#endif
227
228
229void persistant_default_layer_set(uint16_t default_layer) {
230 eeconfig_update_default_layer(default_layer);
231 default_layer_set(default_layer);
232}
233
234bool process_record_user(uint16_t keycode, keyrecord_t *record) {
235 switch (keycode) {
236 case QWERTY:
237 if (record->event.pressed) {
238 #ifdef AUDIO_ENABLE
fe60cbd9 239 PLAY_SONG(tone_qwerty);
1a8042ae 240 #endif
241 persistant_default_layer_set(1UL<<_QWERTY);
242 }
243 return false;
244 break;
245 case NUMPAD:
246 if (record->event.pressed) {
247 layer_off(_RAISE);
248 layer_off(_LOWER);
249 layer_off(_ADJUST);
250 layer_on(_NUMPAD);
251 }
252 return false;
253 break;
254 case EXT_NUM:
255 if (record->event.pressed) {
256 layer_off(_NUMPAD);
257 }
258 return false;
259 break;
260 case COLEMAK:
261 if (record->event.pressed) {
262 #ifdef AUDIO_ENABLE
fe60cbd9 263 PLAY_SONG(tone_colemak);
1a8042ae 264 #endif
265 persistant_default_layer_set(1UL<<_COLEMAK);
266 }
267 return false;
268 break;
269 case DVORAK:
270 if (record->event.pressed) {
271 #ifdef AUDIO_ENABLE
fe60cbd9 272 PLAY_SONG(tone_dvorak);
1a8042ae 273 #endif
274 persistant_default_layer_set(1UL<<_DVORAK);
275 }
276 return false;
277 break;
278 case LOWER:
279 if (record->event.pressed) {
280 layer_on(_LOWER);
281 update_tri_layer(_LOWER, _RAISE, _ADJUST);
282 } else {
283 layer_off(_LOWER);
284 update_tri_layer(_LOWER, _RAISE, _ADJUST);
285 }
286 return false;
287 break;
288 case RAISE:
289 if (record->event.pressed) {
290 layer_on(_RAISE);
291 update_tri_layer(_LOWER, _RAISE, _ADJUST);
292 } else {
293 layer_off(_RAISE);
294 update_tri_layer(_LOWER, _RAISE, _ADJUST);
295 }
296 return false;
297 break;
298 case BACKLIT:
299 if (record->event.pressed) {
300 register_code(KC_RSFT);
301 #ifdef BACKLIGHT_ENABLE
302 backlight_step();
303 #endif
304 } else {
305 unregister_code(KC_RSFT);
306 }
307 return false;
308 break;
309 case PLOVER:
310 if (record->event.pressed) {
311 #ifdef AUDIO_ENABLE
312 stop_all_notes();
fe60cbd9 313 PLAY_SONG(tone_plover);
1a8042ae 314 #endif
315 layer_off(_RAISE);
316 layer_off(_LOWER);
317 layer_off(_ADJUST);
318 layer_on(_PLOVER);
319 if (!eeconfig_is_enabled()) {
320 eeconfig_init();
321 }
322 keymap_config.raw = eeconfig_read_keymap();
323 keymap_config.nkro = 1;
324 eeconfig_update_keymap(keymap_config.raw);
325 }
326 return false;
327 break;
328 case EXT_PLV:
329 if (record->event.pressed) {
330 #ifdef AUDIO_ENABLE
fe60cbd9 331 PLAY_SONG(tone_plover_gb);
1a8042ae 332 #endif
333 layer_off(_PLOVER);
334 }
335 return false;
336 break;
337 }
338 return true;
339}
340
341void matrix_init_user(void) {
342 #ifdef AUDIO_ENABLE
343 startup_user();
344 #endif
345}
346
347#ifdef AUDIO_ENABLE
348
349void startup_user()
350{
351 _delay_ms(20); // gets rid of tick
fe60cbd9 352 PLAY_SONG(tone_startup);
1a8042ae 353}
354
355void shutdown_user()
356{
fe60cbd9 357 PLAY_SONG(tone_goodbye);
1a8042ae 358 _delay_ms(150);
359 stop_all_notes();
360}
361
362void music_on_user(void)
363{
364 music_scale_user();
365}
366
367void music_scale_user(void)
368{
fe60cbd9 369 PLAY_SONG(music_scale);
1a8042ae 370}
371
372#endif