keyboards/planck/keymaps/steno/keymap.c

   1 /* Copyright 2015-2017 Jack Humbert
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
  18 #include "planck.h"
  19 #include "action_layer.h"
  20 #include "keymap_steno.h"
  21
  22 extern keymap_config_t keymap_config;
  23
  24 enum planck_layers {
  25   _QWERTY,
  26   _COLEMAK,
  27   _DVORAK,
  28   _LOWER,
  29   _RAISE,
  30   _PLOVER,
  31   _ADJUST
  32 };
  33
  34 enum planck_keycodes {
  35   QWERTY = SAFE_RANGE,
  36   COLEMAK,
  37   DVORAK,
  38   PLOVER,
  39   LOWER,
  40   RAISE,
  41   BACKLIT,
  42   EXT_PLV
  43 };
  44
  45 #define ST_BOLT QK_STENO_BOLT
  46 #define ST_GEM  QK_STENO_GEMINI
  47
  48 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  49
  50 /* Qwerty
  51  * ,-----------------------------------------------------------------------------------.
  52  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  53  * |------+------+------+------+------+-------------+------+------+------+------+------|
  54  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  55  * |------+------+------+------+------+------|------+------+------+------+------+------|
  56  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  57  * |------+------+------+------+------+------+------+------+------+------+------+------|
  58  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  59  * `-----------------------------------------------------------------------------------'
  60  */
  61 [_QWERTY] = {
  62   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  63   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  64   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  65   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  66 },
  67
  68 /* Colemak
  69  * ,-----------------------------------------------------------------------------------.
  70  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  71  * |------+------+------+------+------+-------------+------+------+------+------+------|
  72  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  73  * |------+------+------+------+------+------|------+------+------+------+------+------|
  74  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  75  * |------+------+------+------+------+------+------+------+------+------+------+------|
  76  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  77  * `-----------------------------------------------------------------------------------'
  78  */
  79 [_COLEMAK] = {
  80   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  81   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  82   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  83   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  84 },
  85
  86 /* Dvorak
  87  * ,-----------------------------------------------------------------------------------.
  88  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  89  * |------+------+------+------+------+-------------+------+------+------+------+------|
  90  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  91  * |------+------+------+------+------+------|------+------+------+------+------+------|
  92  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  93  * |------+------+------+------+------+------+------+------+------+------+------+------|
  94  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  95  * `-----------------------------------------------------------------------------------'
  96  */
  97 [_DVORAK] = {
  98   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  99   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
 100   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
 101   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 102 },
 103
 104 /* Lower
 105  * ,-----------------------------------------------------------------------------------.
 106  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 107  * |------+------+------+------+------+-------------+------+------+------+------+------|
 108  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 109  * |------+------+------+------+------+------|------+------+------+------+------+------|
 110  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
 111  * |------+------+------+------+------+------+------+------+------+------+------+------|
 112  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 113  * `-----------------------------------------------------------------------------------'
 114  */
 115 [_LOWER] = {
 116   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC},
 117   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
 118   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END,  _______},
 119   {_______, _______, _______, _______, _______, _______, _______, _______,    KC_MNXT,    KC_VOLD, KC_VOLU, KC_MPLY}
 120 },
 121
 122 /* Raise
 123  * ,-----------------------------------------------------------------------------------.
 124  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 125  * |------+------+------+------+------+-------------+------+------+------+------+------|
 126  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 127  * |------+------+------+------+------+------|------+------+------+------+------+------|
 128  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
 129  * |------+------+------+------+------+------+------+------+------+------+------+------|
 130  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 131  * `-----------------------------------------------------------------------------------'
 132  */
 133 [_RAISE] = {
 134   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 135   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 136   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______},
 137   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 138 },
 139
 140 /* Plover layer (http://opensteno.org)
 141  * ,-----------------------------------------------------------------------------------.
 142  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 143  * |------+------+------+------+------+-------------+------+------+------+------+------|
 144  * |  FN  |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 145  * |------+------+------+------+------+------|------+------+------+------+------+------|
 146  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 147  * |------+------+------+------+------+------+------+------+------+------+------+------|
 148  * | Exit |      |      |   A  |   O  |             |   E  |   U  |  PWR | RES1 | RES2 |
 149  * `-----------------------------------------------------------------------------------'
 150  */
 151
 152 [_PLOVER] = {
 153   {STN_N1,  STN_N2,  STN_N3,  STN_N4,  STN_N5,  STN_N6,  STN_N7,  STN_N8,  STN_N9,  STN_NA,  STN_NB,  STN_NC },
 154   {STN_FN,  STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1, STN_ST3, STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR },
 155   {XXXXXXX, STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2, STN_ST4, STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR },
 156   {EXT_PLV, XXXXXXX, XXXXXXX, STN_A,   STN_O,   XXXXXXX, XXXXXXX, STN_E,   STN_U,   STN_PWR, STN_RE1, STN_RE2}
 157 },
 158
 159 /* Adjust (Lower + Raise)
 160  * ,-----------------------------------------------------------------------------------.
 161  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 162  * |------+------+------+------+------+-------------+------+------+------+------+------|
 163  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 164  * |------+------+------+------+------+------|------+------+------+------+------+------|
 165  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |TXBOLT|GEM RP|
 166  * |------+------+------+------+------+------+------+------+------+------+------+------|
 167  * |      |      |      |      |      |             |      |      |      |      |      |
 168  * `-----------------------------------------------------------------------------------'
 169  */
 170 [_ADJUST] = {
 171   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
 172   {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 173   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, ST_BOLT, ST_GEM},
 174   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 175 }
 176
 177
 178 };
 179
 180 #ifdef AUDIO_ENABLE
 181   float plover_song[][2]     = SONG(PLOVER_SOUND);
 182   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 183 #endif
 184
 185 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 186   switch (keycode) {
 187     case QWERTY:
 188       if (record->event.pressed) {
 189         set_single_persistent_default_layer(_QWERTY);
 190       }
 191       return false;
 192       break;
 193     case COLEMAK:
 194       if (record->event.pressed) {
 195         set_single_persistent_default_layer(_COLEMAK);
 196       }
 197       return false;
 198       break;
 199     case DVORAK:
 200       if (record->event.pressed) {
 201         set_single_persistent_default_layer(_DVORAK);
 202       }
 203       return false;
 204       break;
 205     case LOWER:
 206       if (record->event.pressed) {
 207         layer_on(_LOWER);
 208         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 209       } else {
 210         layer_off(_LOWER);
 211         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 212       }
 213       return false;
 214       break;
 215     case RAISE:
 216       if (record->event.pressed) {
 217         layer_on(_RAISE);
 218         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 219       } else {
 220         layer_off(_RAISE);
 221         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 222       }
 223       return false;
 224       break;
 225     case BACKLIT:
 226       if (record->event.pressed) {
 227         register_code(KC_RSFT);
 228         #ifdef BACKLIGHT_ENABLE
 229           backlight_step();
 230         #endif
 231       } else {
 232         unregister_code(KC_RSFT);
 233       }
 234       return false;
 235       break;
 236     case PLOVER:
 237       if (!record->event.pressed) {
 238         #ifdef AUDIO_ENABLE
 239           stop_all_notes();
 240           PLAY_SONG(plover_song);
 241         #endif
 242         layer_on(_PLOVER);
 243       }
 244       return false;
 245       break;
 246     case EXT_PLV:
 247       if (record->event.pressed) {
 248         #ifdef AUDIO_ENABLE
 249           PLAY_SONG(plover_gb_song);
 250         #endif
 251         layer_off(_PLOVER);
 252       }
 253       return false;
 254       break;
 255   }
 256   return true;
 257 }