keyboards/planck/keymaps/jhenahan/keymap.c

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