keyboards/planck/keymaps/mjt/keymap.c

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