keyboards/planck/keymaps/dr_notsokind/keymap.c

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