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