]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/dr_notsokind/keymap.c
[Keyboard] Add QMK configurator JSON for Alice PCB (#6397)
[qmk_firmware.git] / keyboards / planck / keymaps / dr_notsokind / keymap.c
1 // Layout picture at http://www.keyboard-layout-editor.com/#/gists/125febfad6960add078e6f14256539b6
2
3 #include QMK_KEYBOARD_H
4 #ifdef AUDIO_ENABLE
5 #include "audio.h"
6 #endif
7 #include "eeconfig.h"
8
9 extern keymap_config_t keymap_config;
10
11 // Each layer gets a name for readability, which is then used in the keymap matrix below.
12 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
13 // Layer names don't all need to be of the same length, obviously, and you can also skip them
14 // entirely and just use numbers.
15 #define _QWERTY  0
16 #define _NUMPAD  1
17 #define _LOCKED  2
18 #define _RAISE   3
19 #define _LOWER   4
20 #define _FUNCTN  5
21 #define _MEDIA   6
22 #define _ONESHOT 7
23
24 enum planck_keycodes {
25     QWERTY = SAFE_RANGE,
26     NUMPAD,
27     RAISE,
28     LOWER,
29     MEDIA,
30     ONESHOT,
31     DYNAMIC_MACRO_RANGE
32 };
33
34 #include "dynamic_macro.h"
35
36 // Key code names
37 #define SFT_ENT  FUNC(0)    // Tap for enter, hold for right shift
38 #define LOCK     FUNC(1)
39 #define KC_PSTE  KC_PASTE
40 #define ZOOM_IN  LCTL(KC_EQL)
41 #define ZOOM_OUT LCTL(KC_MINS)
42 #define ZOOM_NML LCTL(KC_0)
43
44 #ifdef TAP_DANCE_ENABLE
45 #define SFT_CAP  TD(0)  // Left shift, double tap for caps
46 #endif
47 #ifndef TAP_DANCE_ENABLE
48 #define SFT_CAP  KC_LSFT // Regular left shift
49 #endif
50
51 // Tap Dance Definitions
52 #ifdef TAP_DANCE_ENABLE
53 qk_tap_dance_action_t tap_dance_actions[] = {
54     [0]  = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS)
55 };
56 #endif
57
58 // Function definitions
59 const uint16_t PROGMEM fn_actions[] = {
60     [0] = ACTION_MODS_TAP_KEY(MOD_RSFT, KC_ENT),
61     [1] = ACTION_LAYER_TOGGLE(_LOCKED)
62 };
63
64 // Layout definitions
65 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
66
67 /* QWERTY
68  * ,-----------------------------------------------------------------------------------.
69  * | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | BKSP |
70  * |------+------+------+------+------+------+------+------+------+------+------+------|
71  * | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |   '  |
72  * |------+------+------+------+------+------+------+------+------+------+------+------|
73  * |*Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |  Up  |SftEnt|
74  * |------+------+------+------+------+-------------+------+------+------+------+------|
75  * | Ctrl | GUI  | Alt  | Mute | Lower|    Space    | Raise|   /  | Left | Down | Right|
76  * `-----------------------------------------------------------------------------------'
77  */
78 [_QWERTY] = LAYOUT_planck_grid(
79     KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
80     KC_TAB,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
81     SFT_CAP, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_UP,   SFT_ENT,
82     KC_LCTL, KC_LGUI, KC_LALT, MEDIA,   LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_SLSH, KC_LEFT, KC_DOWN, KC_RGHT
83 ),
84
85 /* NUMPAD
86  * ,-----------------------------------------------------------------------------------.
87  * |QWERTY| NULL |  Up  | NULL | NULL | NULL | NULL |   /  |   7  |   8  |   9  |   -  |
88  * |------+------+------+------+------+------+------+------+------+------+------+------|
89  * |      | Left | Down | Right| NULL | NULL | NULL |   *  |   4  |   5  |   6  |   +  |
90  * |------+------+------+------+------+------+------+------+------+------+------+------|
91  * |      |NumLck| NULL | NULL | NULL | NULL | NULL |BckSp |   1  |   2  |   3  |  Ent |
92  * |------+------+------+------+------+-------------+------+------+------+------+------|
93  * |      |      |      |      |      |             |      |   0  |   .  |   ,  |   =  |
94  * `-----------------------------------------------------------------------------------'
95  */
96 [_NUMPAD] = LAYOUT_planck_grid(
97     QWERTY,  XXXXXXX,   KC_UP, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PSLS,  KC_P7,  KC_P8,   KC_P9,   KC_PMNS,
98     _______, KC_LEFT, KC_DOWN, KC_RGHT, XXXXXXX, XXXXXXX, XXXXXXX, KC_PAST,  KC_P4,  KC_P5,   KC_P6,   KC_PPLS,
99     _______, KC_NLCK, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_BSPC,  KC_P1,  KC_P2,   KC_P3,   KC_PENT,
100     _______, _______, _______, _______, _______, _______, _______, _______,  KC_P0,  KC_PDOT, KC_PCMM, KC_PEQL
101 ),
102
103 /* LOCK
104  * ,-----------------------------------------------------------------------------------.
105  * |      |      |      |      |      |      |      |      |      |      |      |      |
106  * |------+------+------+------+------+------+------+------+------+------+------+------|
107  * |      |      |      |      |      |      |      |      |      |      |      |      |
108  * |------+------+------+------+------+------+------+------+------+------+------+------|
109  * | Shift|      |      |      |      |      |      |      |      |      |      | Enter|
110  * |------+------+------+------+------+-------------+------+------+------+------+------|
111  * |      | NULL |      |      |      |             |      |      |      |      |      |
112  * `-----------------------------------------------------------------------------------'
113  */
114 [_LOCKED] = LAYOUT_planck_grid(
115     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
116     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
117     KC_LSFT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,  KC_ENT,
118     _______, XXXXXXX, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
119 ),
120
121 /* RAISE
122  * ,-----------------------------------------------------------------------------------.
123  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
124  * |------+------+------+------+------+------+------+------+------+------+------+------|
125  * | Del  |  F11 |  F12 |  F13 |  F14 |  F15 |      |   -  |   =  |   [  |   ]  |  \   |
126  * |------+------+------+------+------+------+------+------+------+------+------+------|
127  * |LShift|  F16 |  F17 |  F18 |  F19 |  F20 |      |ISO # |ISO / | NULL | PgUp | Enter|
128  * |------+------+------+------+------+-------------+------+------+------+------+------|
129  * |      |      |      |      |      |             |      |      | Home | PgDn |  End |
130  * `-----------------------------------------------------------------------------------'
131  */
132 [_RAISE] = LAYOUT_planck_grid(
133     KC_GRV , KC_1,    KC_2,      KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,  KC_DEL,
134     KC_DEL , KC_F11,  KC_F12,   KC_F13,  KC_F14, KC_F15, _______, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS,
135     KC_LSFT, KC_F16,  KC_F17,   KC_F18,  KC_F19, KC_F20, _______, KC_NUHS, KC_NUBS, XXXXXXX, KC_PGUP, KC_ENT,
136     _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_END 
137 ),
138
139 /* LOWER
140  * ,-----------------------------------------------------------------------------------.
141  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
142  * |------+------+------+------+------+------+------+------+------+------+------+------|
143  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |      |   _  |   +  |   {  |   }  |  |   |
144  * |------+------+------+------+------+------+------+------+------+------+------+------|
145  * |LShift|  F6  |  F7  |  F8  |  F9  |  F10 |      |ISO ~ |ISO | | NULL | PgUp | Enter|
146  * |------+------+------+------+------+-------------+------+------+------+------+------|
147  * |      |      |      |      |      |             |      |      | Home | PgDn |  End |
148  * `-----------------------------------------------------------------------------------'
149  */
150 [_LOWER] = LAYOUT_planck_grid(
151     KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL ,
152     KC_DEL , KC_F1,   KC_F2,   KC_F3,    KC_F4, KC_F5,   _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
153     KC_LSFT, KC_F6,   KC_F7,   KC_F8,    KC_F9, KC_F10,  _______, S(KC_NUHS), S(KC_NUBS), XXXXXXX, KC_PGUP, KC_ENT ,
154     _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_END 
155 ),
156
157 /* MEDIA AND COMMANDS
158  * ,-----------------------------------------------------------------------------------.
159  * | NULL | NULL |WbHome| NULL | NULL | NULL |Again | NULL |Insert| NULL |PrntSc| NULL |
160  * |------+------+------+------+------+------+------+------+------+------+------+------|
161  * | NULL | NULL |WbSrch| NULL | Find | NULL | NULL | NULL | NULL | NULL |PlyMc1|PlyMc2|
162  * |------+------+------+------+------+------+------+------+------+------+------+------|
163  * |LShift| NULL | NULL | Calc | NULL | NULL | NULL | NULL |ZoomOu|ZoomIn| Prev |RecStp|
164  * |------+------+------+------+------+-------------+------+------+------+------+------|
165  * |ONESHT| NULL | NULL |      | Vol- |     Mute    | Vol+ |Zoom 0| Stop | Next | Play |
166  * `-----------------------------------------------------------------------------------'
167  */
168 [_MEDIA] = LAYOUT_planck_grid(
169         XXXXXXX, XXXXXXX, KC_WHOM, XXXXXXX, XXXXXXX, XXXXXXX, KC_AGAIN, XXXXXXX, KC_INS,   XXXXXXX, KC_PSCR, XXXXXXX,
170         XXXXXXX, XXXXXXX, KC_WSCH, XXXXXXX, KC_FIND, XXXXXXX, XXXXXXX,  XXXXXXX, XXXXXXX,  XXXXXXX, DYN_MACRO_PLAY1, DYN_MACRO_PLAY2,
171         KC_LSFT, XXXXXXX, XXXXXXX, KC_CALC, XXXXXXX, XXXXXXX, XXXXXXX,  XXXXXXX, ZOOM_OUT, ZOOM_IN, KC_MPRV, DYN_REC_STOP,
172         ONESHOT, XXXXXXX, XXXXXXX, _______, KC_VOLD, KC_MUTE, KC_MUTE,  KC_VOLU, ZOOM_NML, KC_MSTP, KC_MNXT, KC_MPLY 
173 ),
174
175 /* ONESHOT
176  * ,-----------------------------------------------------------------------------------.
177  * |      |      |      |      |      |      |      |      |      |      |      |      |
178  * |------+------+------+------+------+------+------+------+------+------+------+------|
179  * |      |      |      |      |      |      |      |      |      |      |RecMc1|RecMc2|
180  * |------+------+------+------+------+------+------+------+------+------+------+------|
181  * |      |      |      |      |      |      |      |      |      |      |      |      |
182  * |------+------+------+------+------+-------------+------+------+------+------+------|
183  * |      |      |      |      |      |             |      |      |      |      |      |
184  * `-----------------------------------------------------------------------------------'
185  */
186 [_ONESHOT] = LAYOUT_planck_grid(
187     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
188     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, DYN_REC_START1, DYN_REC_START2,
189     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
190     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
191 ),
192
193 /* FUNCTIONS
194  * ,-----------------------------------------------------------------------------------.
195  * | SLEEP| NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | POWER|
196  * |------+------+------+------+------+------+------+------+------+------+------+------|
197  * | WAKE | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL | NULL |
198  * |------+------+------+------+------+------+------+------+------+------+------+------|
199  * | NULL | NULL | NULL |AudOff|MusOff|QWERTY|NUMPAD|Mus On|Aud On| NULL |Voice+|SysReq|
200  * |------+------+------+------+------+-------------+------+------+------+------+------|
201  * | Reset| NULL | LOCK | NULL |      |     NULL    |      | NULL |AGNorm|Voice-|AGSwap|
202  * `-----------------------------------------------------------------------------------'
203  */
204 [_FUNCTN] = LAYOUT_planck_grid(
205         KC_SLEP, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PWR,
206         KC_WAKE, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
207         XXXXXXX, XXXXXXX, XXXXXXX, AU_OFF,  MU_OFF,  QWERTY,  NUMPAD,  MU_ON,   AU_ON,   XXXXXXX, MUV_IN,  KC_SYSREQ,
208         RESET,   XXXXXXX, LOCK,    XXXXXXX, _______, XXXXXXX, XXXXXXX, _______, XXXXXXX, AG_NORM, MUV_DE,  AG_SWAP
209 )
210
211 };
212
213 #ifdef AUDIO_ENABLE
214 float tone_startup[][2] = SONG(STARTUP_SOUND);
215 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
216 float tone_numpad[][2] = SONG(NUM_LOCK_ON_SOUND);
217 float tone_oneshot[][2] = SONG(TERMINAL_SOUND);
218 float tone_dyn_macro_rec[][2] = SONG(SONIC_RING);
219 float tone_dyn_macro_stop[][2] = SONG(COIN_SOUND);
220 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
221 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
222 #endif
223
224 void press_key(uint16_t key) {
225     register_code(key);
226     unregister_code(key);
227 }
228
229 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
230     // uint16_t macro_kc = (keycode == ONESHOT ? DYN_REC_STOP : keycode);
231     if (!process_record_dynamic_macro(keycode, record)) {
232         switch(keycode) {
233           case DYN_REC_START1:
234           case DYN_REC_START2:
235 #ifdef AUDIO_ENABLE
236               PLAY_SONG(tone_dyn_macro_rec);
237 #endif
238               break;
239           case DYN_REC_STOP:
240 #ifdef AUDIO_ENABLE
241               PLAY_SONG(tone_dyn_macro_stop);
242 #endif
243               break;
244         }
245         return false;
246     }
247     switch (keycode) {
248         case ONESHOT:
249             if (record->event.pressed) {
250                 layer_on(_ONESHOT);
251                 set_oneshot_layer(_ONESHOT, ONESHOT_START);
252                 clear_oneshot_layer_state(ONESHOT_PRESSED);
253 #ifdef AUDIO_ENABLE
254                 PLAY_SONG(tone_oneshot);
255 #endif
256             }
257             return false;
258             break;
259         case QWERTY:
260             if (record->event.pressed) {
261                 if (IS_LAYER_ON(_NUMPAD)) {
262 #ifdef AUDIO_ENABLE
263                     PLAY_SONG(tone_qwerty);
264 #endif
265                     layer_off(_NUMPAD);
266                 }
267             }
268             return false;
269             break;
270         case NUMPAD:
271             if (record->event.pressed) {
272                 if (!IS_LAYER_ON(_NUMPAD)) {
273 #ifdef AUDIO_ENABLE
274                     PLAY_SONG(tone_numpad);
275 #endif
276                     layer_on(_NUMPAD);
277                 }
278             }
279             return false;
280             break;
281         case RAISE:
282             if (record->event.pressed) {
283                 layer_on(_RAISE);
284                 update_tri_layer(_RAISE, _LOWER, _FUNCTN);
285             } else {
286                 layer_off(_RAISE);
287                 update_tri_layer(_RAISE, _LOWER, _FUNCTN);
288             }
289             return false;
290             break;
291         case LOWER:
292             if (record->event.pressed) {
293                 layer_on(_LOWER);
294                 update_tri_layer(_RAISE, _LOWER, _FUNCTN);
295             } else {
296                 layer_off(_LOWER);
297                 update_tri_layer(_RAISE, _LOWER, _FUNCTN);
298             }
299             return false;
300             break;
301         case MEDIA:
302             if (record->event.pressed) {
303                 layer_on(_MEDIA);
304             } else {
305                 layer_off(_MEDIA);
306             }
307             return false;
308             break;
309     }
310     return true;
311 }
312
313 void matrix_init_user(void) {
314 #ifdef AUDIO_ENABLE
315     startup_user();
316 #endif
317 }
318
319 #ifdef AUDIO_ENABLE
320
321 void startup_user()
322 {
323     _delay_ms(20); // gets rid of tick
324     PLAY_SONG(tone_startup);
325 }
326
327 void shutdown_user()
328 {
329     PLAY_SONG(tone_goodbye);
330     _delay_ms(150);
331     stop_all_notes();
332 }
333
334 void music_on_user(void)
335 {
336     music_scale_user();
337 }
338
339 void music_scale_user(void)
340 {
341     PLAY_SONG(music_scale);
342 }
343
344 #endif