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