layouts/community/ergodox/xyverz/keymap.c

   1 /*
   2  * About this keymap:
   3  *
   4  * The Dvorak layout shown herestems from my early Kinesis years, using the Contour PS/2 with a Dvorak
   5  * software layout. Because of this, the RBRC and LBRC were on opposite sides of the board in the corner
   6  * keys. I've decided to continue using this layout with my ErgoDox.
   7  *
   8  * The QWERTY layout shown here is based entirely on the Kinesis Advantage layout, with the additional
   9  * keys as shown in the diagrams. The Colemak layout is merely an adaptation of that.
  10  *
  11  * I've enabled persistent keymaps for Qwerty, Dvorak and Colemak layers, similar to the default Planck
  12  * layouts.
  13  *
  14  */
  15
  16 #include QMK_KEYBOARD_H
  17 #include "debug.h"
  18 #include "action_layer.h"
  19 #include "eeconfig.h"
  20
  21 extern keymap_config_t keymap_config;
  22
  23 #define _DV 0 // Dvorak layer
  24 #define _QW 1 // Qwerty layer
  25 #define _CM 2 // Colemak layer
  26 #define _MD 3 // Media Layer
  27 #define _KP 4 // Keypad Layer
  28
  29 // Macro name shortcuts
  30 #define DVORAK M(_DV)
  31 #define QWERTY M(_QW)
  32 #define COLEMAK M(_CM)
  33
  34 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  35
  36 /* Layer 0 : Dvorak
  37  * ,--------------------------------------------------. ,--------------------------------------------------.
  38  * |   =    |   1  |   2  |   3  |   4  |   5  | ESC  | | ESC  |   6  |   7  |   8  |   9  |   0  |   /    |
  39  * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
  40  * | Tab    |   '  |   ,  |   .  |   P  |   Y  |      | |      |   F  |   G  |   C  |   R  |   L  |   \    |
  41  * |--------+------+------+------+------+------|      | |      |------+------+------+------+------+--------|
  42  * | CapsLk |   A  |   O  |   E  |   U  |   I  |------| |------|   D  |   H  |   T  |   N  |   S  |   -    |
  43  * |--------+------+------+------+------+------| _MD  | | _KP  |------+------+------+------+------+--------|
  44  * | LShift |   ;  |   Q  |   J  |   K  |   X  |      | |      |   B  |   M  |   W  |   V  |   Z  | RShift |
  45  * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
  46  *   | LGUI |   `  |  INS | Left | Rght |                             |  Up  |  Dn  |   [  |   ]  | RGUI |
  47  *   `----------------------------------'                             `----------------------------------'
  48  *                                      ,-------------. ,-------------.
  49  *                                      | LCTL | LALT | | RALT | RCTL |
  50  *                               ,------|------|------| |------+------+------.
  51  *                               |      |      | Home | | PgUp |      |      |
  52  *                               | BkSp | Del  |------| |------| Enter| Space|
  53  *                               |      |      | End  | | PgDn |      |      |
  54  *                               `--------------------' `--------------------'
  55  *
  56  */
  57 [_DV] = LAYOUT_ergodox(
  58         // left hand
  59         KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_ESC,
  60         KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    XXXXXXX,
  61         KC_CAPS, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,
  62         KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    MO(_MD),
  63         KC_LGUI, KC_GRV,  KC_INS,  KC_LEFT, KC_RGHT,
  64                                             KC_LCTL, KC_LALT,
  65                                                      KC_HOME,
  66                                    KC_BSPC, KC_DEL,  KC_END,
  67         // right hand
  68         KC_ESC,  KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_SLSH,
  69         XXXXXXX, KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSLS,
  70                  KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_MINS,
  71         MO(_KP), KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_RSFT,
  72                           KC_UP,   KC_DOWN, KC_LBRC, KC_RBRC, KC_RGUI,
  73         KC_RALT, KC_RCTL,
  74         KC_PGUP,
  75         KC_PGDN, KC_ENT,  KC_SPC
  76   ),
  77
  78
  79 /* Layer 1: QWERTY
  80  * ,--------------------------------------------------. ,--------------------------------------------------.
  81  * |   =    |   1  |   2  |   3  |   4  |   5  | ESC  | | ESC  |   6  |   7  |   8  |   9  |   0  |   -    |
  82  * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
  83  * | Tab    |   Q  |   W  |   E  |   R  |   T  |      | |      |   Y  |   U  |   I  |   O  |   P  |   \    |
  84  * |--------+------+------+------+------+------|      | |      |------+------+------+------+------+--------|
  85  * | CapsLk |   A  |   S  |   D  |   F  |   G  |------| |------|   H  |   J  |   K  |   L  |   ;  |   '    |
  86  * |--------+------+------+------+------+------| _MD  | | _KP  |------+------+------+------+------+--------|
  87  * | LShift |   Z  |   X  |   C  |   V  |   B  |      | |      |   N  |   M  |   ,  |   .  |   /  | RShift |
  88  * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
  89  *   | LGUI |   `  |  INS | Left | Rght |                             |  Up  |  Dn  |   [  |   ]  | RGUI |
  90  *   `----------------------------------'                             `----------------------------------'
  91  *                                      ,-------------. ,-------------.
  92  *                                      | LCTL | LALT | | RALT | RCTL |
  93  *                               ,------|------|------| |------+------+------.
  94  *                               |      |      | Home | | PgUp |      |      |
  95  *                               | BkSp | Del  |------| |------| Enter| Space|
  96  *                               |      |      | End  | | PgDn |      |      |
  97  *                               `--------------------' `--------------------'
  98  */
  99 [_QW] = LAYOUT_ergodox(
 100         // left hand
 101         KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_LEFT,
 102         KC_DELT, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    XXXXXXX,
 103         KC_BSPC, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,
 104         KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    MO(_MD),
 105         KC_LGUI, KC_GRV,  KC_INS,  KC_LEFT, KC_RGHT,
 106                                             KC_LCTL, KC_LALT,
 107                                                      KC_HOME,
 108                                    KC_BSPC, KC_DEL,  KC_END,
 109         // right hand
 110         KC_ESC,  KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,
 111         XXXXXXX, KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSLS,
 112                  KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
 113         MO(_KP), KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,
 114                           KC_UP,   KC_DOWN, KC_LBRC, KC_RBRC, KC_RGUI,
 115         KC_LALT, KC_LCTL,
 116         KC_PGUP,
 117         KC_PGDN, KC_ENT, KC_SPC
 118   ),
 119
 120
 121 /* Layer 2 : Colemak
 122  * ,--------------------------------------------------. ,--------------------------------------------------.
 123  * |   =    |   1  |   2  |   3  |   4  |   5  | ESC  | | ESC  |   6  |   7  |   8  |   9  |   0  |   -    |
 124  * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
 125  * | Tab    |   Q  |   W  |   F  |   P  |   G  |      | |      |   J  |   L  |   U  |   Y  |   ;  |   \    |
 126  * |--------+------+------+------+------+------|      | |      |------+------+------+------+------+--------|
 127  * | BkSpc  |   A  |   R  |   S  |   T  |   D  |------| |------|   H  |   N  |   E  |   I  |   O  |   '    |
 128  * |--------+------+------+------+------+------| _MD  | | _KP  |------+------+------+------+------+--------|
 129  * | LShift |   Z  |   X  |   C  |   V  |   B  |      | |      |   K  |   M  |   ,  |   .  |   /  | RShift |
 130  * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
 131  *   | LGUI |   `  |  INS | Left | Rght |                             |  Up  |  Dn  |   [  |   ]  | RGUI |
 132  *   `----------------------------------'                             `----------------------------------'
 133  *                                      ,-------------. ,-------------.
 134  *                                      | LCTL | LALT | | RALT | RCTL |
 135  *                               ,------|------|------| |------+------+------.
 136  *                               |      |      | Home | | PgUp |      |      |
 137  *                               | BkSp | Del  |------| |------| Enter| Space|
 138  *                               |      |      | End  | | PgDn |      |      |
 139  *                               `--------------------' `--------------------'
 140  */
 141 [_CM] = LAYOUT_ergodox(
 142         // left hand
 143         KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_LEFT,
 144         KC_DELT, KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    XXXXXXX,
 145         KC_BSPC, KC_A,    KC_R,    KC_S,    KC_T,    KC_D,
 146         KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    MO(_MD),
 147         KC_LGUI, KC_GRV,  KC_INS,  KC_LEFT, KC_RGHT,
 148                                             KC_LCTL, KC_LALT,
 149                                                      KC_HOME,
 150                                    KC_BSPC, KC_DEL,  KC_END,
 151         // right hand
 152         KC_ESC,  KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,
 153         XXXXXXX, KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSLS,
 154                  KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT,
 155         MO(_KP), KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,
 156                           KC_UP,   KC_DOWN, KC_LBRC, KC_RBRC, KC_RGUI,
 157         KC_LALT, KC_LCTL,
 158         KC_PGUP,
 159         KC_PGDN, KC_ENT, KC_SPC
 160   ),
 161
 162
 163 /* Layer 3 : Media layer
 164  * ,--------------------------------------------------. ,--------------------------------------------------.
 165  * | TEENSY |  F1  |  F2  |  F3  |  F4  |  F5  | F11  | |  F12 |  F6  |  F7  |  F8  |  F9  |  F10 |        |
 166  * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
 167  * |        |      | PrSc | ScLk | Paus |      |      | |      |      | Mute | Vol- | Vol+ |      |        |
 168  * |--------+------+------+------+------+------|      | |      |------+------+------+------+------+--------|
 169  * |        |      |      |      |      |      |------| |------| Stop | Prev | Play | Next | Sel  |        |
 170  * |--------+------+------+------+------+------|      | |      |------+------+------+------+------+--------|
 171  * |        |      |Dvorak|Qwerty|Colemk|      |      | |      |      |      |      |      |      |        |
 172  * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
 173  *   |      |      |      |      |      |                             |      |      |      |      |      |
 174  *   `----------------------------------'                             `----------------------------------'
 175  *                                      ,-------------. ,-------------.
 176  *                                      |      |      | |      |      |
 177  *                               ,------|------|------| |------+------+------.
 178  *                               |      |      |      | |      |      |      |
 179  *                               |      |      |------| |------|      |      |
 180  *                               |      |      |      | |      |      |      |
 181  *                               `--------------------' `--------------------'
 182  */
 183 [_MD] = LAYOUT_ergodox(
 184         // left hand
 185         RESET,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F11,
 186         _______, _______, KC_PSCR, KC_SLCK, KC_PAUS, _______, _______,
 187         _______, _______, _______, _______, _______, _______,
 188         _______, _______, DVORAK,  QWERTY,  COLEMAK, _______, _______,
 189         _______, _______, _______, _______, _______,
 190                                             _______, _______,
 191                                                      _______,
 192                                    _______, _______, _______,
 193         // right hand
 194         KC_F12,  KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  _______,
 195         _______, _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______,
 196                  KC_MSTP, KC_MPRV, KC_MPLY, KC_MNXT, KC_MSEL, _______,
 197         _______, _______, _______, _______, _______, _______, _______,
 198                           _______, _______, _______, _______, _______,
 199         _______, _______,
 200         _______,
 201         _______, _______, _______
 202   ),
 203
 204
 205 /* Layer 4 : Keypad layer
 206  * ,--------------------------------------------------. ,--------------------------------------------------.
 207  * | Power  |      |      |      |      |      |      | |      |      | NmLk | KP = | KP / | KP * |        |
 208  * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
 209  * | Sleep  |      |      |      |      |      |      | |      |      | KP 7 | KP 8 | KP 9 | KP - |        |
 210  * |--------+------+------+------+------+------|      | |      |------+------+------+------+------+--------|
 211  * | Wake   |      |      |      |      |      |------| |------|      | KP 4 | KP 5 | KP 6 | KP + |        |
 212  * |--------+------+------+------+------+------|      | |      |------+------+------+------+------+--------|
 213  * |        |      |      |      |      |      |      | |      |      | KP 1 | KP 2 | KP 3 |KP Ent|        |
 214  * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
 215  *   |      |      |      |      |      |                             | KP 0 |      | KP . |KP Ent|      |
 216  *   `----------------------------------'                             `----------------------------------'
 217  *                                      ,-------------. ,-------------.
 218  *                                      |      |      | |      |      |
 219  *                               ,------|------|------| |------+------+------.
 220  *                               |      |      |      | |      |      |      |
 221  *                               |      |      |------| |------|      |      |
 222  *                               |      |      |      | |      |      |      |
 223  *                               `--------------------' `--------------------'
 224  */
 225 [_KP] = LAYOUT_ergodox(
 226         // left hand
 227         KC_PWR,  _______, _______, _______, _______, _______, _______,
 228         KC_SLEP, _______, _______, _______, _______, _______, _______,
 229         KC_WAKE, _______, _______, _______, _______, _______,
 230         _______, _______, _______, _______, _______, _______, _______,
 231         _______, _______, _______, _______, _______,
 232                                             _______, _______,
 233                                                      _______,
 234                                    _______, _______, _______,
 235         // right hand
 236         _______, _______, KC_NLCK, KC_PEQL, KC_PSLS, KC_PAST, _______,
 237         _______, _______, KC_P7,   KC_P8,   KC_P9,   KC_PMNS, _______,
 238                  _______, KC_P4,   KC_P5,   KC_P6,   KC_PPLS, _______,
 239         _______, _______, KC_P1,   KC_P2,   KC_P3,   KC_PENT, _______,
 240                           KC_P0,   _______, KC_PDOT, KC_PENT, _______,
 241         _______, _______,
 242         _______,
 243         _______, _______, _______
 244   ),
 245
 246 };
 247
 248 void persistent_default_layer_set(uint16_t default_layer) {
 249   eeconfig_update_default_layer(default_layer);
 250   default_layer_set(default_layer);
 251 }
 252
 253
 254 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 255 {
 256       switch(id) {
 257         case _DV:
 258           if (record->event.pressed) {
 259             persistent_default_layer_set(1UL<<_DV);
 260           }
 261           break;
 262         case _QW:
 263           if (record->event.pressed) {
 264             persistent_default_layer_set(1UL<<_QW);
 265           }
 266           break;
 267         case _CM:
 268           if (record->event.pressed) {
 269             persistent_default_layer_set(1UL<<_CM);
 270           }
 271           break;
 272       }
 273     return MACRO_NONE;
 274 };
 275
 276 // Runs just one time when the keyboard initializes.
 277 void matrix_init_user(void) {
 278
 279 };
 280
 281 // Runs constantly in the background, in a loop.
 282 void matrix_scan_user(void) {
 283
 284     uint8_t layer = biton32(layer_state);
 285
 286     ergodox_board_led_off();
 287     ergodox_right_led_1_off();
 288     ergodox_right_led_2_off();
 289     ergodox_right_led_3_off();
 290     switch (layer) {
 291       // TODO: Make this relevant to the ErgoDox EZ.
 292         case 1:
 293             ergodox_right_led_1_on();
 294             break;
 295         case 2:
 296             ergodox_right_led_2_on();
 297             break;
 298         default:
 299             // none
 300             break;
 301     }
 302
 303 };