keyboards/planck/keymaps/dr_notsokind/keymap.c

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