keyboards/ergodox/keymaps/familiar/keymap.c

   1 #include "ergodox.h"
   2 #include "debug.h"
   3 #include "action_layer.h"
   4 #include "version.h"
   5
   6 // Leader Key Timeout
   7 //#define LEADER_TIMEOUT 300
   8
   9 // Layers
  10 #define BASE 0 // default layer
  11 #define SYMB 1 // international symbols
  12 #define CSYM 2 // international symbols shifted
  13 #define NUMP 3 // numpad
  14 #define ARRW 4 // function, media, arrow keys
  15
  16 // Fillers to make layering more clear
  17 #define _______ KC_TRNS
  18 #define XXXXXXX KC_NO
  19
  20 // Tap Dancing
  21 void dance_lock (qk_tap_dance_state_t *state, void *user_data) {
  22     if (state->count == 1) { // Press once for NUMLOCK
  23         register_code (KC_NLCK);
  24         unregister_code (KC_NLCK);
  25     } else if (state->count == 2) { // Press twice for CAPSLOCK
  26         register_code (KC_CAPS);
  27         unregister_code (KC_CAPS);
  28     } else if (state->count == 3) { //Press thrice for SCROLLLOCK
  29         register_code (KC_SLCK);
  30         unregister_code (KC_SLCK);
  31     }
  32 }
  33 enum {LOCKS = 0};
  34 qk_tap_dance_action_t tap_dance_actions[] = {
  35     [LOCKS] = ACTION_TAP_DANCE_FN(dance_lock)
  36 };
  37
  38 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  39 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
  40 // Otherwise, it needs KC_*
  41 /* layer 0 : default
  42  *
  43  * ,--------------------------------------------------.           ,--------------------------------------------------.
  44  * | `      |   1  |   2  |   3  |   4  |   5  |   6  |           |  7   |   8  |   9  |   0  |   -  |   =  | BCKSPC |
  45  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  46  * | TAB    |   Q  |   W  |   E  |   R  |   T  | HOME |           | PGUP |   Y  |   U  |   I  |   O  |   P  | DELETE |
  47  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  48  * | '      |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |  ENTER |
  49  * |--------+------+------+------+------+------|  END |           | PGDN |------+------+------+------+------+--------|
  50  * | (/LSFT |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |  UP  | )/RSFT |
  51  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  52  * | LCTRL  | LGUI | MENU | LEAD | LALT |                                       |[/RALT|]/RCTL| LEFT | DOWN |  RIGHT |
  53  * `------------------------------------'                                       `------------------------------------'
  54  *                                        ,-------------.       ,-------------.
  55  *                                        |PRTSCR| ESC  |       | VOL- | VOL+ |
  56  *                                 ,------|------|------|       |------+------+------.
  57  *                                 |      |SLASH/| LOCKS|       | MUTE |WHACK/|      |
  58  *                                 |  SPC | MO(4)|------|       |------|MO(4) | SPC  |
  59  *                                 |      |      | TO(3)|       |TO(1) |      |      |
  60  *                                 `--------------------'       `--------------------'
  61  */
  62 [BASE] = KEYMAP(
  63         // left hand
  64         KC_GRV,     KC_1,       KC_2,       KC_3,       KC_4,       KC_5,       KC_6,
  65         KC_TAB,     KC_Q,       KC_W,       KC_E,       KC_R,       KC_T,       KC_HOME,
  66         KC_QUOT,    KC_A,       KC_S,       KC_D,       KC_F,       KC_G,
  67         KC_LSPO,    KC_Z,       KC_X,       KC_C,       KC_V,       KC_B,       KC_END,
  68         KC_LCTL,    KC_LGUI,    KC_MENU,    KC_LEAD,    KC_LALT,
  69                                                                     KC_PSCR,    KC_ESC,
  70                                                                                 TD(LOCKS),
  71                                                 KC_SPC,     LT(ARRW, KC_SLSH),  TG(SYMB),
  72         // right hand
  73             KC_7,       KC_8,       KC_9,       KC_0,       KC_MINS,    KC_EQL,     KC_BSPC,
  74             KC_PGUP,    KC_Y,       KC_U,       KC_I,       KC_O,       KC_P,       KC_DEL,
  75                         KC_H,       KC_J,       KC_K,       KC_L,       KC_SCLN,    KC_ENTER,
  76             KC_PGDN,    KC_N,       KC_M,       KC_COMM,    KC_DOT,     KC_UP,      KC_RSPC,
  77                         MT(MOD_RALT, KC_LBRC),  KC_RBRC,    KC_LEFT,    KC_DOWN,    KC_RGHT,
  78             KC_VOLD,    KC_VOLU,
  79             KC_MUTE,
  80             TG(NUMP),   LT(ARRW, KC_BSLS),   KC_SPC
  81     ),
  82
  83 /* layer 1: International symbols, etc
  84  *
  85  * ,--------------------------------------------------.           ,--------------------------------------------------.
  86  * |     ¬  |   ¡  |   ²  |   ³  |   ¤  |   €  |   ¼  |           |  ½   |  ¾   |  ‘   |  ’   |  ¥   |  ×   |        |
  87  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  88  * |        |   ä  |   å  |   é  |   ®  |   þ  |      |           |      |  ü   |  ú   |  í   |  ó   |  ö   |        |
  89  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  90  * |     ´  |   á  |   ß  |   ð  |      |      |------|           |------|      |      |      |  ø   |  ¶   |        |
  91  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  92  * |MO(CSYM)|   æ  |   ¿  |   ©  |      |      |      |           |      |  ñ   |  µ   |  ç   |      |      |MO(CSYM)|
  93  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  94  * |        |      |      |      |      |                                       |  «   |  »   |      |      |        |
  95  * `------------------------------------'                                       `------------------------------------'
  96  *                                        ,-------------.       ,-------------.
  97  *                                        |      |      |       |      |      |
  98  *                                 ,------|------|------|       |------+------+------.
  99  *                                 |      |      |      |       |      |      |      |
 100  *                                 |      |      |------|       |------|      |      |
 101  *                                 |      |      |      |       |      |      |      |
 102  *                                 `--------------------'       `--------------------'
 103  */
 104 [SYMB] = KEYMAP(
 105         // left hand
 106         UC(0x00AC), UC(0x00A1), UC(0x00B2), UC(0x00B3), UC(0x00A4), UC(0x20AC), UC(0x00BC),
 107         _______,    UC(0x00E4), UC(0x00E5), UC(0x00E9), UC(0x00AE), UC(0x00FE), _______,
 108         UC(0x00B4), UC(0x00E1), UC(0x00DF), UC(0x00F0), _______,    _______,
 109         MO(CSYM),   UC(0x00E6), UC(0x00BF), UC(0x00A9), _______,    _______,    _______,
 110         _______,    _______,    _______,    _______,    _______,
 111                                             _______,    _______,
 112                                                         _______,
 113                             _______,        _______,    _______,
 114         // right hand
 115             UC(0x00BD), UC(0x00BE), UC(0x2018), UC(0x2019), UC(0x00A5), UC(0x00D7), _______,
 116             _______,    UC(0x00FC), UC(0x00FA), UC(0x00ED), UC(0x00F3), UC(0x00F6), _______,
 117                         _______,    _______,    _______,    UC(0x00F8), UC(0x00B6), _______,
 118             _______,    UC(0x00F1), UC(0x00B5), UC(0x00E7), _______,    _______,    MO(CSYM),
 119                                     UC(0x00AB), UC(0x00BB), _______,    _______,    _______,
 120             _______,    _______,
 121             _______,
 122             _______,    _______,    _______
 123     ),
 124
 125 /* layer 2 : international symbols, shifted
 126  * This layer is an ugly workaround; it pretends that SHIFT still works normally on keys
 127  * which don't produce an "upper case" or "shifted" international symobol.
 128  *
 129  * ,--------------------------------------------------.           ,--------------------------------------------------.
 130  * |        |   ¹  |      |      |   £  |      |      |           |      |      |      |      |  —  |  ÷   |        |
 131  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 132  * |        |   Ä  |   Å  |   É  |      |   Þ  |      |           |      |  Ü   |  Ú   |  Í   |  Ó   |  Ö   |        |
 133  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 134  * |     ¨  |   Á  |   §  |   Ð  |      |      |------|           |------|      |      |      |  Ø   |  °   |        |
 135  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 136  * |        |   Æ  |      |   ¢  |      |      |      |           |      |  Ñ   |      |  Ç   |      |      |        |
 137  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 138  * |        |      |      |   ¦  |      |                                       |      |      |      |      |        |
 139  * `------------------------------------'                                       `------------------------------------'
 140  *                                        ,-------------.       ,-------------.
 141  *                                        |      |      |       |      |      |
 142  *                                 ,------|------|------|       |------+------+------.
 143  *                                 |      |      |      |       |      |      |      |
 144  *                                 |      |      |------|       |------|      |      |
 145  *                                 |      |      |      |       |      |      |      |
 146  *                                 `--------------------'       `--------------------'
 147  */
 148 [CSYM] = KEYMAP(
 149         // left hand
 150         _______,    UC(0x00B9), _______,    _______,    UC(0x00A3), _______,    _______,
 151         _______,    UC(0x00C4), UC(0x00C5), UC(0x00C9), S(KC_R),    UC(0x00DE), _______,
 152         UC(0x00A8), UC(0x00C1), UC(0x00A7), UC(0x00D0), S(KC_F),    S(KC_G),
 153         _______,    UC(0x00C6), S(KC_X),    UC(0x00A2), S(KC_V),    S(KC_B),    _______,
 154         _______,    _______,    _______,    UC(0x00A6), _______,
 155                                                                     _______,    _______,
 156                                                                                 _______,
 157                                                     _______,        _______,    _______,
 158         // right hand
 159             _______,    _______,    _______,    _______,    UC(0x2014), UC(0x00F7), _______,
 160             _______,    UC(0x00DC), UC(0x00DA), UC(0x00CD), UC(0x00D3), UC(0x00D6), _______,
 161                         S(KC_H),    S(KC_J),    S(KC_K),    UC(0x00D8), UC(0x00B0), _______,
 162             _______,    UC(0x00D1), _______,    UC(0x00C7), S(KC_DOT),  _______,    _______,
 163                                     _______,    _______,    _______,    _______,    _______,
 164             _______,    _______,
 165             _______,
 166             _______,    _______,    _______
 167     ),
 168
 169 /* layer 3: numberpad
 170  *
 171  * ,--------------------------------------------------.           ,--------------------------------------------------.
 172  * |        |      |      |      |      |      |      |           |      |      |   (  |   )  |   /  |  *   |        |
 173  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 174  * |        |      |      |      |      |      |      |           |      |      |   7  |   8  |   9  |  -   |        |
 175  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 176  * |        |      |      |      |      |      |------|           |------|      |   4  |   5  |   6  |  +   |        |
 177  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 178  * |        |      |      |      |      |      |      |           |      |      |   1  |   2  |   3  |  =   |        |
 179  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 180  * |        |      |      |      |      |                                       |   0  |   .  |   ,  | ENTER|        |
 181  * `------------------------------------'                                       `------------------------------------'
 182  *                                        ,-------------.       ,-------------.
 183  *                                        |      |      |       |      |      |
 184  *                                 ,------|------|------|       |------+------+------.
 185  *                                 |      |      |      |       |      |      |      |
 186  *                                 |      |      |------|       |------|      |      |
 187  *                                 |      |      |      |       |      |      |      |
 188  *                                 `--------------------'       `--------------------'
 189  */
 190 [NUMP] = KEYMAP(
 191         // left hand
 192         _______,    _______,    _______,    _______,    _______,    _______,    _______,
 193         _______,    _______,    _______,    _______,    _______,    _______,    _______,
 194         _______,    _______,    _______,    _______,    _______,    _______,
 195         _______,    _______,    _______,    _______,    _______,    _______,    _______,
 196         _______,    _______,    _______,    _______,    _______,
 197                                             _______,    _______,
 198                                                         _______,
 199                             _______,        _______,    _______,
 200         // right hand
 201             _______,    _______,    S(KC_9),    S(KC_0),    KC_PSLS,    KC_PAST,    _______,
 202             _______,    _______,    KC_KP_7,    KC_KP_8,    KC_KP_9,    KC_PMNS,    _______,
 203                         _______,    KC_KP_4,    KC_KP_5,    KC_KP_6,    KC_PPLS,    _______,
 204             _______,    _______,    KC_KP_1,    KC_KP_2,    KC_KP_3,    KC_PEQL,    _______,
 205                                     KC_KP_0,    KC_KP_DOT,  KC_PCMM,    KC_PENT,    _______,
 206             _______,    _______,
 207             _______,
 208             _______,    _______,    _______
 209     ),
 210
 211 /* layer 4 : functions and arrows
 212  * This layer is at the top so that the functions still work no matter what layers are active.
 213  *
 214  * ,--------------------------------------------------.           ,--------------------------------------------------.
 215  * | ESCAPE |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |           |  F7  |  F8  |  F9  | F10  | F11  | F12  |        |
 216  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 217  * |        |      |      |  UP  |      |      |      |           |      |      |      |      |      |      | INSERT |
 218  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 219  * |        |      | LEFT | DOWN |RIGHT |      |------|           |------| LEFT | DOWN |  UP  | RIGHT|      |        |
 220  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 221  * |        |M_PREV|M_STOP|M_PLPS|M_NEXT|      |      |           |      |      |      |      |      | PGUP |        |
 222  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 223  * |        |      |      |      |      |                                       |      |      | HOME | PGDN |    END |
 224  * `------------------------------------'                                       `------------------------------------'
 225  *                                        ,-------------.       ,-------------.
 226  *                                        | PAUSE|SYSREQ|       |      |      |
 227  *                                 ,------|------|------|       |------+------+------.
 228  *                                 |      |      |      |       |      |      |      |
 229  *                                 |      |      |------|       |------|      |      |
 230  *                                 |      |      |      |       |      |      |      |
 231  *                                 `--------------------'       `--------------------'
 232  */
 233 [ARRW] = KEYMAP(
 234         // left hand
 235         KC_ESC,     KC_F1,      KC_F2,      KC_F3,      KC_F4,      KC_F5,      KC_F6,
 236         _______,    _______,    _______,    KC_UP,      _______,    _______,    _______,
 237         _______,    _______,    KC_LEFT,    KC_DOWN,    KC_RGHT,    _______,
 238         _______,    _______,    _______,    _______,    _______,    _______,    _______,
 239         _______,    _______,    _______,    _______,    _______,
 240                                                                     KC_PAUSE,   _______,
 241                                                                                 _______,
 242                                                     _______,        _______,    _______,
 243         // right hand
 244             KC_F7,      KC_F8,      KC_F9,      KC_F10,     KC_F11,     KC_F12,     KC_SYSREQ,
 245             _______,    _______,    _______,    _______,    _______,    _______,    KC_INS,
 246                         KC_LEFT,    KC_DOWN,    KC_UP,      KC_RGHT,    _______,    _______,
 247             _______,    _______,    _______,    _______,    _______,    KC_PGUP,    _______,
 248                                     _______,    _______,    KC_HOME,    KC_PGDN,    KC_END,
 249             _______,    _______,
 250             _______,
 251             _______,    _______,    _______
 252     ),
 253 };
 254
 255 // Runs just one time when the keyboard initializes.
 256 void matrix_init_user(void) {
 257     set_unicode_input_mode(UC_LNX); // Linux
 258     //set_unicode_input_mode(UC_OSX); // Mac OSX
 259     //set_unicode_input_mode(UC_WIN); // Windows (with registry key, see wiki)
 260     //set_unicode_input_mode(UC_WINC); // Windows (with WinCompose, see wiki)
 261 };
 262
 263 // Runs constantly in the background, in a loop.
 264 void matrix_scan_user(void) {
 265
 266     uint8_t layer = biton32(layer_state);
 267
 268     ergodox_board_led_off();
 269     ergodox_right_led_1_off();
 270     ergodox_right_led_2_off();
 271     ergodox_right_led_3_off();
 272     switch (layer) {
 273         case SYMB:
 274         case CSYM:
 275             ergodox_right_led_1_on();
 276             break;
 277         case NUMP:
 278             ergodox_right_led_2_on();
 279             break;
 280         case ARRW:
 281             ergodox_right_led_3_on();
 282             break;
 283         default:
 284             // none
 285             break;
 286     }
 287
 288 };