keyboards/ergodox_ez/keymaps/steno/keymap.c

   1 #include QMK_KEYBOARD_H
   2 #include "debug.h"
   3 #include "action_layer.h"
   4 #include "keymap_steno.h"
   5
   6 #define BASE 0 // default layer
   7 #define SYMB 1 // symbols
   8 #define MDIA 2 // media keys
   9 #define TXBOLT 3 // TxBolt Steno Virtual Serial
  10 #define TXBOLT2 4 // TxBolt Steno Virtual Serial Alternative Layout
  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  |           |  TX  |   Y  |   U  |   I  |   O  |   P  |   \    |
  19  * |--------+------+------+------+------+------|      |           | BOLT |------+------+------+------+------+--------|
  20  * | BkSp   |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |; / L2|' / Cmd |
  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] = LAYOUT_ergodox(  // 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(TXBOLT),  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),GUI_T(KC_QUOT),
  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,          TT(SYMB),
  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  * |Version |  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] = LAYOUT_ergodox(
  79        // left hand
  80        M(0),   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  * | RESET  |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 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] = LAYOUT_ergodox(
 121        RESET,   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 /* Keymap 3: TxBolt (Serial)
 140  *
 141  * ,--------------------------------------------------.           ,--------------------------------------------------.
 142  * | BKSPC  |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 143  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 144  * |        |   #  |   #  |   #  |   #  |   #  |      |           |      |   #  |   #  |   #  |   #  |   #  |   #    |
 145  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 146  * |        |   S  |   T  |   P  |   H  |   *  |------|           |------|   *  |   F  |   P  |   L  |   T  |   D    |
 147  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 148  * |        |   S  |   K  |   W  |   R  |   *  |      |           |      |   *  |   R  |   B  |   G  |   S  |   Z    |
 149  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 150  *   |      |      |      |      |      |                                       |      |      |      |      |      |
 151  *   `----------------------------------'                                       `----------------------------------'
 152  *                                        ,-------------.       ,-------------.
 153  *                                        |      |      |       |      |      |
 154  *                                 ,------|------|------|       |------+------+------.
 155  *                                 |      |      |      |       |      |      |      |
 156  *                                 |   A  |   O  |------|       |------|   E  |   U  |
 157  *                                 |      |      |      |       |      |      |      |
 158  *                                 `--------------------'       `--------------------'
 159  */
 160 // TxBolt over Serial
 161 [TXBOLT] = LAYOUT_ergodox(
 162        KC_BSPC, KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 163        KC_NO,   STN_N1,  STN_N2,  STN_N3,  STN_N4,  STN_N5,  KC_NO,
 164        KC_NO,   STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1,
 165        KC_NO,   STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2, KC_NO,
 166        KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 167                                            KC_NO,   KC_NO,
 168                                                     KC_NO,
 169                                   STN_A,   STN_O,   KC_NO,
 170     // right hand
 171        KC_NO,    KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 172        KC_TRNS,  STN_N6,  STN_N7,  STN_N8,  STN_N9,  STN_NA,  STN_NB,
 173                  STN_ST3, STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR,
 174        KC_NO,    STN_ST4, STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR,
 175                           KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 176        KC_NO,   KC_NO,
 177        KC_NO,
 178        KC_NO,   STN_E,   STN_U
 179 ),
 180 /* Keymap 4: TxBolt (Serial) Alternative
 181  *
 182  * ,--------------------------------------------------.           ,--------------------------------------------------.
 183  * |        |   #  |   #  |   #  |   #  |   #  |      |           |      |   #  |   #  |   #  |   #  |   #  |   #    |
 184  * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
 185  * |        |   S  |   T  |   P  |   H  |   *  |      |           |      |   *  |   F  |   P  |   L  |   T  |   D    |
 186  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 187  * |        |   S  |   K  |   W  |   R  |   *  |------|           |------|   *  |   R  |   B  |   G  |   S  |   Z    |
 188  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 189  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
 190  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
 191  *   |      |      |      |   A  |   O  |                                       |   E  |   U  |      |      |      |
 192  *   `----------------------------------'                                       `----------------------------------'
 193  *                                        ,-------------.       ,-------------.
 194  *                                        |      |      |       |      |      |
 195  *                                 ,------|------|------|       |------+------+------.
 196  *                                 |      |      |      |       |      |      |      |
 197  *                                 |      |      |------|       |------|      |      |
 198  *                                 |      |      |      |       |      |      |      |
 199  *                                 `--------------------'       `--------------------'
 200  */
 201 // TxBolt over Serial
 202 [TXBOLT2] = LAYOUT_ergodox(
 203        KC_NO,   STN_N1,  STN_N2,  STN_N3,  STN_N4,  STN_N5,  KC_NO,
 204        KC_NO,   STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1, KC_NO,
 205        KC_NO,   STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2,
 206        KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 207        KC_NO,   KC_NO,   KC_NO,   STN_A,   STN_O,
 208                                            KC_NO,   KC_NO,
 209                                                     KC_NO,
 210                                   KC_NO,   KC_NO,   KC_NO,
 211     // right hand
 212        KC_NO,    STN_N6,  STN_N7,  STN_N8,  STN_N9,  STN_NA,  STN_NB,
 213        KC_TRNS,  STN_ST3, STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR,
 214                  STN_ST4, STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR,
 215        KC_NO,    KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
 216                           STN_E,   STN_U,   KC_NO,   KC_NO,   KC_NO,
 217        KC_NO,   KC_NO,
 218        KC_NO,
 219        KC_NO,   KC_NO,   KC_NO
 220 ),
 221 };
 222
 223 // Runs just one time when the keyboard initializes.
 224 void matrix_init_user(void) {
 225     steno_set_mode(STENO_MODE_BOLT); // or STENO_MODE_GEMINI
 226 };
 227
 228 // Runs constantly in the background, in a loop.
 229 void matrix_scan_user(void) {
 230
 231     uint8_t layer = biton32(layer_state);
 232
 233     ergodox_board_led_off();
 234     ergodox_right_led_1_off();
 235     ergodox_right_led_2_off();
 236     ergodox_right_led_3_off();
 237     switch (layer) {
 238       // TODO: Make this relevant to the ErgoDox EZ.
 239         case 1:
 240             ergodox_right_led_1_on();
 241             break;
 242         case 2:
 243             ergodox_right_led_2_on();
 244             break;
 245         default:
 246             // none
 247             break;
 248     }
 249
 250 };