keyboards/ergodox/keymaps/default_osx/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 "ergodox_ez.h"
   5 #include "debug.h"
   6 #include "action_layer.h"
   7
   8 #define BASE 0 // default layer
   9 #define SYMB 1 // symbols
  10 #define MDIA 2 // media keys
  11
  12 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  13 /* Keymap 0: Basic layer
  14  *
  15  * ,--------------------------------------------------.           ,--------------------------------------------------.
  16  * |   =    |   1  |   2  |   3  |   4  |   5  | LEFT |           | RIGHT|   6  |   7  |   8  |   9  |   0  |   -    |
  17  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  18  * | Del    |   Q  |   W  |   E  |   R  |   T  |  L1  |           |  L1  |   Y  |   U  |   I  |   O  |   P  |   \    |
  19  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  20  * | BkSp   |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |; / L2|  LGui  |
  21  * |--------+------+------+------+------+------| Hyper|           | Meh  |------+------+------+------+------+--------|
  22  * | LShift |Z/Ctrl|   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |//Ctrl| RShift |
  23  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  24  *   |Grv/L1|  '"  |AltShf| Left | Right|                                       |  Up  | Down |   [  |   ]  | ~L1  |
  25  *   `----------------------------------'                                       `----------------------------------'
  26  *                                        ,-------------.       ,-------------.
  27  *                                        | App  | LGui |       | Alt  |Ctrl/Esc|
  28  *                                 ,------|------|------|       |------+--------+------.
  29  *                                 |      |      | Home |       | PgUp |        |      |
  30  *                                 | Space|Backsp|------|       |------|  Tab   |Enter |
  31  *                                 |      |ace   | End  |       | PgDn |        |      |
  32  *                                 `--------------------'       `----------------------'
  33  */
  34 // If it accepts an argument (i.e, is a function), it doesn't need KC_.
  35 // Otherwise, it needs KC_*
  36 [BASE] = KEYMAP(  // layer 0 : default
  37         // left hand
  38         KC_EQL,         KC_1,         KC_2,   KC_3,   KC_4,   KC_5,   KC_LEFT,
  39         KC_DELT,        KC_Q,         KC_W,   KC_E,   KC_R,   KC_T,   TG(SYMB),
  40         KC_BSPC,        KC_A,         KC_S,   KC_D,   KC_F,   KC_G,
  41         KC_LSFT,        CTL_T(KC_Z),  KC_X,   KC_C,   KC_V,   KC_B,   ALL_T(KC_NO),
  42         LT(SYMB,KC_GRV),KC_QUOT,      LALT(KC_LSFT),  KC_LEFT,KC_RGHT,
  43                                               ALT_T(KC_APP),  KC_LGUI,
  44                                                               KC_HOME,
  45                                                KC_SPC,KC_BSPC,KC_END,
  46         // right hand
  47              KC_RGHT,     KC_6,   KC_7,   KC_8,   KC_9,   KC_0,             KC_MINS,
  48              TG(SYMB),       KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,             KC_BSLS,
  49                           KC_H,   KC_J,   KC_K,   KC_L,   LT(MDIA, KC_SCLN),KC_LGUI,
  50              MEH_T(KC_NO),KC_N,   KC_M,   KC_COMM,KC_DOT, CTL_T(KC_SLSH),   KC_RSFT,
  51                                   KC_UP,  KC_DOWN,KC_LBRC,KC_RBRC,          KC_FN1,
  52              KC_LALT,        CTL_T(KC_ESC),
  53              KC_PGUP,
  54              KC_PGDN,KC_TAB, KC_ENT
  55     ),
  56 /* Keymap 1: Symbol Layer
  57  *
  58  * ,--------------------------------------------------.           ,--------------------------------------------------.
  59  * |        |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |      |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
  60  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
  61  * |        |   !  |   @  |   {  |   }  |   |  |      |           |      |   Up |   7  |   8  |   9  |   *  |   F12  |
  62  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  63  * |        |   #  |   $  |   (  |   )  |   `  |------|           |------| Down |   4  |   5  |   6  |   +  |        |
  64  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  65  * |        |   %  |   ^  |   [  |   ]  |   ~  |      |           |      |   &  |   1  |   2  |   3  |   \  |        |
  66  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  67  *   |      |      |      |      |      |                                       |      |    . |   0  |   =  |      |
  68  *   `----------------------------------'                                       `----------------------------------'
  69  *                                        ,-------------.       ,-------------.
  70  *                                        |      |      |       |      |      |
  71  *                                 ,------|------|------|       |------+------+------.
  72  *                                 |      |      |      |       |      |      |      |
  73  *                                 |      |      |------|       |------|      |      |
  74  *                                 |      |      |      |       |      |      |      |
  75  *                                 `--------------------'       `--------------------'
  76  */
  77 // SYMBOLS
  78 [SYMB] = KEYMAP(
  79        // left hand
  80        KC_TRNS,KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_TRNS,
  81        KC_TRNS,KC_EXLM,KC_AT,  KC_LCBR,KC_RCBR,KC_PIPE,KC_TRNS,
  82        KC_TRNS,KC_HASH,KC_DLR, KC_LPRN,KC_RPRN,KC_GRV,
  83        KC_TRNS,KC_PERC,KC_CIRC,KC_LBRC,KC_RBRC,KC_TILD,KC_TRNS,
  84        KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
  85                                        KC_TRNS,KC_TRNS,
  86                                                KC_TRNS,
  87                                KC_TRNS,KC_TRNS,KC_TRNS,
  88        // right hand
  89        KC_TRNS, KC_F6,   KC_F7,  KC_F8,   KC_F9,   KC_F10,  KC_F11,
  90        KC_TRNS, KC_UP,   KC_7,   KC_8,    KC_9,    KC_ASTR, KC_F12,
  91                 KC_DOWN, KC_4,   KC_5,    KC_6,    KC_PLUS, KC_TRNS,
  92        KC_TRNS, KC_AMPR, KC_1,   KC_2,    KC_3,    KC_BSLS, KC_TRNS,
  93                          KC_TRNS,KC_DOT,  KC_0,    KC_EQL,  KC_TRNS,
  94        KC_TRNS, KC_TRNS,
  95        KC_TRNS,
  96        KC_TRNS, KC_TRNS, KC_TRNS
  97 ),
  98 /* Keymap 2: Media and mouse keys
  99  *
 100  * ,--------------------------------------------------.           ,--------------------------------------------------.
 101  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 102  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 103  * |        |      |      | MsUp |      |      |      |           |      |      |      |      |      |      |        |
 104  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 105  * |        |      |MsLeft|MsDown|MsRght|      |------|           |------|      |      |      |      |      |  Play  |
 106  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 107  * |        |      |      |      |      |      |      |           |      |      |      | Prev | Next |      |        |
 108  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 109  *   |      |      |      | Lclk | Rclk |                                       |VolUp |VolDn | Mute |      |      |
 110  *   `----------------------------------'                                       `----------------------------------'
 111  *                                        ,-------------.       ,-------------.
 112  *                                        |      |      |       |      |      |
 113  *                                 ,------|------|------|       |------+------+------.
 114  *                                 |      |      |      |       |      |      |Brwser|
 115  *                                 |      |      |------|       |------|      |Back  |
 116  *                                 |      |      |      |       |      |      |      |
 117  *                                 `--------------------'       `--------------------'
 118  */
 119 // MEDIA AND MOUSE
 120 [MDIA] = KEYMAP(
 121        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 122        KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_TRNS,
 123        KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
 124        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 125        KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN2,
 126                                            KC_TRNS, KC_TRNS,
 127                                                     KC_TRNS,
 128                                   KC_TRNS, KC_TRNS, KC_TRNS,
 129     // right hand
 130        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 131        KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 132                  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MPLY,
 133        KC_TRNS,  KC_TRNS, KC_TRNS, KC_MPRV, KC_MNXT, KC_TRNS, KC_TRNS,
 134                           KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS,
 135        KC_TRNS, KC_TRNS,
 136        KC_TRNS,
 137        KC_TRNS, KC_TRNS, KC_WBAK
 138 ),
 139 };
 140
 141 const uint16_t PROGMEM fn_actions[] = {
 142     [1] = ACTION_LAYER_TAP_TOGGLE(SYMB)                // FN1 - Momentary Layer 1 (Symbols)
 143 };
 144
 145 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 146 {
 147   // MACRODOWN only works in this function
 148       switch(id) {
 149         case 0:
 150         if (record->event.pressed) {
 151           register_code(KC_RSFT);
 152         } else {
 153           unregister_code(KC_RSFT);
 154         }
 155         break;
 156       }
 157     return MACRO_NONE;
 158 };
 159
 160 // Runs just one time when the keyboard initializes.
 161 void matrix_init_user(void) {
 162
 163 };
 164
 165 // Runs constantly in the background, in a loop.
 166 void matrix_scan_user(void) {
 167
 168     uint8_t layer = biton32(layer_state);
 169
 170     ergodox_board_led_off();
 171     ergodox_right_led_1_off();
 172     ergodox_right_led_2_off();
 173     ergodox_right_led_3_off();
 174     switch (layer) {
 175       // TODO: Make this relevant to the ErgoDox EZ.
 176         case 1:
 177             ergodox_right_led_1_on();
 178             break;
 179         case 2:
 180             ergodox_right_led_2_on();
 181             break;
 182         default:
 183             // none
 184             break;
 185     }
 186
 187 };