keyboards/planck/keymaps/jhenahan/keymap.c

   1
   2 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
   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 _WORKMAN 0
  17 #define _DEAD 1
  18 #define _QWERTY 2
  19 #define _LOWER 3
  20 #define _RAISE 4
  21 #define _PLOVER 5
  22 #define _ADJUST 16
  23
  24 enum planck_keycodes {
  25   WORKMAN = SAFE_RANGE,
  26   DEAD,
  27   QWERTY,
  28   LOWER,
  29   RAISE,
  30   PLOVER,
  31   EXT_PLV,
  32   TOG_PLV
  33 };
  34
  35 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  36
  37
  38 /* Workman
  39  * ,-----------------------------------------------------------------------------------.
  40  * | Tab  |   Q  |   D  |   R  |   W  |   B  |   J  |   F  |   U  |   P  |   ;  | Bksp |
  41  * |------+------+------+------+------+-------------+------+------+------+------+------|
  42  * | Esc  |   A  |   S  |   H  |   T  |   G  |   Y  |   N  |   E  |   O  |   I  |  "   |
  43  * |------+------+------+------+------+------|------+------+------+------+------+------|
  44  * | Shift|   Z  |   X  |   M  |   C  |   V  |   K  |   L  | Dead |   .  |   /  |Enter |
  45  * |------+------+------+------+------+------+------+------+------+------+------+------|
  46  * | Ctrl | RAlt | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  47  * `-----------------------------------------------------------------------------------'
  48  */
  49 [_WORKMAN] = {
  50   {KC_TAB,              KC_Q,    KC_D,    KC_R,    KC_W,    KC_B,    KC_J,    KC_F,    KC_U,    KC_P,    KC_SCLN, KC_BSPC},
  51   {MT(MOD_LCTL,KC_ESC), KC_A,    KC_S,    KC_H,    KC_T,    KC_G,    KC_Y,    KC_N,    KC_E,    KC_O,    KC_I,    KC_QUOT},
  52   {KC_LSFT,             KC_Z,    KC_X,    KC_M,    KC_C,    KC_V,    KC_K,    KC_L,    DEAD,    KC_DOT,  KC_SLSH, KC_ENT},
  53   {KC_LCTL,             KC_RALT, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  54 },
  55
  56 /* Workman Dead Layer
  57  * ,-----------------------------------------------------------------------------------.
  58  * |      |   %  |   &  |   ?  |   +  |   @  |   $  |   _  |   [  |   ]  |   !  |      |
  59  * |------+------+------+------+------+-------------+------+------+------+------+------|
  60  * |      |   /  |   (  |   =  |   0  |   {  |   }  |   1  |   *  |   )  |   -  |  "   |
  61  * |------+------+------+------+------+------|------+------+------+------+------+------|
  62  * |      |   6  |   7  |   8  |   9  |   |  |   \  |   2  |   3  |   4  |   5  |      |
  63  * |------+------+------+------+------+------+------+------+------+------+------+------|
  64  * |      |      |   <  |   ~  |   `  |      ,      |   #  |   ^  |   >  |      |      |
  65  * `-----------------------------------------------------------------------------------'
  66  */
  67 [_DEAD] = {
  68   {XXXXXXX,  KC_PERC, KC_AMPR, KC_QUES, KC_PLUS, KC_AT,   KC_DLR,  KC_UNDS, KC_LBRC, KC_RBRC,  KC_EXLM, XXXXXXX},
  69   {XXXXXXX,  KC_SLSH, KC_LPRN, KC_EQL,  KC_0,    KC_LCBR, KC_RCBR, KC_1,    KC_ASTR, KC_RPRN,  KC_MINS, XXXXXXX},
  70   {XXXXXXX,  KC_6,    KC_7,    KC_8,    KC_9,    KC_PIPE, KC_BSLS, KC_2,    KC_3,    KC_4,     KC_5,    XXXXXXX},
  71   {XXXXXXX,  XXXXXXX, KC_LT,   KC_TILD, KC_GRV,  KC_COMM, KC_COMM, KC_HASH, KC_CIRC, KC_GT,    XXXXXXX, XXXXXXX}
  72 },
  73
  74 /* Qwerty
  75  * ,-----------------------------------------------------------------------------------.
  76  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  77  * |------+------+------+------+------+-------------+------+------+------+------+------|
  78  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  79  * |------+------+------+------+------+------|------+------+------+------+------+------|
  80  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  81  * |------+------+------+------+------+------+------+------+------+------+------+------|
  82  * | Ctrl | RAlt | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  83  * `-----------------------------------------------------------------------------------'
  84  */
  85 [_QWERTY] = {
  86   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  87   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  88   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  89   {KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  90 },
  91
  92 /* Lower
  93  * ,-----------------------------------------------------------------------------------.
  94  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
  95  * |------+------+------+------+------+-------------+------+------+------+------+------|
  96  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
  97  * |------+------+------+------+------+------|------+------+------+------+------+------|
  98  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      | Vol+ |Enter |
  99  * |------+------+------+------+------+------+------+------+------+------+------+------|
 100  * |      |      |      |      |      |             |      | Prev | Next | Vol- | Play |
 101  * `-----------------------------------------------------------------------------------'
 102  */
 103 [_LOWER] = {
 104   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC},
 105   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
 106   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS), _______, KC_VOLU, _______},
 107   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MPRV,    KC_MNXT, KC_VOLD, KC_MPLY}
 108 },
 109
 110 /* Raise - KWM Interaction
 111  * ,-----------------------------------------------------------------------------------.
 112  * |Restrt|      |TgSplt|Flotng|Parent|FlScrn|InsMrk| InsW | InsS | InsN | InsE |      |
 113  * |------+------+------+------+------+-------------+------+------+------+------+------|
 114  * |      | Mark |Rotate|Prefix| Term | BSP  |SwpMrk|SwapW |SwapS |SwapN |SwapE |      |
 115  * |------+------+------+------+------+------|------+------+------+------+------+------|
 116  * |      |MarkW |MarkS |MarkN |MarkE |Monocl|Float |FocusW|FocusS|FocusN|FocusE|      |
 117  * |------+------+------+------+------+------+------+------+------+------+------+------|
 118  * |      |      |      |      |      |             |      |      |      |      |      |
 119  * `-----------------------------------------------------------------------------------'
 120  */
 121 [_RAISE] = {
 122   {LCAG(KC_Q), XXXXXXX,    LCAG(KC_S),       LCAG(KC_W),   LCAG(KC_D), LCAG(KC_F),        LCTL(S(KC_X)),    LCTL(S(KC_H)),    LCTL(S(KC_J)),     LCTL(S(KC_K)),    LCTL(S(KC_L)),    XXXXXXX},
 123   {XXXXXXX,    LCAG(KC_M), LGUI(LCTL(KC_R)), LCAG(KC_DOT), LCAG(KC_T), LGUI(LCTL(KC_A)),  LCTL(LALT(KC_M)), LCTL(LALT(KC_H)), LCTL(LALT(KC_J)),  LCTL(LALT(KC_K)), LCTL(LALT(KC_L)), XXXXXXX},
 124   {_______,    LCAG(KC_H), LCAG(KC_J),       LCAG(KC_K),   LCAG(KC_L), LGUI(LCTL(KC_S)),  LGUI(LCTL(KC_D)), LGUI(LALT(KC_H)), LGUI(LALT(KC_J)),  LGUI(LALT(KC_K)), LGUI(LALT(KC_L)), _______},
 125   {_______,    _______,    _______,          _______,      _______,    _______,           _______,          _______,          _______,           _______,          _______,          _______}
 126 },
 127
 128 /* Plover layer (http://opensteno.org)
 129  * ,-----------------------------------------------------------------------------------.
 130  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 131  * |------+------+------+------+------+-------------+------+------+------+------+------|
 132  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 133  * |------+------+------+------+------+------|------+------+------+------+------+------|
 134  * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 135  * |------+------+------+------+------+------+------+------+------+------+------+------|
 136  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 137  * `-----------------------------------------------------------------------------------'
 138  */
 139
 140 [_PLOVER] = {
 141   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 142   {XXXXXXX, KC_Q,    KC_D,    KC_R,    KC_W,    KC_B,    KC_J,    KC_F,    KC_U,    KC_P,    KC_SCLN, KC_BSPC},
 143   {TOG_PLV, KC_A,    KC_S,    KC_H,    KC_T,    KC_G,    KC_Y,    KC_N,    KC_E,    KC_O,    KC_I,    KC_QUOT},
 144   {EXT_PLV, XXXXXXX, XXXXXXX, KC_M,    KC_C,    XXXXXXX, XXXXXXX, KC_L,    KC_COMM, XXXXXXX, XXXXXXX, XXXXXXX}
 145 },
 146
 147 /* Adjust (Lower + Raise)
 148  * ,-----------------------------------------------------------------------------------.
 149  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 150  * |------+------+------+------+------+-------------+------+------+------+------+------|
 151  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Workmn|Plover|      |      |
 152  * |------+------+------+------+------+------|------+------+------+------+------+------|
 153  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 154  * |------+------+------+------+------+------+------+------+------+------+------+------|
 155  * |      |      |      |      |      |             |      |      |      |      |      |
 156  * `-----------------------------------------------------------------------------------'
 157  */
 158 [_ADJUST] = {
 159   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 160   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  WORKMAN, PLOVER,  _______, _______},
 161   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 162   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 163 }
 164
 165
 166 };
 167
 168 #ifdef AUDIO_ENABLE
 169
 170 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 171 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 172 float tone_workman[][2]    = SONG(WORKMAN_SOUND);
 173 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 174 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 175 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 176
 177 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 178 #endif
 179
 180
 181 void persistent_default_layer_set(uint16_t default_layer) {
 182   eeconfig_update_default_layer(default_layer);
 183   default_layer_set(default_layer);
 184 }
 185
 186 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 187   switch (keycode) {
 188     case WORKMAN:
 189       if (record->event.pressed) {
 190         #ifdef AUDIO_ENABLE
 191           PLAY_SONG(tone_workman);
 192         #endif
 193         persistent_default_layer_set(1UL<<_WORKMAN);
 194       }
 195       return false;
 196       break;
 197     case DEAD:
 198       if (record->event.pressed) {
 199         layer_on(_DEAD);
 200         set_oneshot_layer(_DEAD, ONESHOT_START);
 201         clear_oneshot_layer_state(ONESHOT_PRESSED);
 202       }
 203       return false;
 204       break;
 205     case QWERTY:
 206       if (record->event.pressed) {
 207         #ifdef AUDIO_ENABLE
 208           PLAY_SONG(tone_qwerty);
 209         #endif
 210         persistent_default_layer_set(1UL<<_QWERTY);
 211       }
 212       return false;
 213       break;
 214     case LOWER:
 215       if (record->event.pressed) {
 216         layer_on(_LOWER);
 217         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 218       } else {
 219         layer_off(_LOWER);
 220         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 221       }
 222       return false;
 223       break;
 224     case RAISE:
 225       if (record->event.pressed) {
 226         layer_on(_RAISE);
 227         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 228       } else {
 229         layer_off(_RAISE);
 230         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 231       }
 232       return false;
 233       break;
 234     case PLOVER:
 235       if (record->event.pressed) {
 236         #ifdef AUDIO_ENABLE
 237           stop_all_notes();
 238           PLAY_SONG(tone_plover);
 239         #endif
 240         layer_off(_RAISE);
 241         layer_off(_LOWER);
 242         layer_off(_ADJUST);
 243         layer_on(_PLOVER);
 244         if (!eeconfig_is_enabled()) {
 245             eeconfig_init();
 246         }
 247         keymap_config.raw = eeconfig_read_keymap();
 248         keymap_config.nkro = 1;
 249         eeconfig_update_keymap(keymap_config.raw);
 250       }
 251       return false;
 252       break;
 253     case EXT_PLV:
 254       if (record->event.pressed) {
 255         #ifdef AUDIO_ENABLE
 256           PLAY_SONG(tone_plover_gb);
 257         #endif
 258         layer_off(_PLOVER);
 259       }
 260       return false;
 261       break;
 262   case TOG_PLV:
 263     if (record->event.pressed) {
 264       register_code(KC_R);
 265       register_code(KC_W);
 266       register_code(KC_T);
 267       register_code(KC_C);
 268       register_code(KC_P);
 269       register_code(KC_O);
 270       clear_keyboard();
 271     }
 272     return false;
 273     break;
 274   }
 275   return true;
 276 }
 277
 278 void matrix_init_user(void) {
 279     #ifdef AUDIO_ENABLE
 280         startup_user();
 281     #endif
 282 }
 283
 284 #ifdef AUDIO_ENABLE
 285
 286 void startup_user()
 287 {
 288     _delay_ms(20); // gets rid of tick
 289     PLAY_SONG(tone_startup);
 290 }
 291
 292 void shutdown_user()
 293 {
 294     PLAY_SONG(tone_goodbye);
 295     _delay_ms(150);
 296     stop_all_notes();
 297 }
 298
 299 void music_on_user(void)
 300 {
 301     music_scale_user();
 302 }
 303
 304 void music_scale_user(void)
 305 {
 306     PLAY_SONG(music_scale);
 307 }
 308
 309 #endif