layouts/community/ergodox/plover/keymap.c

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