keyboards/ergodox/keymaps/default/keymap.c

   1 #include "ergodox.h"
   2 #include "debug.h"
   3 #include "action_layer.h"
   4 #include "version.h"
   5
   6 #define BASE 0 // default layer
   7 #define SYMB 1 // symbols
   8 #define MDIA 2 // media keys
   9 #define PLVR 3 // Plover layer
  10
  11 enum custom_keycodes {
  12   PLACEHOLDER = SAFE_RANGE, // can always be here
  13   EPRM,
  14   VRSN,
  15   RGB_SLD
  16 };
  17
  18 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  19 /* Keymap 0: Basic layer
  20  *
  21  * ,--------------------------------------------------.           ,--------------------------------------------------.
  22  * |   =    |   1  |   2  |   3  |   4  |   5  | LEFT |           | RIGHT|   6  |   7  |   8  |   9  |   0  |   -    |
  23  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  24  * | Del    |   Q  |   W  |   E  |   R  |   T  |  L1  |           |  L1  |   Y  |   U  |   I  |   O  |   P  |   \    |
  25  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  26  * | BkSp   |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |; / L2|' / Cmd |
  27  * |--------+------+------+------+------+------| Hyper|           | Meh  |------+------+------+------+------+--------|
  28  * | LShift |Z/Ctrl|   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |//Ctrl| RShift |
  29  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  30  *   |Grv/L1|  '"  |AltShf| Left | Right|                                       |  Up  | Down |   [  |   ]  | ~L1  |
  31  *   `----------------------------------'                                       `----------------------------------'
  32  *                                        ,-------------.       ,-------------.
  33  *                                        | App  | LGui |       | Alt  |Ctrl/Esc|
  34  *                                 ,------|------|------|       |------+--------+------.
  35  *                                 |      |      | Home |       | PgUp |        |      |
  36  *                                 | Space|Backsp|------|       |------|  Tab   |Enter |
  37  *                                 |      |ace   | End  |       | PgDn |        |      |
  38  *                                 `--------------------'       `----------------------'
  39  */
  40 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
  41 // Otherwise, it needs KC_*
  42 [BASE] = KEYMAP(  // layer 0 : default
  43         // left hand
  44         KC_EQL,         KC_1,         KC_2,   KC_3,   KC_4,   KC_5,   KC_LEFT,
  45         KC_DELT,        KC_Q,         KC_W,   KC_E,   KC_R,   KC_T,   TG(SYMB),
  46         KC_BSPC,        KC_A,         KC_S,   KC_D,   KC_F,   KC_G,
  47         KC_LSFT,        CTL_T(KC_Z),  KC_X,   KC_C,   KC_V,   KC_B,   ALL_T(KC_NO),
  48         LT(SYMB,KC_GRV),KC_QUOT,      LALT(KC_LSFT),  KC_LEFT,KC_RGHT,
  49                                               ALT_T(KC_APP),  KC_LGUI,
  50                                                               KC_HOME,
  51                                                KC_SPC,KC_BSPC,KC_END,
  52         // right hand
  53              KC_RGHT,     KC_6,   KC_7,  KC_8,   KC_9,   KC_0,             KC_MINS,
  54              TG(SYMB),    KC_Y,   KC_U,  KC_I,   KC_O,   KC_P,             KC_BSLS,
  55                           KC_H,   KC_J,  KC_K,   KC_L,   LT(MDIA, KC_SCLN),GUI_T(KC_QUOT),
  56              MEH_T(KC_NO),KC_N,   KC_M,  KC_COMM,KC_DOT, CTL_T(KC_SLSH),   KC_RSFT,
  57                                   KC_UP, KC_DOWN,KC_LBRC,KC_RBRC,          KC_FN1,
  58              KC_LALT,        CTL_T(KC_ESC),
  59              KC_PGUP,
  60              KC_PGDN,KC_TAB, KC_ENT
  61     ),
  62 /* Keymap 1: Symbol Layer
  63  *
  64  * ,---------------------------------------------------.           ,--------------------------------------------------.
  65  * |Version  |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
  66  * |---------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
  67  * |         |   !  |   @  |   {  |   }  |   |  |      |           |      |   Up |   7  |   8  |   9  |   *  |   F12  |
  68  * |---------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  69  * |         |   #  |   $  |   (  |   )  |   `  |------|           |------| Down |   4  |   5  |   6  |   +  |        |
  70  * |---------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  71  * |         |   %  |   ^  |   [  |   ]  |   ~  |      |           |      |   &  |   1  |   2  |   3  |   \  |        |
  72  * `---------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  73  *   | EPRM  |      |      |      |      |                                       |      |    . |   0  |   =  |      |
  74  *   `-----------------------------------'                                       `----------------------------------'
  75  *                                        ,-------------.       ,-------------.
  76  *                                        |Animat|      |       |Toggle|Solid |
  77  *                                 ,------|------|------|       |------+------+------.
  78  *                                 |Bright|Bright|      |       |      |Hue-  |Hue+  |
  79  *                                 |ness- |ness+ |------|       |------|      |      |
  80  *                                 |      |      |      |       |      |      |      |
  81  *                                 `--------------------'       `--------------------'
  82  */
  83 // SYMBOLS
  84 [SYMB] = KEYMAP(
  85        // left hand
  86        VRSN,   KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_TRNS,
  87        KC_TRNS,KC_EXLM,KC_AT,  KC_LCBR,KC_RCBR,KC_PIPE,KC_TRNS,
  88        KC_TRNS,KC_HASH,KC_DLR, KC_LPRN,KC_RPRN,KC_GRV,
  89        KC_TRNS,KC_PERC,KC_CIRC,KC_LBRC,KC_RBRC,KC_TILD,KC_TRNS,
  90           EPRM,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
  91                                        RGB_MOD,KC_TRNS,
  92                                                KC_TRNS,
  93                                RGB_VAD,RGB_VAI,KC_TRNS,
  94        // right hand
  95        KC_TRNS, KC_F6,   KC_F7,  KC_F8,   KC_F9,   KC_F10,  KC_F11,
  96        KC_TRNS, KC_UP,   KC_7,   KC_8,    KC_9,    KC_ASTR, KC_F12,
  97                 KC_DOWN, KC_4,   KC_5,    KC_6,    KC_PLUS, KC_TRNS,
  98        KC_TRNS, KC_AMPR, KC_1,   KC_2,    KC_3,    KC_BSLS, KC_TRNS,
  99                          KC_TRNS,KC_DOT,  KC_0,    KC_EQL,  KC_TRNS,
 100        RGB_TOG, RGB_SLD,
 101        KC_TRNS,
 102        KC_TRNS, RGB_HUD, RGB_HUI
 103 ),
 104 /* Keymap 2: Media and mouse keys
 105  *
 106  * ,--------------------------------------------------.           ,--------------------------------------------------.
 107  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 108  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 109  * |        |      |      | MsUp |      |      |      |           |      |      |      |      |      |      |        |
 110  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 111  * |        |      |MsLeft|MsDown|MsRght|      |------|           |------|      |      |      |      |      |  Play  |
 112  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 113  * |        |      |      |      |      |      |      |           |      |      |      | Prev | Next |      |        |
 114  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 115  *   |      |      |      | Lclk | Rclk |                                       |VolUp |VolDn | Mute |      |      |
 116  *   `----------------------------------'                                       `----------------------------------'
 117  *                                        ,-------------.       ,-------------.
 118  *                                        |      |      |       |      |      |
 119  *                                 ,------|------|------|       |------+------+------.
 120  *                                 |      |      |      |       |      |      |Brwser|
 121  *                                 |      |      |------|       |------|      |Back  |
 122  *                                 |      |      |      |       |      |      |      |
 123  *                                 `--------------------'       `--------------------'
 124  */
 125 // MEDIA AND MOUSE
 126 [MDIA] = KEYMAP(
 127        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 128        KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_TRNS,
 129        KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
 130        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 131        KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN2,
 132                                            KC_TRNS, KC_TRNS,
 133                                                     KC_TRNS,
 134                                   KC_TRNS, KC_TRNS, KC_TRNS,
 135     // right hand
 136        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 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_MPLY,
 139        KC_TRNS,  KC_TRNS, KC_TRNS, KC_MPRV, KC_MNXT, KC_TRNS, KC_TRNS,
 140                           KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS,
 141        KC_TRNS, KC_TRNS,
 142        KC_TRNS,
 143        KC_TRNS, KC_TRNS, KC_WBAK
 144 ),
 145 /* Keymap 8: Steno for Plover
 146  *
 147  * ,--------------------------------------------------.           ,----------------------------------------
 148  * |        |      |      |      |      |      | BASE |           |      |      |      |      |      |
 149  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+-----
 150  * |        |   #  |   #  |   #  |   #  |   #  |   #  |           |  #   |  #   |  #   |   #  |   #  |  #
 151  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+-----
 152  * |        |      |   T  |   P  |   H  |      |------|           |------|      |  F   |   P  |   L  |  T
 153  * |--------+   S  +------+------+------+   *  |   *  |           |  *   |  *   +------+------+------+-----
 154  * |        |      |   K  |   W  |   R  |      |      |           |      |      |  R   |   B  |   G  |  S
 155  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+-----
 156  *   |      |      |      |      |      |                                       |      |      |      |
 157  *   `----------------------------------'                                       `--------------------------
 158  *                                        ,-------------.       ,-------------.
 159  *                                        |      |      |       |      |      |
 160  *                                 ,------|------|------|       |------+------+------.
 161  *                                 |      |      |      |       |      |      |      |
 162  *                                 |   A  |   O  |------|       |------|  E   |  U   |
 163  *                                 |      |      |      |       |      |      |      |
 164  *                                 `--------------------'       `--------------------'
 165  */
 166
 167 [PLVR] = KEYMAP(
 168 // left hand
 169 KC_NO,  KC_NO,  KC_NO,  KC_NO,   KC_NO,  KC_NO,   M(A_PLVR),
 170 KC_NO,  PV_NUM, PV_NUM, PV_NUM,  PV_NUM, PV_NUM,  PV_NUM,
 171 KC_NO,  PV_LS,  PV_LT,  PV_LP,   PV_LH,  PV_STAR,
 172 KC_NO,  PV_LS,  PV_LK,  PV_LW,   PV_LR,  PV_STAR, PV_STAR,
 173 KC_NO,  KC_NO,  KC_NO,  KC_NO,   KC_NO,
 174                                            KC_NO, KC_NO,
 175                                            KC_NO,
 176                                            PV_A,  PV_O,  KC_NO,
 177
 178                                                  // right hand
 179         KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_N
 180         PV_NUM,  PV_NUM,  PV_NUM,  PV_NUM,  PV_NUM,  PV_NUM,  PV_N
 181                  PV_STAR, PV_RF,   PV_RP,   PV_RL,   PV_RT,   PV_R
 182         PV_STAR, PV_STAR, PV_RR,   PV_RB,   PV_RG,   PV_RS,   PV_R
 183                           KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_N
 184   KC_NO,      KC_NO,
 185   KC_NO,
 186   KC_NO,PV_E, PV_U
 187  ),
 188
 189 };
 190
 191 const uint16_t PROGMEM fn_actions[] = {
 192     [1] = ACTION_LAYER_TAP_TOGGLE(SYMB)                // FN1 - Momentary Layer 1 (Symbols)
 193 };
 194
 195 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 196 {
 197   // MACRODOWN only works in this function
 198       switch(id) {
 199         case 0:
 200         if (record->event.pressed) {
 201           SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
 202         }
 203         break;
 204         case 1:
 205         if (record->event.pressed) { // For resetting EEPROM
 206           eeconfig_init();
 207         }
 208         break;
 209       }
 210     return MACRO_NONE;
 211 };
 212
 213 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 214   switch (keycode) {
 215     // dynamically generate these.
 216     case EPRM:
 217       if (record->event.pressed) {
 218         eeconfig_init();
 219       }
 220       return false;
 221       break;
 222     case VRSN:
 223       if (record->event.pressed) {
 224         SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
 225       }
 226       return false;
 227       break;
 228     case RGB_SLD:
 229       if (record->event.pressed) {
 230         #ifdef RGBLIGHT_ENABLE
 231           rgblight_mode(1);
 232         #endif
 233       }
 234       return false;
 235       break;
 236   }
 237   return true;
 238 }
 239
 240 // Runs just one time when the keyboard initializes.
 241 void matrix_init_user(void) {
 242
 243 };
 244
 245
 246 // Runs constantly in the background, in a loop.
 247 void matrix_scan_user(void) {
 248
 249     uint8_t layer = biton32(layer_state);
 250
 251     ergodox_board_led_off();
 252     ergodox_right_led_1_off();
 253     ergodox_right_led_2_off();
 254     ergodox_right_led_3_off();
 255     switch (layer) {
 256       // TODO: Make this relevant to the ErgoDox EZ.
 257         case 1:
 258             ergodox_right_led_1_on();
 259             break;
 260         case 2:
 261             ergodox_right_led_2_on();
 262             break;
 263         default:
 264             // none
 265             break;
 266     }
 267
 268 };