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