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