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