layouts/community/ergodox/qwerty_code_friendly/keymap.c

   1 #include QMK_KEYBOARD_H
   2 #include "debug.h"
   3 #include "action_layer.h"
   4 #include "version.h"
   5
   6 /**
   7  * See `readme.md` for notes on each define.
   8  */
   9
  10 // Personal preference (enable by passing EXTRAFLAGS=... to make).
  11 // #define CFQ_USE_MOMENTARY_LAYER_KEYS
  12 // #define CFQ_USE_EXPEREMENTAL_LAYER
  13
  14 #if !defined(CFQ_USER_KEY1)
  15 #define CFQ_USER_KEY1 KC_F13
  16 #endif
  17 #if !defined(CFQ_USER_KEY2)
  18 #define CFQ_USER_KEY2 KC_APP
  19 #endif
  20
  21 #define BASE 0 // default layer
  22 #define SYMB 1 // symbols
  23 #define MDIA 2 // media keys
  24 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
  25 #define EXPR 3 // experimental keys
  26 #endif
  27
  28 enum custom_keycodes {
  29   PLACEHOLDER = SAFE_RANGE, // can always be here
  30   EPRM,
  31   VRSN,
  32   RGB_SLD
  33 };
  34
  35 // macros
  36 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
  37 #define M_SPACES_1 2
  38 #define M_SPACES_2 3
  39 #define M_SPACES_3 4
  40 #define M_SPACES_4 5
  41 #define M_SPACES_5 6
  42 #define M_SPACES_6 7
  43 #define M_SPACES_7 8
  44 #define M_SPACES_8 9
  45 #endif
  46 #define M_BRACKET_IN_CBR 10
  47 #define M_BRACKET_IN_PRN 11
  48 #define M_BRACKET_IN_BRC 12
  49 #define M_BRACKET_IN_ANG 13
  50 #define M_BRACKET_OUT_CBR 14
  51 #define M_BRACKET_OUT_PRN 15
  52 #define M_BRACKET_OUT_BRC 16
  53 #define M_BRACKET_OUT_ANG 17
  54 #define M_ARROW_RMINUS 18
  55 #define M_ARROW_LMINUS 19
  56 #define M_ARROW_REQL 20
  57 #define M_ARROW_LEQL 21
  58
  59 #ifdef CFQ_USE_MOMENTARY_LAYER_KEYS
  60 #define CFQ_KC_FN1 MO(1)
  61 #define CFQ_KC_FN2 MO(2)
  62 #define CFQ_KC_FN3 MO(3)
  63 #else
  64 #define CFQ_KC_FN1 KC_FN1
  65 #define CFQ_KC_FN2 KC_FN2
  66 #define CFQ_KC_FN3 KC_FN3
  67 #endif
  68
  69 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  70 /* Keymap 0: Basic layer
  71  * ,--------------------------------------------------.           ,--------------------------------------------------.
  72  * | Grave  |   !  |   @  |   #  |   $  |   %  |   {  |           |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
  73  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  74  * | Tab    |   Q  |   W  |   E  |   R  |   T  |   (  |           |  )   |   Y  |   U  |   I  |   O  |   P  |   \    |
  75  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  76  * | Esc    |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
  77  * |--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
  78  * | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
  79  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  80  *   | LCtl |Super | Alt  | USR2 |Space |                                       | Left | Down | Up   |Right | Del  |
  81  *   `----------------------------------'                                       `----------------------------------'
  82  *                                        ,-------------.       ,-------------.
  83  *                                        | Ins  | ~L3  |       | Home | End  |
  84  *                                 ,------|------|------|       |------+------+------.
  85  *                                 |      |      | ~L2  |       | PgUp |      |      |
  86  *                                 |Space | USR1 |------|       |------|Enter |Space |
  87  *                                 |      |      | ~L1  |       | PgDn |      |      |
  88  *                                 `--------------------'       `--------------------'
  89  */
  90 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
  91 // Otherwise, it needs KC_*
  92 [BASE] = LAYOUT_ergodox(  // layer 0 : default
  93   // left hand
  94   KC_GRV,  KC_EXLM, KC_AT,   KC_HASH,       KC_DLR, KC_PERC, KC_LCBR,
  95   KC_TAB,  KC_Q,    KC_W,    KC_E,          KC_R,   KC_T,    KC_LPRN,
  96   KC_ESC,  KC_A,    KC_S,    KC_D,          KC_F,   KC_G,
  97   KC_LSFT, KC_Z,    KC_X,    KC_C,          KC_V,   KC_B,    KC_LBRC,
  98   KC_LCTL, KC_LGUI, KC_LALT, CFQ_USER_KEY2, KC_SPC,
  99                                                     KC_INS,        CFQ_KC_FN3,
 100                                                                    CFQ_KC_FN2,
 101                                             KC_SPC, CFQ_USER_KEY1, CFQ_KC_FN1,
 102   // right hand
 103   KC_RCBR,     KC_CIRC, KC_AMPR, KC_ASTR,KC_MINS, KC_EQL,    KC_BSPC,
 104   KC_RPRN,     KC_Y,    KC_U,    KC_I,   KC_O,    KC_P,      KC_BSLS,
 105                KC_H,    KC_J,    KC_K,   KC_L,    KC_SCLN,   KC_QUOT,
 106   KC_RBRC,     KC_N,    KC_M,    KC_COMM,KC_DOT,  KC_SLSH,   KC_RSFT,
 107                         KC_LEFT, KC_DOWN,KC_UP,   KC_RGHT,   KC_DELT,
 108   KC_HOME, KC_END,
 109   KC_PGUP,
 110 #ifdef CFQ_USE_SWAP_RIGHT_SPACE_ENTER
 111   KC_PGDN, KC_SPC, KC_ENT
 112 #else
 113   KC_PGDN, KC_ENT, KC_SPC
 114 #endif
 115 ),
 116 /* Keymap 1: Symbol layer
 117  *
 118  * ,--------------------------------------------------.           ,--------------------------------------------------.
 119  * |        |  F1  |  F2  |  F3  |  F4  |  F5  |  {}  |           |  }{  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
 120  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 121  * |        |      |      |      |      |  =>  |  ()  |           |  )(  |  <=  |   7  |   8  |   9  |   \  |   F11  |
 122  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 123  * |        |      |      |      |      |  ->  |------|           |------|  <-  |   4  |   5  |   6  |   *  |   F12  |
 124  * |--------+------+------+------+------+------|  []  |           |  ][  |------+------+------+------+------+--------|
 125  * |        |      |      |      |      |  <>  |      |           |      |  ><  |   1  |   2  |   3  |   -  |        |
 126  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 127  *   |      |      |      |      |      |                                       |   0  |      |   .  |   +  |      |
 128  *   `----------------------------------'                                       `----------------------------------'
 129  *                                        ,-------------.       ,---------------.
 130  *                                        |      |      |       |      |        |
 131  *                                 ,------|------|------|       |------+--------+------.
 132  *                                 |      |      |      |       |      |        |      |
 133  *                                 |      |      |------|       |------|        |      |
 134  *                                 |      |      |      |       |      |        |      |
 135  *                                 `--------------------'       `----------------------'
 136  */
 137 // SYMBOLS
 138 [SYMB] = LAYOUT_ergodox(
 139   // left hand
 140   KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,               M(M_BRACKET_IN_CBR),
 141   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_ARROW_REQL),     M(M_BRACKET_IN_PRN),
 142   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_ARROW_RMINUS),
 143   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_BRACKET_IN_ANG), M(M_BRACKET_IN_BRC),
 144   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 145                                       KC_TRNS, KC_TRNS,
 146                                                KC_TRNS,
 147                              KC_TRNS, KC_TRNS, KC_TRNS,
 148   // right hand
 149   M(M_BRACKET_OUT_CBR), KC_F6,                KC_F7,   KC_F8,   KC_F9,     KC_F10,         KC_TRNS,
 150   M(M_BRACKET_OUT_PRN), M(M_ARROW_LEQL),      KC_KP_7, KC_KP_8, KC_KP_9,   KC_KP_SLASH,    KC_F11,
 151                         M(M_ARROW_LMINUS),    KC_KP_4, KC_KP_5, KC_KP_6,   KC_KP_ASTERISK, KC_F12,
 152   M(M_BRACKET_OUT_BRC), M(M_BRACKET_OUT_ANG), KC_KP_1, KC_KP_2, KC_KP_3,   KC_KP_MINUS,    KC_TRNS,
 153                                               KC_KP_0, KC_TRNS, KC_KP_DOT, KC_KP_PLUS,     KC_TRNS,
 154   KC_TRNS, KC_TRNS,
 155   KC_TRNS,
 156   KC_TRNS, KC_TRNS, KC_TRNS
 157 ),
 158 /* Keymap 2: Media and mouse keys
 159  *
 160  * ,--------------------------------------------------.           ,--------------------------------------------------.
 161  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 162  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 163  * |        |      |      | MsUp |      |      |      |           |      |      |      |      |      |      |        |
 164  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 165  * |        |      |MsLeft|MsDown|MsRght|      |------|           |------| Left | Down | Up   |Right |      |        |
 166  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 167  * |        |      | Rclk | Mclk | Lclk |      |      |           |      |      |      |      |      |      |        |
 168  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 169  *   |      |      |      |      |      |                                       |      |      |      |      |      |
 170  *   `----------------------------------'                                       `----------------------------------'
 171  *                                        ,-------------.       ,-------------.
 172  *                                        | MRwd | MFwd |       | MPrv | MNxt |
 173  *                                 ,------|------|------|       |------+------+------.
 174  *                                 |      |      |      |       |VolUp |      |      |
 175  *                                 |      |      |------|       |------| Mute | Play |
 176  *                                 |      |      |      |       |VolDn |      |      |
 177  *                                 `--------------------'       `--------------------'
 178  */
 179 // MEDIA AND MOUSE
 180 [MDIA] = LAYOUT_ergodox(
 181   // left hand
 182   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 183   KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_TRNS,
 184   KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
 185   KC_TRNS, KC_TRNS, KC_BTN2, KC_BTN3, KC_BTN1, KC_TRNS, KC_TRNS,
 186   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 187                                       KC_MRWD, KC_MFFD,
 188                                                KC_TRNS,
 189                              KC_TRNS, KC_TRNS, KC_TRNS,
 190   // right hand
 191   KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 192   KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 193             KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_TRNS, KC_TRNS,
 194   KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 195                      KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 196   KC_MPRV, KC_MNXT,
 197   KC_VOLU,
 198   KC_VOLD, KC_MUTE, KC_MPLY
 199 ),
 200 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
 201 /* Keymap 3: My own testing keys!
 202  *
 203  * ,--------------------------------------------------.           ,--------------------------------------------------.
 204  * |        | Spc1 | Spc2 | Spc3 | Spc4 | Spc5 |      |           |      | Spc6 | Spc7 | Spc8 |      |      |        |
 205  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 206  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 207  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 208  * |        |      |      |      |      |      |------|           |------|      |      |      |      |      |        |
 209  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 210  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 211  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 212  *   |      |      |      |      |      |                                       |      |      |      |      |      |
 213  *   `----------------------------------'                                       `----------------------------------'
 214  *                                        ,-------------.       ,-------------.
 215  *                                        |      |      |       |      |      |
 216  *                                 ,------|------|------|       |------+------+------.
 217  *                                 |      |      |      |       |      |      |      |
 218  *                                 |      |      |------|       |------|      |      |
 219  *                                 |      |      |      |       |      |      |      |
 220  *                                 `--------------------'       `--------------------'
 221  */
 222
 223 // EXPEREMENT
 224 [EXPR] = LAYOUT_ergodox(
 225   // left hand
 226   KC_TRNS, M(M_SPACES_1), M(M_SPACES_2), M(M_SPACES_3), M(M_SPACES_4), M(M_SPACES_5), KC_TRNS,
 227   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,                               KC_TRNS,
 228   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 229   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,                               KC_TRNS,
 230   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 231                                       KC_TRNS, KC_TRNS,
 232                                                KC_TRNS,
 233                              KC_TRNS, KC_TRNS, KC_TRNS,
 234   // right hand
 235   KC_TRNS, M(M_SPACES_6), M(M_SPACES_7), M(M_SPACES_8), KC_TRNS, KC_TRNS, KC_TRNS,
 236   KC_TRNS, KC_TRNS,       KC_TRNS,       KC_TRNS,       KC_TRNS, KC_TRNS, KC_TRNS,
 237            KC_TRNS,       KC_TRNS,       KC_TRNS,       KC_TRNS, KC_TRNS, KC_TRNS,
 238   KC_TRNS, KC_TRNS,       KC_TRNS,       KC_TRNS,       KC_TRNS, KC_TRNS, KC_TRNS,
 239   KC_TRNS, KC_TRNS,       KC_TRNS,       KC_TRNS,       KC_TRNS,
 240   KC_TRNS, KC_TRNS,
 241   KC_TRNS,
 242   KC_TRNS, KC_TRNS, KC_TRNS
 243 ),
 244 #endif // CFQ_USE_EXPEREMENTAL_LAYER
 245 };
 246
 247 const uint16_t PROGMEM fn_actions[] = {
 248   [1] = ACTION_LAYER_TAP_TOGGLE(SYMB),               // FN1 - Momentary Layer 1 (Symbols)
 249   [2] = ACTION_LAYER_TAP_TOGGLE(MDIA),               // FN2 - Momentary Layer 2 (Media)
 250 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
 251   [3] = ACTION_LAYER_TAP_TOGGLE(EXPR),               // FN3 - Momentary Layer 3 (Expremental)
 252 #endif
 253 };
 254
 255 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 256 {
 257   // MACRODOWN only works in this function
 258   switch(id) {
 259     case 0:
 260     if (record->event.pressed) {
 261       SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
 262     }
 263     break;
 264     case 1:
 265     if (record->event.pressed) { // For resetting EEPROM
 266       eeconfig_init();
 267     }
 268     break;
 269 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
 270     case M_SPACES_1:
 271       if (record->event.pressed) { return MACRO(T(SPC), END); }
 272     case M_SPACES_2:
 273       if (record->event.pressed) { return MACRO(T(SPC), T(SPC), END); }
 274     case M_SPACES_3:
 275       if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), END); }
 276     case M_SPACES_4:
 277       if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), END); }
 278     case M_SPACES_5:
 279       if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
 280     case M_SPACES_6:
 281       if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
 282     case M_SPACES_7:
 283       if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
 284     case M_SPACES_8:
 285       if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
 286 #endif // CFQ_USE_EXPEREMENTAL_LAYER
 287     case M_BRACKET_IN_CBR: // {}
 288       if (record->event.pressed) { return MACRO(D(LSFT), T(LBRC), T(RBRC), U(LSFT), T(LEFT), END); }
 289     case M_BRACKET_IN_PRN: // ()
 290       if (record->event.pressed) { return MACRO(D(LSFT), T(9), T(0), U(LSFT), T(LEFT), END); }
 291     case M_BRACKET_IN_BRC: // []
 292       if (record->event.pressed) { return MACRO(T(LBRC), T(RBRC), T(LEFT), END); }
 293     case M_BRACKET_IN_ANG: // <>
 294       if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), T(DOT), U(LSFT), T(LEFT), END); }
 295     case M_BRACKET_OUT_CBR: // }{
 296       if (record->event.pressed) { return MACRO(D(LSFT), T(RBRC), T(LBRC), U(LSFT), T(LEFT), END); }
 297     case M_BRACKET_OUT_PRN: // )(
 298       if (record->event.pressed) { return MACRO(D(LSFT), T(0), T(9), U(LSFT), T(LEFT), END); }
 299     case M_BRACKET_OUT_BRC: // ][
 300       if (record->event.pressed) { return MACRO(T(RBRC), T(LBRC), T(LEFT), END); }
 301     case M_BRACKET_OUT_ANG: // ><
 302       if (record->event.pressed) { return MACRO(D(LSFT), T(DOT), T(COMM), U(LSFT), T(LEFT), END); }
 303
 304     case M_ARROW_RMINUS:
 305       if (record->event.pressed) { return MACRO(T(MINUS), D(LSFT), T(DOT), U(LSFT), END); }
 306     case M_ARROW_LMINUS:
 307       if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), U(LSFT), T(MINUS), END); }
 308     case M_ARROW_REQL:
 309       if (record->event.pressed) { return MACRO(T(EQL), D(LSFT), T(DOT), U(LSFT), END); }
 310     case M_ARROW_LEQL:
 311       if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), U(LSFT), T(EQL), END); }
 312   }
 313   return MACRO_NONE;
 314 };
 315
 316 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 317   switch (keycode) {
 318     // dynamically generate these.
 319     case EPRM:
 320       if (record->event.pressed) {
 321         eeconfig_init();
 322       }
 323       return false;
 324       break;
 325     case VRSN:
 326       if (record->event.pressed) {
 327         SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
 328       }
 329       return false;
 330       break;
 331     case RGB_SLD:
 332       if (record->event.pressed) {
 333 #ifdef RGBLIGHT_ENABLE
 334         rgblight_mode(1);
 335 #endif
 336       }
 337       return false;
 338       break;
 339   }
 340   return true;
 341 }
 342
 343 // Runs just one time when the keyboard initializes.
 344 void matrix_init_user(void) {
 345
 346 };
 347
 348 // Runs constantly in the background, in a loop.
 349 void matrix_scan_user(void) {
 350
 351   uint8_t layer = biton32(layer_state);
 352
 353   ergodox_board_led_off();
 354   ergodox_right_led_1_off();
 355   ergodox_right_led_2_off();
 356   ergodox_right_led_3_off();
 357   switch (layer) {
 358     case 1:
 359       ergodox_right_led_1_on();
 360       break;
 361     case 2:
 362       ergodox_right_led_2_on();
 363       break;
 364 #ifdef CFQ_USE_EXPEREMENTAL_LAYER
 365     case 3:
 366       ergodox_right_led_3_on();
 367       break;
 368 #endif
 369     default:
 370       // none
 371       break;
 372   }
 373
 374 };