keyboards/planck/keymaps/mjt/keymap.c

   1 // This is MJT's bastardization of the planck and minivan defaults
   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
  18 enum planck_layers {
  19   _QWERTY,
  20   _LOWER,
  21   _RAISE,
  22   _PLOVER,
  23   _ADJUST,
  24   _DYN
  25 };
  26
  27 enum planck_keycodes {
  28   QWERTY = SAFE_RANGE,
  29   PLOVER,
  30   LOWER,
  31   RAISE,
  32   BACKLIT,
  33   EXT_PLV,
  34   MACSLEEP,
  35   DYNAMIC_MACRO_RANGE,
  36 };
  37
  38 #include "dynamic_macro.h"
  39
  40 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  41
  42 /* Qwerty
  43  * ,-----------------------------------------------------------------------------------.
  44  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  45  * |------+------+------+------+------+-------------+------+------+------+------+------|
  46  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  47  * |------+------+------+------+------+------|------+------+------+------+------+------|
  48  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  49  * |------+------+------+------+------+------+------+------+------+------+------+------|
  50  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  51  * `-----------------------------------------------------------------------------------'
  52  */
  53 [_QWERTY] = {
  54   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  55   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  56   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_T(KC_ENT) },
  57   {MO(_DYN), KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  58 },
  59
  60 /* Lower
  61  * ,-----------------------------------------------------------------------------------.
  62  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
  63  * |------+------+------+------+------+-------------+------+------+------+------+------|
  64  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
  65  * |------+------+------+------+------+------|------+------+------+------+------+------|
  66  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
  67  * |------+------+------+------+------+------+------+------+------+------+------+------|
  68  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
  69  * `-----------------------------------------------------------------------------------'
  70  */
  71 [_LOWER] = {
  72   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, _______},
  73   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
  74   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END,  _______},
  75   {_______, _______, _______, _______, _______, _______, _______, _______,    KC_MNXT,    KC_VOLD, KC_VOLU, KC_MPLY}
  76 },
  77
  78 /* Raise
  79  * ,-----------------------------------------------------------------------------------.
  80  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
  81  * |------+------+------+------+------+-------------+------+------+------+------+------|
  82  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
  83  * |------+------+------+------+------+------|------+------+------+------+------+------|
  84  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Dn |Pg Up |      |
  85  * |------+------+------+------+------+------+------+------+------+------+------+------|
  86  * |      |      |      |      |      |             |      | Home |Pg Dn |Pg Up | End  |
  87  * `-----------------------------------------------------------------------------------'
  88  */
  89 [_RAISE] = {
  90   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______},
  91   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
  92   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGDN, KC_PGUP, _______},
  93   {_______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END}
  94 },
  95
  96 /* Plover layer (http://opensteno.org)
  97  * ,-----------------------------------------------------------------------------------.
  98  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
  99  * |------+------+------+------+------+-------------+------+------+------+------+------|
 100  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 101  * |------+------+------+------+------+------|------+------+------+------+------+------|
 102  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 103  * |------+------+------+------+------+------+------+------+------+------+------+------|
 104  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 105  * `-----------------------------------------------------------------------------------'
 106  */
 107
 108 [_PLOVER] = {
 109   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 110   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 111   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 112   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 113 },
 114
 115 /* Adjust (Lower + Raise)
 116  * ,-----------------------------------------------------------------------------------.
 117  * |      | Reset|      |      |      |      |      |      |      |Pause |PR SC |  Del |
 118  * |------+------+------+------+------+-------------+------+------+------+------+------|
 119  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|      |Sleep |Plover|      |
 120  * |------+------+------+------+------+------|------+------+------+------+------+------|
 121  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 122  * |------+------+------+------+------+------+------+------+------+------+------+------|
 123  * |TogLED|      |      |      |      |             |      |      |      |      |      |
 124  * `-----------------------------------------------------------------------------------'
 125  */
 126 [_ADJUST] = {
 127   {_______ , RESET,   _______, _______, _______, _______, _______, _______, _______, KC_PAUS, KC_PSCR, KC_DEL },
 128   {_______ , _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  _______, MACSLEEP,  PLOVER, _______},
 129   {_______ , MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 130   {BACKLIT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 131 },
 132 [_DYN] = {
 133   {_______ , _______, _______, _______, _______, _______, _______, _______, _______, DYN_REC_START1, DYN_REC_START2, _______ },
 134   {_______ , _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 135   {_______ , _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
 136   {_______ , _______, _______, _______, _______, _______, _______, _______, _______, DYN_MACRO_PLAY1, DYN_MACRO_PLAY2, _______}
 137 }
 138
 139 };
 140
 141 #ifdef AUDIO_ENABLE
 142
 143 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 144 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 145 float tone_dyn_macro_rec[][2]     = SONG(DVORAK_SOUND);
 146 float tone_dyn_macro_play[][2]    = SONG(COLEMAK_SOUND);
 147 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 148 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 149 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 150
 151 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 152 #endif
 153
 154 void persistant_default_layer_set(uint16_t default_layer) {
 155   eeconfig_update_default_layer(default_layer);
 156   default_layer_set(default_layer);
 157 }
 158
 159 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 160   uint16_t macro_kc = (keycode == MO(_DYN) ? DYN_REC_STOP : keycode);
 161   if (!process_record_dynamic_macro(macro_kc, record)) {
 162     return false;
 163   }
 164   switch (keycode) {
 165     case QWERTY:
 166       if (record->event.pressed) {
 167         #ifdef AUDIO_ENABLE
 168           PLAY_SONG(tone_qwerty);
 169         #endif
 170         persistant_default_layer_set(1UL<<_QWERTY);
 171       }
 172       return false;
 173       break;
 174     case LOWER:
 175       if (record->event.pressed) {
 176         layer_on(_LOWER);
 177         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 178       } else {
 179         layer_off(_LOWER);
 180         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 181       }
 182       return false;
 183       break;
 184     case RAISE:
 185       if (record->event.pressed) {
 186         layer_on(_RAISE);
 187         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 188       } else {
 189         layer_off(_RAISE);
 190         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 191       }
 192       return false;
 193       break;
 194     case BACKLIT:
 195       if (record->event.pressed) {
 196         register_code(KC_RSFT);
 197         #ifdef BACKLIGHT_ENABLE
 198           backlight_step();
 199         #endif
 200       } else {
 201         unregister_code(KC_RSFT);
 202       }
 203       return false;
 204       break;
 205     case PLOVER:
 206       if (record->event.pressed) {
 207         #ifdef AUDIO_ENABLE
 208           stop_all_notes();
 209           PLAY_SONG(tone_plover);
 210         #endif
 211         layer_off(_RAISE);
 212         layer_off(_LOWER);
 213         layer_off(_ADJUST);
 214         layer_on(_PLOVER);
 215         if (!eeconfig_is_enabled()) {
 216             eeconfig_init();
 217         }
 218         keymap_config.raw = eeconfig_read_keymap();
 219         keymap_config.nkro = 1;
 220         eeconfig_update_keymap(keymap_config.raw);
 221       }
 222       return false;
 223       break;
 224     case EXT_PLV:
 225       if (record->event.pressed) {
 226         #ifdef AUDIO_ENABLE
 227           PLAY_SONG(tone_plover_gb);
 228         #endif
 229         layer_off(_PLOVER);
 230       }
 231       return false;
 232       break;
 233     case MACSLEEP:
 234       if (record->event.pressed) {
 235           // ACTION_MODS_KEY(MOD_LCTL | MOD_LSFT, KC_POWER);
 236           register_code(KC_RSFT);
 237           register_code(KC_RCTL);
 238           register_code(KC_POWER);
 239           unregister_code(KC_POWER);
 240           unregister_code(KC_RCTL);
 241           unregister_code(KC_RSFT);
 242       }
 243       return false;
 244       break;
 245   }
 246   return true;
 247 }
 248
 249 void matrix_init_user(void) {
 250     #ifdef AUDIO_ENABLE
 251         startup_user();
 252     #endif
 253 }
 254
 255 #ifdef AUDIO_ENABLE
 256
 257 void startup_user()
 258 {
 259     _delay_ms(20); // gets rid of tick
 260     PLAY_SONG(tone_startup);
 261 }
 262
 263 void shutdown_user()
 264 {
 265     PLAY_SONG(tone_goodbye);
 266     _delay_ms(150);
 267     stop_all_notes();
 268 }
 269
 270 void music_on_user(void)
 271 {
 272     music_scale_user();
 273 }
 274
 275 void music_scale_user(void)
 276 {
 277     PLAY_SONG(music_scale);
 278 }
 279
 280 #endif