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