keyboards/ergodox/keymaps/workman_osx_mdw/keymap.c

   1 #include "ergodox_ez.h"
   2 #include "debug.h"
   3 #include "action_layer.h"
   4 // readme
   5 // This keyboard layout is based on the [Workman Dead layout](https://github.com/ojbucao/Workman/tree/master/mac#workman-dead-for-programmers), which uses the comma as a dead key to trigger a second layer.
   6 // Since I have more keys at my disposal on the ErgoDox, I moved the dead key to the bottom right. There are still a lot of
   7 // blanks so still discovering what I like.
   8 // If you aren't familiar with a dead key, the idea is that you tap the dead key which switches the layout. the next key you hit
   9 // triggers the key you pressed AND switches the layout back to the original. For now I do this with a super kludgey macro and I
  10 // look forward to learning about a more elegant way to do the same thing. Until then, this will have to do.
  11
  12
  13 // TODO: Define layer names that make sense for the ErgoDox EZ.
  14 #define BASE 0 // default layer
  15 #define SYMB 1 // symbols
  16 #define MDIA 2 // media keys
  17 #define DEAD 3 // dead version of the symbols layer
  18
  19 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  20 /* Keymap 0: Basic layer
  21  *
  22  * ,--------------------------------------------------.           ,--------------------------------------------------.
  23  * |   `    |   1  |   2  |   3  |   4  |   5  | LEFT |           | RIGHT|   6  |   7  |   8  |   9  |   0  |   -    |
  24  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  25  * | Tab    |   Q  |   D  |   R  |   W  |   B  |  L1  |           |  L1  |   J  |   F  |   U  |   P  |   ;  |        |
  26  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  27  * | Hyper  |   A  |   S  |   H  |   T  |   G  |------|           |------|   Y  |   N  |   E  |   O  |   I  |   '    |
  28  * |--------+------+------+------+------+------|      |           | Meh  |------+------+------+------+------+--------|
  29  * | LShift |   Z  |   X  |   M  |   C  |   V  |      |           |      |   K  |   L  |   ,  |   .  |//Ctrl| RShift |
  30  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  31  *   |      |      | CTRL |  OPT |  CMD |                                       | Left | Down |  Up  | Right|  L3  |
  32  *   `----------------------------------'                                       `----------------------------------'
  33  *                                        ,-------------.       ,-------------.
  34  *                                        |      |      |       |      |        |
  35  *                                 ,------|------|------|       |------+--------+------.
  36  *                                 |      |      | Home |       | PgUp |        |      |
  37  *                                 |Bckspc| Space|------|       |------| Space  |Enter |
  38  *                                 |      |      | End  |       | PgDn |        |      |
  39  *                                 `--------------------'       `----------------------'
  40  */
  41 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
  42 // Otherwise, it needs KC_*
  43 [BASE] = KEYMAP(  // layer 0 : default
  44         // left hand
  45         KC_GRV,         KC_1,         KC_2,   KC_3,   KC_4,   KC_5,   KC_LEFT,
  46         KC_TAB,         KC_Q,         KC_D,   KC_R,   KC_W,   KC_B,   TG(1),
  47         ALL_T(KC_ESC),  KC_A,         KC_S,   KC_H,   KC_T,   KC_G,
  48         KC_LSFT,        KC_Z,         KC_X,   KC_M,   KC_C,   KC_V,   KC_NO,
  49         KC_NO,          KC_NO,        KC_LCTL,KC_LALT,KC_LGUI,
  50                                               KC_NO,  KC_NO,
  51                                                               KC_HOME,
  52                                                KC_BSPC,KC_SPC,KC_END,
  53         // right hand
  54              KC_RGHT,     KC_6,   KC_7,   KC_8,   KC_9,   KC_0,             KC_MINS,
  55              TG(1),       KC_J,   KC_F,   KC_U,   KC_P,   KC_SCLN,          KC_BSLS,
  56                           KC_Y,   KC_N,   KC_E,   KC_O,   KC_I,             KC_QUOT,
  57              MEH_T(KC_NO),KC_K,   KC_L,   KC_COMM,KC_DOT, CTL_T(KC_SLSH),   KC_RSFT,
  58                                   KC_LEFT,KC_DOWN,KC_UP,  KC_RGHT,          KC_FN4,
  59              KC_NO,        KC_NO,
  60              KC_PGUP,
  61              KC_PGDN,KC_SPC,KC_ENT
  62     ),
  63 /* Keymap 1: Symbol Layer
  64  *
  65  * ,--------------------------------------------------.           ,--------------------------------------------------.
  66  * |        |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
  67  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  68  * |        |   %  |   &  |   ?  |   +  |   @  |      |           |      |   $  |   _  |   [  |   ]  |   !  |   F12  |
  69  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  70  * |        |   /  |   (  |   =  |   0  |   {  |------|           |------|   }  |   1  |   *  |   )  |   -  |   "    |
  71  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  72  * |        |   6  |   7  |   8  |   9  |   |  |      |           |      |   \  |   2  |   3  |   4  |   5  |        |
  73  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  74  *   |      |      |      |      |      |                                       |      |      |      |      |      |
  75  *   `----------------------------------'                                       `----------------------------------'
  76  *                                        ,-------------.       ,-------------.
  77  *                                        |      |      |       |      |      |
  78  *                                 ,------|------|------|       |------+------+------.
  79  *                                 |      |      |      |       |      |      |      |
  80  *                                 |      |      |------|       |------|      |      |
  81  *                                 |      |      |      |       |      |      |      |
  82  *                                 `--------------------'       `--------------------'
  83  */
  84 // SYMBOLS
  85 [SYMB] = KEYMAP(
  86        // left hand
  87        KC_TRNS,   KC_F1,    KC_F2,    KC_F3,          KC_F4,        KC_F5,          KC_TRNS,
  88        KC_TRNS,   KC_PERC,  KC_AMPR,  LSFT(KC_SLSH),  LSFT(KC_EQL), KC_AT,          KC_TRNS,
  89        KC_TRNS,   KC_SLSH,  KC_LPRN,  KC_EQL,         KC_0,     LSFT(KC_LBRC),
  90        KC_TRNS,   KC_6,     KC_7,     KC_8,           KC_9,     KC_PIPE,        KC_TRNS,
  91        KC_TRNS,   KC_TRNS,  KC_TRNS,  KC_TRNS,        KC_TRNS,
  92                                        KC_TRNS,KC_TRNS,
  93                                                KC_TRNS,
  94                                KC_TRNS,KC_TRNS,KC_TRNS,
  95        // right hand
  96        KC_TRNS, KC_F6,          KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F11,
  97        KC_TRNS, KC_DLR,         KC_UNDERSCORE,  KC_LBRC,  KC_RBRC,  KC_EXLM,  KC_F12,
  98                 KC_RCBR,        KC_1,     KC_ASTR,  KC_RPRN,  KC_MINS,  KC_QUOT,
  99        KC_TRNS, KC_SLSH,        KC_2,     KC_3,     KC_4,     KC_5,     KC_TRNS,
 100                                 KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
 101        KC_TRNS, KC_TRNS,
 102        KC_TRNS,
 103        KC_TRNS, KC_TRNS, KC_TRNS
 104 ),
 105 /* Keymap 2: Media and mouse keys
 106  *
 107  * ,--------------------------------------------------.           ,--------------------------------------------------.
 108  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 109  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 110  * |        |      |      | MsUp |      |      |      |           |      |      |      |      |      |      |        |
 111  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 112  * |        |      |MsLeft|MsDown|MsRght|      |------|           |------|      |      |      |      |      |  Play  |
 113  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 114  * |        |      |      |      |      |      |      |           |      |      |      | Prev | Next |      |        |
 115  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 116  *   |      |      |      | Lclk | Rclk |                                       |VolUp |VolDn | Mute |      |      |
 117  *   `----------------------------------'                                       `----------------------------------'
 118  *                                        ,-------------.       ,-------------.
 119  *                                        |      |      |       |      |      |
 120  *                                 ,------|------|------|       |------+------+------.
 121  *                                 |      |      |      |       |      |      |Brwser|
 122  *                                 |      |      |------|       |------|      |Back  |
 123  *                                 |      |      |      |       |      |      |      |
 124  *                                 `--------------------'       `--------------------'
 125  */
 126 // MEDIA AND MOUSE
 127 [MDIA] = KEYMAP(
 128        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 129        KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_TRNS,
 130        KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
 131        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 132        KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN2,
 133                                            KC_TRNS, KC_TRNS,
 134                                                     KC_TRNS,
 135                                   KC_TRNS, KC_TRNS, KC_TRNS,
 136     // right hand
 137        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 138        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 139                  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MPLY,
 140        KC_TRNS,  KC_TRNS, KC_TRNS, KC_MPRV, KC_MNXT, KC_TRNS, KC_TRNS,
 141                           KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS,
 142        KC_TRNS, KC_TRNS,
 143        KC_TRNS,
 144        KC_TRNS, KC_TRNS, KC_WBAK
 145 ),
 146 /* Keymap 4: Dead Symbol Layer
 147  *
 148  * ,--------------------------------------------------.           ,--------------------------------------------------.
 149  * |        |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
 150  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 151  * |        |  %   |   &  |   ?  |   +  |   @  |      |           |      |   $  |   _  |   [  |   ]  |   !  |   F12  |
 152  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 153  * |        |   /  |   (  |   =  |   0  |   {  |------|           |------|   }  |   1  |   *  |   )  |   -  |   "    |
 154  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 155  * |        |   6  |   7  |   8  |   9  |   |  |      |           |      |   \  |   2  |   3  |   4  |   5  |        |
 156  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 157  *   |      |      |      |      |      |                                       |      |      |      |      |      |
 158  *   `----------------------------------'                                       `----------------------------------'
 159  *                                        ,-------------.       ,-------------.
 160  *                                        |      |      |       |      |      |
 161  *                                 ,------|------|------|       |------+------+------.
 162  *                                 |      |      |      |       |      |      |      |
 163  *                                 |      |      |------|       |------|      |      |
 164  *                                 |      |      |      |       |      |      |      |
 165  *                                 `--------------------'       `--------------------'
 166  */
 167 // SYMBOLS
 168 [DEAD] = KEYMAP(
 169        // left hand
 170        KC_TRNS,   KC_F1,    KC_F2,    KC_F3,      KC_F4,    KC_F5,          KC_TRNS,
 171        KC_TRNS,   M(100),   M(101),   M(102),     M(103),   M(104),         KC_TRNS,
 172        KC_TRNS,   M(109),  M(110),  M(111),       M(112),   M(113),
 173        KC_TRNS,   M(120),     M(121),     M(122),           M(123),     M(124),        KC_TRNS,
 174        KC_TRNS,   KC_TRNS,  KC_TRNS,  KC_TRNS,        KC_TRNS,
 175                                        KC_TRNS,KC_TRNS,
 176                                                KC_TRNS,
 177                                KC_TRNS,KC_TRNS,KC_TRNS,
 178        // right hand
 179        KC_TRNS, KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F11,
 180        KC_TRNS, M(105),   M(106),   M(107),   M(108),   M(130),   KC_F12,
 181                 M(114),   M(115),   M(116),   M(117),   M(118),   M(119),
 182        KC_TRNS, M(125),   M(126),   M(127),   M(128),   M(129),   KC_TRNS,
 183                           KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
 184        KC_TRNS, KC_TRNS,
 185        KC_TRNS,
 186        KC_TRNS, KC_TRNS, KC_TRNS
 187 ),
 188 };
 189
 190 const uint16_t PROGMEM fn_actions[] = {
 191     [1] = ACTION_LAYER_TAP_TOGGLE(SYMB),                // FN1 - Momentary Layer 1 (Symbols)
 192     [2] = ACTION_LAYER_ON(BASE,0),                       // FN2 - Go back to the base layer
 193     [3] = ACTION_LAYER_ON(DEAD,0),
 194     [4] = ACTION_LAYER_TOGGLE(DEAD),
 195 };
 196
 197 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 198 {
 199   // MACRODOWN only works in this function
 200       switch(id) {
 201         case 0:
 202           if (record->event.pressed) {
 203             register_code(KC_RSFT);
 204           } else {
 205             unregister_code(KC_RSFT);
 206           }
 207           break;
 208         case 100:
 209           layer_clear();
 210           return MACRODOWN(D(LSFT), T(5), U(LSFT), T(FN4), END);
 211           break;
 212         case 101:
 213           layer_clear();
 214           return MACRODOWN(D(LSFT), T(7), U(LSFT), T(FN4), END);
 215           break;
 216         case 102:
 217           layer_clear();
 218           return MACRODOWN(D(LSFT), T(SLSH), U(LSFT), T(FN4), END);
 219           break;
 220         case 103:
 221           layer_clear();
 222           return MACRODOWN(D(LSFT), T(EQL), U(LSFT), T(FN4), END);
 223           break;
 224         case 104:
 225           layer_clear();
 226           return MACRODOWN(D(LSFT), T(2), U(LSFT), T(FN4), END);
 227           break;
 228         case 105:
 229           layer_clear();
 230           return MACRODOWN(D(LSFT), T(4), U(LSFT), T(FN4), END);
 231           break;
 232         case 106:
 233           layer_clear();
 234           return MACRODOWN(D(LSFT), T(MINS), U(LSFT), T(FN4), END);
 235           break;
 236         case 107:
 237           layer_clear();
 238           return MACRODOWN(T(LBRC), T(FN4), END);
 239           break;
 240         case 108:
 241           layer_clear();
 242           return MACRODOWN(T(RBRC), T(FN4), END);
 243           break;
 244         case 130:
 245           layer_clear();
 246           return MACRODOWN(D(LSFT), T(1), U(LSFT), T(FN4), END);
 247           break;
 248         case 109:
 249           layer_clear();
 250           return MACRODOWN(T(SLSH), T(FN4), END);
 251           break;
 252         case 110:
 253           layer_clear();
 254           return MACRODOWN(D(LSFT), T(9), U(LSFT), T(FN4), END);
 255           break;
 256         case 111:
 257           layer_clear();
 258           return MACRODOWN(T(EQL), T(FN4), END);
 259           break;
 260         case 112:
 261           layer_clear();
 262           return MACRODOWN(T(0), T(FN4), END);
 263           break;
 264         case 113:
 265           layer_clear();
 266           return MACRODOWN(D(LSFT), T(LBRC), U(LSFT), T(FN4), END);
 267           break;
 268         case 114:
 269           layer_clear();
 270           return MACRODOWN(D(LSFT), T(RBRC), U(LSFT), T(FN4), END);
 271           break;
 272         case 115:
 273           layer_clear();
 274           return MACRODOWN(T(1), T(FN4), END);
 275           break;
 276         case 116:
 277           layer_clear();
 278           return MACRODOWN(D(LSFT), T(8), U(LSFT), T(FN4), END);
 279           break;
 280         case 117:
 281           layer_clear();
 282           return MACRODOWN(D(LSFT), T(0), U(LSFT), T(FN4), END);
 283           break;
 284         case 118:
 285           layer_clear();
 286           return MACRODOWN(T(MINS), T(FN4), END);
 287           break;
 288         case 119:
 289           layer_clear();
 290           return MACRODOWN(D(LSFT), T(QUOT), U(LSFT), T(FN4), END);
 291           break;
 292         case 120:
 293           layer_clear();
 294           return MACRODOWN(T(6), T(FN4), END);
 295           break;
 296         case 121:
 297           layer_clear();
 298           return MACRODOWN(T(7), T(FN4), END);
 299           break;
 300         case 122:
 301           layer_clear();
 302           return MACRODOWN(T(8), T(FN4), END);
 303           break;
 304         case 123:
 305           layer_clear();
 306           return MACRODOWN(T(9), T(FN4), END);
 307           break;
 308         case 124:
 309           layer_clear();
 310           return MACRODOWN(D(LSFT), T(BSLS), U(LSFT), T(FN4), END);
 311           break;
 312         case 125:
 313           layer_clear();
 314           return MACRODOWN(T(BSLS), T(FN4), END);
 315           break;
 316         case 126:
 317           layer_clear();
 318           return MACRODOWN(T(2), T(FN4), END);
 319           break;
 320         case 127:
 321           layer_clear();
 322           return MACRODOWN(T(3), T(FN4), END);
 323           break;
 324         case 128:
 325           layer_clear();
 326           return MACRODOWN(T(4), T(FN4), END);
 327           break;
 328         case 129:
 329           layer_clear();
 330           return MACRODOWN(T(5), T(FN4), END);
 331           break;
 332
 333         default:
 334         return MACRO_NONE;
 335       }
 336   return MACRO_NONE;
 337 };
 338
 339 // Runs just one time when the keyboard initializes.
 340 void matrix_init_user(void) {
 341
 342 };
 343
 344 // Runs constantly in the background, in a loop.
 345 void matrix_scan_user(void) {
 346
 347     uint8_t layer = biton32(layer_state);
 348
 349     ergodox_board_led_off();
 350     ergodox_right_led_1_off();
 351     ergodox_right_led_2_off();
 352     ergodox_right_led_3_off();
 353     switch (layer) {
 354       // TODO: Make this relevant to the ErgoDox EZ.
 355         case 1:
 356             ergodox_right_led_1_on();
 357             break;
 358         case 2:
 359             ergodox_right_led_2_on();
 360             break;
 361         default:
 362             // none
 363             break;
 364     }
 365
 366 };