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