layouts/community/ergodox/haegin/keymap.c

   1 // Netable differences vs. the default firmware for the ErgoDox EZ:
   2 // 1. The Cmd key is now on the right side, making Cmd+Space easier.
   3 // 2. The media keys work on OSX (But not on Windows).
   4 #include QMK_KEYBOARD_H
   5 #include "debug.h"
   6 #include "action_layer.h"
   7
   8 #define BASE 0 // default layer
   9 #define SYMBOLS 1 // symbols
  10 #define MEDIA 2 // media keys
  11
  12 #define _______ KC_TRNS
  13
  14 enum {
  15   TD_BSPC = 0
  16 };
  17
  18 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  19
  20 /* Keymap 0: Basic layer
  21  *
  22  * ,--------------------------------------------------.           ,--------------------------------------------------.
  23  * |   =    |   1  |   2  |   3  |   4  |   5  | LEFT |           | RIGHT|   6  |   7  |   8  |   9  |   0  |   -    |
  24  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  25  * |   /    |   Q  |   W  |   E  |   R  |   T  |      |           |      |   Y  |   U  |   I  |   O  |   P  |   \    |
  26  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  27  * | Ctl/Esc|   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |; / L2|  LGui  |
  28  * |--------+------+------+------+------+------| Hyper|           | Meh  |------+------+------+------+------+--------|
  29  * | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |//Ctrl| RShift |
  30  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  31  *   |Grv/L1|  '"  |AltShf| Left | Right|                                       |  Up  | Down |   [  |   ]  | ~L1  |
  32  *   `----------------------------------'                                       `----------------------------------'
  33  *                                        ,-------------.       ,-------------.
  34  *                                        | App  | LGui |       | Alt  |Ctrl/Esc|
  35  *                                 ,------|------|------|       |------+--------+------.
  36  *                                 |      |      | Home |       | PgUp |        |      |
  37  *                                 | Space|Backsp|------|       |------|  Tab   |Enter |
  38  *                                 |      |ace   | 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
  44 [BASE] = LAYOUT_ergodox(  // layer 0 : default
  45         // Left hand
  46         KC_EQL,              KC_1,               KC_2,            KC_3,     KC_4,            KC_5,               KC_LEFT,
  47         KC_SLSH,             KC_QUOT,            KC_COMM,         KC_DOT,   KC_P,            KC_Y,               KC_NO,
  48         CTL_T(KC_ESC),       KC_A,               KC_O,            KC_E,     KC_U,            KC_I,
  49         KC_LSPO,             KC_SCLN,            KC_Q,            KC_J,     KC_K,            KC_X,               ALL_T(KC_NO),
  50         LT(SYMBOLS,KC_GRV),  KC_QUOT,            KC_SLSH,         KC_LALT,  SFT_T(KC_RGHT),
  51                                                                                              KC_HOME,            KC_END,
  52                                                                                                                  KC_PGUP,
  53                                                                             GUI_T(KC_SPC),   TD(TD_BSPC),     LGUI(KC_SPC),
  54
  55         // Right hand
  56         KC_RGHT,        KC_6,              KC_7,                KC_8,        KC_9,        KC_0,                LGUI(KC_SPC),
  57         KC_NO,          KC_F,              KC_G,                KC_C,        KC_R,        KC_L,                LT(MEDIA, KC_BSLS),
  58                         KC_D,              KC_H,                KC_T,        KC_N,        KC_S,                KC_MINS,
  59         MEH_T(KC_NO),   KC_B,              KC_M,                KC_W,        KC_V,        KC_Z,                KC_RSPC,
  60                                            ALT_T(KC_UP),        KC_DOWN,     KC_LBRC,     KC_RBRC,             KC_FN2,
  61         KC_PGUP,        CTL_T(KC_ESC),
  62         KC_PGDN,
  63         LCTL(KC_B),     LT(MEDIA, KC_TAB), LT(SYMBOLS, KC_ENT)
  64     ),
  65
  66
  67 /* Keymap 1: Symbol Layer
  68  *
  69  * ,--------------------------------------------------.           ,--------------------------------------------------.
  70  * |        |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
  71  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  72  * |        |   !  |   @  |   {  |   }  |   |  |      |           |      |   Up |   7  |   8  |   9  |   *  |   F12  |
  73  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  74  * |        |   #  |   $  |   (  |   )  |   `  |------|           |------| Down |   4  |   5  |   6  |   +  |        |
  75  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  76  * |        |   %  |   ^  |   [  |   ]  |   ~  |      |           |      |   &  |   1  |   2  |   3  |   \  |        |
  77  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  78  *   |      |      |      |      |      |                                       |      |    . |   0  |   =  |      |
  79  *   `----------------------------------'                                       `----------------------------------'
  80  *                                        ,-------------.       ,-------------.
  81  *                                        |      |      |       |      |      |
  82  *                                 ,------|------|------|       |------+------+------.
  83  *                                 |      |      |      |       |      |      |      |
  84  *                                 |      |      |------|       |------|      |      |
  85  *                                 |      |      |      |       |      |      |      |
  86  *                                 `--------------------'       `--------------------'
  87  */
  88 // SYMBOLS
  89
  90 [SYMBOLS] = LAYOUT_ergodox(
  91        // left hand
  92        _______,KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  _______,
  93        _______,KC_EXLM,KC_AT,  KC_LCBR,KC_RCBR,KC_PIPE,_______,
  94        _______,KC_HASH,KC_DLR, KC_LPRN,KC_RPRN,KC_GRV,
  95        _______,KC_PERC,KC_CIRC,KC_LBRC,KC_RBRC,KC_TILD,_______,
  96        _______,_______,_______,_______,_______,
  97                                        _______,_______,
  98                                                _______,
  99                                _______,_______,_______,
 100        // right hand
 101        _______, KC_F6,   KC_F7,  KC_F8,   KC_F9,   KC_F10,  KC_F11,
 102        _______, KC_EQL,  KC_7,   KC_8,    KC_9,    KC_ASTR, KC_F12,
 103                 KC_MINS, KC_4,   KC_5,    KC_6,    KC_PLUS, _______,
 104        _______, KC_AMPR, KC_1,   KC_2,    KC_3,    KC_SLSH, _______,
 105                          _______,KC_0,    KC_DOT,  KC_EQL,  _______,
 106        _______, _______,
 107        _______,
 108        _______, _______, _______
 109 ),
 110
 111 /* Keymap 2: Media and mouse keys
 112  *
 113  * ,--------------------------------------------------.           ,--------------------------------------------------.
 114  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 115  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 116  * |        |      |      | MsUp |      |      |      |           |      |      |      |  ↑   |      |      |        |
 117  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 118  * |        |      |MsLeft|MsDown|MsRght|      |------|           |------|VolUp |   ←  |   ↓  |  →   |      |  Play  |
 119  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 120  * |        |      |      |      |      |      |      |           |      |VolDn | Prev | Play | Next |      |        |
 121  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 122  *   |      |      |      | Lclk | Rclk |                                       | Mute |      |      |      |      |
 123  *   `----------------------------------'                                       `----------------------------------'
 124  *                                        ,-------------.       ,-------------.
 125  *                                        |      |      |       |      |      |
 126  *                                 ,------|------|------|       |------+------+------.
 127  *                                 |      |      |      |       |      |      |Brwser|
 128  *                                 |      |      |------|       |------|      |Back  |
 129  *                                 |      |      |      |       |      |      |      |
 130  *                                 `--------------------'       `--------------------'
 131  */
 132 // MEDIA AND MOUSE
 133 [MEDIA] = LAYOUT_ergodox(
 134        _______, _______, _______, _______, _______, _______, _______,
 135        _______, _______, _______, KC_MS_U, _______, _______, _______,
 136        _______, _______, KC_MS_L, KC_MS_D, KC_MS_R, _______,
 137        _______, _______, _______, _______, _______, _______, _______,
 138        _______, _______, _______, KC_BTN1, KC_BTN2,
 139                                            _______, _______,
 140                                                     _______,
 141                                   _______, _______, _______,
 142     // right hand
 143        _______, _______, _______, _______, _______, _______, _______,
 144        _______, _______, KC_HOME,   KC_UP,  KC_END, KC_PGUP, _______,
 145                 KC_VOLU, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN, KC_MPLY,
 146        KC_MUTE, KC_VOLD, KC_MPRV, KC_MPLY, KC_MFFD, _______, _______,
 147                           _______, _______, _______, _______, _______,
 148        _______, _______,
 149        _______,
 150        _______, _______,  KC_WBAK
 151 ),
 152 };
 153
 154 enum {
 155   BSPC_LETTER = 0,
 156   BSPC_WORD = 1,
 157   HOLD_CTRL = 2
 158 };
 159
 160 typedef struct {
 161   int a;
 162   int b;
 163   int state;
 164 } fib_tap;
 165
 166 static fib_tap fib_bspc = {
 167   .a = 0,
 168   .b = 1,
 169   .state = BSPC_LETTER
 170 };
 171
 172 void cur_backspace (qk_tap_dance_state_t *state) {
 173   int next_fib = fib_bspc.a + fib_bspc.b;
 174   fib_bspc.a = fib_bspc.b;
 175   fib_bspc.b = next_fib;
 176   for (int i=0; i < next_fib; i++) {
 177     unregister_code(KC_BSPC);
 178     register_code(KC_BSPC);
 179   }
 180 }
 181
 182 void dance_backspace (qk_tap_dance_state_t *state, void *user_data) {
 183   // If we're at the fifth tap, switch to deleting by words, and reset the fib
 184   // counter
 185   if (state->count == 4) {
 186     register_code(KC_LALT);
 187     fib_bspc.state = BSPC_WORD;
 188     fib_bspc.a = 0;
 189     fib_bspc.b = 1;
 190   }
 191   // If we're on the first press, wait to find out if it's being held
 192   // If we're on the second tap, process the first tap, because we're past
 193   // holding for ctrl now, then act normally
 194   if (state->count == 2) {
 195     register_code(KC_BSPC);
 196   }
 197   if (state->count > 1) {
 198     cur_backspace(state);
 199   }
 200 };
 201
 202 void dance_backspace_ended (qk_tap_dance_state_t *state, void *user_data) {
 203   if (state->count == 1) {
 204     if (state->pressed) {
 205       fib_bspc.state = HOLD_CTRL;
 206       register_code(KC_LCTRL);
 207     } else {
 208       register_code(KC_BSPC);
 209     }
 210   }
 211 };
 212
 213 void dance_backspace_reset (qk_tap_dance_state_t *state, void *user_data) {
 214   switch (fib_bspc.state) {
 215     case HOLD_CTRL: unregister_code(KC_LCTRL); break;
 216     case BSPC_WORD: unregister_code(KC_BSPC); unregister_code(KC_LALT); break;
 217     case BSPC_LETTER: unregister_code(KC_BSPC); break;
 218   }
 219   fib_bspc.a = 0;
 220   fib_bspc.b = 1;
 221   fib_bspc.state = BSPC_LETTER;
 222 };
 223
 224 qk_tap_dance_action_t tap_dance_actions[] = {
 225   [TD_BSPC] = ACTION_TAP_DANCE_FN_ADVANCED (dance_backspace, dance_backspace_ended, dance_backspace_reset)
 226 };
 227
 228 const uint16_t PROGMEM fn_actions[] = {
 229     [1] = ACTION_LAYER_TAP_TOGGLE(SYMBOLS)                // FN1 - Momentary Layer 1 (Symbols)
 230 };
 231
 232 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 233 {
 234   // MACRODOWN only works in this function
 235       switch(id) {
 236         case 0:
 237         if (record->event.pressed) {
 238           register_code(KC_RSFT);
 239         } else {
 240           unregister_code(KC_RSFT);
 241         }
 242         break;
 243       }
 244     return MACRO_NONE;
 245 };
 246
 247 // Runs just one time when the keyboard initializes.
 248 void matrix_init_user(void) {
 249
 250 };
 251
 252 // Runs constantly in the background, in a loop.
 253 void matrix_scan_user(void) {
 254
 255     uint8_t layer = biton32(layer_state);
 256
 257     ergodox_board_led_off();
 258     ergodox_right_led_1_off();
 259     ergodox_right_led_2_off();
 260     ergodox_right_led_3_off();
 261     switch (layer) {
 262       // TODO: Make this relevant to the ErgoDox EZ.
 263         case 1:
 264             ergodox_right_led_1_on();
 265             break;
 266         case 2:
 267             ergodox_right_led_3_on();
 268             break;
 269         default:
 270             // none
 271             break;
 272     }
 273
 274 };