keyboards/planck/keymaps/mwpeterson/keymap.c

   1 // from <https://github.com/noahfrederick/dots/tree/master/planck
   2
   3 #include QMK_KEYBOARD_H
   4 #include "keymap_plover.h"
   5 #include "version.h"
   6
   7 extern keymap_config_t keymap_config;
   8
   9 // Keymap layers
  10 enum planck_layers {
  11   QWERTY_LAYER,
  12   LOWER_LAYER,
  13   RAISE_LAYER,
  14   NAV_LAYER,
  15   GUI_LAYER,
  16   STENO_LAYER,
  17   ADJUST_LAYER
  18 };
  19
  20 // Dashes (macOS)
  21 #define KC_NDSH LALT(KC_MINS)
  22 #define KC_MDSH S(LALT(KC_MINS))
  23
  24 // Window manager keys
  25 #define WM_FULL LALT(LGUI(KC_F))
  26 #define WM_NEXT LCTL(LALT(LGUI(KC_RGHT)))
  27 #define WM_PREV LCTL(LALT(LGUI(KC_LEFT)))
  28 #define WM_NW   LCTL(LGUI(KC_LEFT))
  29 #define WM_N    LALT(LGUI(KC_UP))
  30 #define WM_NE   LCTL(LGUI(KC_RGHT))
  31 #define WM_E    LALT(LGUI(KC_RGHT))
  32 #define WM_SE   S(LCTL(LGUI(KC_RGHT)))
  33 #define WM_S    LALT(LGUI(KC_DOWN))
  34 #define WM_SW   S(LCTL(LGUI(KC_LEFT)))
  35 #define WM_W    LALT(LGUI(KC_LEFT))
  36 #define WM_CNTR LALT(LGUI(KC_C))
  37
  38 // Custom key codes
  39 enum planck_keycodes {
  40   QWERTY = SAFE_RANGE,
  41   STENO,
  42   PV_EXIT,
  43   PV_LOOK,
  44   SEND_VERSION,
  45   SEND_MAKE
  46 };
  47
  48 #define LOWER MO(LOWER_LAYER)
  49 #define RAISE MO(RAISE_LAYER)
  50
  51 #define GUI_L LT(GUI_LAYER, KC_LBRC)
  52 #define GUI_R LT(GUI_LAYER, KC_RBRC)
  53
  54 #define NAV_SCLN LT(NAV_LAYER, KC_SCLN)
  55 #define NAV_O    LT(NAV_LAYER, KC_O)
  56
  57 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  58   /* Base layer (Qwerty)
  59    *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
  60    *                │  ⇥  │  Q  │  W  │  E  │  R  │  T  │  Y  │  U  │  I  │  O  │  P  │  '  │
  61    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
  62    * Tap for Esc -- │  ⌃  │  A  │  S  │  D  │  F  │  G  │  H  │  J  │  K  │  L  │; Nav│  ⌃  │ -- Tap for Enter
  63    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
  64    *   Tap for ( -- │  ⇧  │  Z  │  X  │  C  │  V  │  B  │  N  │  M  │  ,  │  .  │  /  │  ⇧  │ -- Tap for )
  65    *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
  66    *   Tap for [ -- │ GUI │Hyper│  ⌥  │  ⌘  │  ↓  │   Space   │  ↑  │  ⌘  │  ⌥  │Hyper│ GUI │ -- Tap for ]
  67    *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
  68    *                        /                                                     /
  69    *   Tap for ] [ --------'-----------------------------------------------------'
  70    */
  71   [QWERTY_LAYER] = LAYOUT_planck_grid(
  72     KC_TAB,        KC_Q,           KC_W,    KC_E,    KC_R,  KC_T,   KC_Y,    KC_U,  KC_I,    KC_O,    KC_P,           KC_QUOT,
  73     CTL_T(KC_ESC), KC_A,           KC_S,    KC_D,    KC_F,  KC_G,   KC_H,    KC_J,  KC_K,    KC_L,    NAV_SCLN,       CTL_T(KC_ENT),
  74     KC_LSPO,       KC_Z,           KC_X,    KC_C,    KC_V,  KC_B,   KC_N,    KC_M,  KC_COMM, KC_DOT,  KC_SLSH,        KC_RSPC,
  75     GUI_L,         ALL_T(KC_RBRC), KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_RGUI, KC_RALT, ALL_T(KC_LBRC), GUI_R
  76   ),
  77
  78   /* Numeric layer
  79    *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
  80    * Application -- │  `  │ F1  │ F2  │ F3  │ F4  │ F5  │ F6  │ F7  │ F8  │ F9  │ F10 │  #  │
  81    *      window    ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
  82    *    switcher    │     │  1  │  2  │  3  │  4  │  5  │  6  │  7  │  8  │  9  │  0  │     │
  83    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
  84    *                │     │  -  │  +  │  `  │  |  │  :  │     │     │  ,  │  .  │  \  │     │
  85    *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
  86    *                │     │     │     │     │     │ Backspace │     │     │     │     │     │
  87    *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
  88    */
  89   [LOWER_LAYER] = LAYOUT_planck_grid(
  90     KC_GRV,   KC_F1,   KC_F2,    KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  S(KC_3),
  91     _______,  KC_1,    KC_2,     KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______,
  92     _______,  KC_MINS, KC_PLUS,  KC_GRV,  KC_PIPE, KC_COLN, XXXXXXX, XXXXXXX, KC_COMM, KC_DOT,  KC_BSLS, _______,
  93     _______,  _______, _______, _______, _______, KC_BSPC, KC_BSPC, _______, _______, _______, _______, _______
  94   ),
  95
  96   /* Symbol layer
  97    *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
  98    *                │  ~  │ F11 │ F12 │ F13 │ F14 │ F15 │ F16 │ F17 │ F18 │ F19 │ F20 │  #  │
  99    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 100    *                │     │  !  │  @  │  #  │  $  │  %  │  ^  │  &  │  *  │  '  │  "  │     │ \
 101    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤  |-- Mostly shifted version
 102    *                │     │  _  │  =  │  ~  │  |  │  :  │     │     │  ,  │  .  │  /  │     │ /    of lower layer
 103    *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
 104    *                │     │     │     │     │     │  Delete   │     │     │     │     │     │
 105    *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
 106    */
 107   [RAISE_LAYER] = LAYOUT_planck_grid(
 108     S(KC_GRV), KC_F11,  KC_F12,  KC_F13,  KC_F14,  KC_F15,  KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20,     S(KC_3),
 109     _______,   S(KC_1), S(KC_2), S(KC_3), S(KC_4), S(KC_5), S(KC_6), S(KC_7), S(KC_8), KC_QUOT, S(KC_QUOT), _______,
 110     _______,   KC_UNDS, KC_EQL,  KC_TILD, KC_PIPE, KC_COLN, XXXXXXX, XXXXXXX, KC_COMM, KC_DOT,  KC_SLSH,    _______,
 111     _______,   _______, _______, _______, _______, KC_DEL,  KC_DEL,  _______, _______, _______, _______,    _______
 112   ),
 113
 114   /* Directional navigation layer
 115    *
 116    *         Large movements -----/```````````````````\   /```````````````````\----- Vim-style arrow keys
 117    *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
 118    *                │     │     │     │     │     │     │     │     │     │     │     │     │
 119    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 120    *                │     │     │Home │PgUp │PgDn │ End │  ←  │  ↓  │  ↑  │  →  │     │     │
 121    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 122    *                │     │     │     │     │     │     │     │     │     │     │     │     │
 123    *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
 124    *                │     │     │     │     │     │           │     │     │     │     │     │
 125    *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
 126    */
 127   [NAV_LAYER] = LAYOUT_planck_grid(
 128     XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,  XXXXXXX,
 129     _______, XXXXXXX, KC_HOME, KC_PGUP, KC_PGDN, KC_END,  KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, NAV_SCLN, _______,
 130     _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,  _______,
 131     _______, _______, _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, _______, _______,  _______
 132   ),
 133
 134   /* GUI (window management/mouse/media controls) layer
 135    *
 136    *        Mouse keys -----/```````````````````\               /```````````````````\----- Window manager
 137    *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
 138    *                │     │Ms B2│Ms Up│Ms B1│Ms WD│     │     │Prev │ NW  │  N  │ NE  │     │
 139    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 140    *                │     │Ms L │Ms Dn│Ms R │Ms WU│     │     │Full │  W  │Centr│  E  │     │
 141    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 142    *                │     │Undo │ Cut │Copy │Paste│     │     │Next │ SW  │  S  │ SE  │     │
 143    *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
 144    *                │     │Prev │Play │Next │     │   Sleep   │     │Mute │Vol- │Vol+ │     │
 145    *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
 146    *                        \___ Media ___/   \___ Screen/sleep __/   \___ Volume __/
 147    */
 148   [GUI_LAYER] = LAYOUT_planck_grid(
 149     _______, KC_BTN2, KC_MS_U, KC_BTN1, KC_WH_D, XXXXXXX, XXXXXXX, WM_PREV, WM_NW,   WM_N,    WM_NE,   _______,
 150     _______, KC_MS_L, KC_MS_D, KC_MS_R, KC_WH_U, XXXXXXX, XXXXXXX, WM_FULL, WM_W,    WM_CNTR, WM_E,    _______,
 151     _______, KC_UNDO, KC_CUT,  KC_COPY, KC_PSTE, XXXXXXX, XXXXXXX, WM_NEXT, WM_SW,   WM_S,    WM_SE,   _______,
 152     _______, KC_MPRV, KC_MPLY, KC_MNXT, XXXXXXX, KC_SLEP, KC_WAKE, XXXXXXX, KC_MUTE, KC_VOLD, KC_VOLU, _______
 153   ),
 154
 155   /* Base layer (Qwerty-Steno)
 156    *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
 157    *                │  #  │  #  │  #  │  #  │  #  │  #  │  #  │  #  │  #  │  #  │  #  │  #  │
 158    *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
 159    *                │Look │     │  T  │  P  │  H  │           │  F  │  P  │  L  │  T  │  D  │
 160    *                │ -up │  S  ├─────┼─────┼─────┤     *     ├─────┼─────┼─────┼─────┼─────┤
 161    *                │     │     │  K  │  W  │  R  │           │  R  │  B  │  G  │  S  │  Z  │
 162    *                ├─────┼─────┼─────┼─────┼─────┼───────────┼─────┼─────┼─────┼─────┼─────┤
 163    *                │Exit │     │     │  A  │  O  │           │  E  │  U  │     │     │     │
 164    *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
 165    */
 166   [STENO_LAYER] = LAYOUT_planck_grid(
 167     PV_NUM,  PV_NUM,  PV_NUM,  PV_NUM, PV_NUM, PV_NUM,  PV_NUM,  PV_NUM, PV_NUM, PV_NUM,  PV_NUM,  PV_NUM,
 168     PV_LOOK, PV_LS,   PV_LT,   PV_LP,  PV_LH,  PV_STAR, PV_STAR, PV_RF,  PV_RP,  PV_RL,   PV_RT,   PV_RD,
 169     PV_LOOK, PV_LS,   PV_LK,   PV_LW,  PV_LR,  PV_STAR, PV_STAR, PV_RR,  PV_RB,  PV_RG,   PV_RS,   PV_RZ,
 170     PV_EXIT, XXXXXXX, XXXXXXX, PV_A,   PV_O,   KC_SPC,  KC_BSPC, PV_E,   PV_U,   XXXXXXX, XXXXXXX, XXXXXXX
 171   ),
 172
 173   /* Keyboard settings layer
 174    *                ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
 175    *    Firmware -- │     │Reset│Make │     │     │     │     │     │     │     │Vers │     │
 176    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 177    *             -- │Qwert│     │     │     │     │     │     │     │     │     │     │     │
 178    *                ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 179    *       Audio -- │     │Voic-│Voic+│Mus +│Mus -│MIDI+│MIDI-│     │     │Aud +│Aud -│     │
 180    *                ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
 181    *                │Steno│     │Swap │Norm │     │           │     │     │     │     │     │
 182    *                └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
 183    *               Swap GUI/Alt _/________/             \_____________\_           _/
 184    */
 185   [ADJUST_LAYER] = LAYOUT_planck_grid(
 186     XXXXXXX, RESET,   SEND_MAKE, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, SEND_VERSION, XXXXXXX,
 187     QWERTY,  XXXXXXX, XXXXXXX,   XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,      XXXXXXX,
 188     XXXXXXX, MUV_DE,  MUV_IN,    MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  XXXXXXX, XXXXXXX, AU_ON,   AU_OFF,       XXXXXXX,
 189     STENO,   XXXXXXX, AG_SWAP,   AG_NORM, LOWER,   XXXXXXX, XXXXXXX, RAISE,   XXXXXXX, XXXXXXX, XXXXXXX,      XXXXXXX
 190   )
 191 };
 192
 193 #ifdef AUDIO_ENABLE
 194 float plover_song[][2]    = SONG(PLOVER_SOUND);
 195 float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
 196 #endif
 197
 198 // Send PHROPB ({PLOVER:RESUME}).
 199 void plover_resume(void) {
 200   register_code(PV_LP);
 201   register_code(PV_LH);
 202   register_code(PV_LR);
 203   register_code(PV_O);
 204   register_code(PV_RP);
 205   register_code(PV_RB);
 206   unregister_code(PV_LP);
 207   unregister_code(PV_LH);
 208   unregister_code(PV_LR);
 209   unregister_code(PV_O);
 210   unregister_code(PV_RP);
 211   unregister_code(PV_RB);
 212 }
 213
 214 // Send PHROF ({PLOVER:SUSPEND}).
 215 void plover_suspend(void) {
 216   register_code(PV_LP);
 217   register_code(PV_LH);
 218   register_code(PV_LR);
 219   register_code(PV_O);
 220   register_code(PV_RF);
 221   unregister_code(PV_LP);
 222   unregister_code(PV_LH);
 223   unregister_code(PV_LR);
 224   unregister_code(PV_O);
 225   unregister_code(PV_RF);
 226 }
 227
 228 // Send PHROBG ({PLOVER:LOOKUP}).
 229 void plover_lookup(void) {
 230   register_code(PV_LP);
 231   register_code(PV_LH);
 232   register_code(PV_LR);
 233   register_code(PV_O);
 234   register_code(PV_RB);
 235   register_code(PV_RG);
 236   unregister_code(PV_LP);
 237   unregister_code(PV_LH);
 238   unregister_code(PV_LR);
 239   unregister_code(PV_O);
 240   unregister_code(PV_RB);
 241   unregister_code(PV_RG);
 242 }
 243
 244 uint32_t layer_state_set_user(uint32_t state) {
 245   return update_tri_layer_state(state, LOWER_LAYER, RAISE_LAYER, ADJUST_LAYER);
 246 }
 247
 248 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 249   switch (keycode) {
 250     case STENO:
 251       if (record->event.pressed) {
 252 #ifdef AUDIO_ENABLE
 253         stop_all_notes();
 254         PLAY_SONG(plover_song);
 255 #endif
 256         layer_off(RAISE_LAYER);
 257         layer_off(LOWER_LAYER);
 258         layer_off(ADJUST_LAYER);
 259         layer_on(STENO_LAYER);
 260         if (!eeconfig_is_enabled()) {
 261           eeconfig_init();
 262         }
 263         keymap_config.raw = eeconfig_read_keymap();
 264         keymap_config.nkro = 1;
 265         eeconfig_update_keymap(keymap_config.raw);
 266         plover_resume();
 267       }
 268       return false;
 269     case PV_EXIT:
 270       if (record->event.pressed) {
 271 #ifdef AUDIO_ENABLE
 272         PLAY_SONG(plover_gb_song);
 273 #endif
 274         plover_suspend();
 275         layer_off(STENO_LAYER);
 276       }
 277       return false;
 278     case PV_LOOK:
 279       if (record->event.pressed) {
 280         plover_lookup();
 281       }
 282       return false;
 283     case SEND_VERSION:
 284       if (record->event.pressed) {
 285         SEND_STRING(QMK_KEYBOARD "/" QMK_KEYMAP "@" QMK_VERSION " (" QMK_BUILDDATE ")");
 286       }
 287       return false;
 288     case SEND_MAKE:
 289       if (record->event.pressed) {
 290         SEND_STRING("make " QMK_KEYBOARD ":" QMK_KEYMAP ":dfu\n");
 291       }
 292       return false;
 293   }
 294   return true;
 295 }