keyboards/planck/keymaps/dcompact/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 // Custom Keycodes and Combinations Used
  23 #define DEL_SHF SFT_T(KC_DEL)
  24 #define QUAKE LCTL(KC_GRV)
  25
  26 #define WKSP_L LALT(LCTL(KC_LEFT))
  27 #define WKSP_D LALT(LCTL(KC_DOWN))
  28 #define WKSP_U LALT(LCTL(KC_UP))
  29 #define WKSP_R LALT(LCTL(KC_RGHT))
  30
  31 extern keymap_config_t keymap_config;
  32
  33 enum planck_layers {
  34   _BASE,
  35   _LOWER,
  36   _RAISE,
  37   _FUNC,
  38   _PLOVER,
  39   _ADJUST,
  40   _MOUSE
  41 };
  42
  43 enum planck_keycodes {
  44   BASE = SAFE_RANGE,
  45   PLOVER,
  46   LOWER,
  47   RAISE,
  48   FUNC,
  49   MOUSE,
  50   ADJUST,
  51   EXT_PLV
  52 };
  53
  54 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  55
  56 /* Base
  57  * ,-----------------------------------------------------------------------------------.
  58  * | Tab  | " '  | < ,  | > .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | ? /  |
  59  * |------+------+------+------+------+-------------+------+------+------+------+------|
  60  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  | _ -  |
  61  * |------+------+------+------+------+------|------+------+------+------+------+------|
  62  * |Del/Sf|  : ; |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  | Bspc |
  63  * |------+------+------+------+------+------+------+------+------+------+------+------|
  64  * | Ctrl |Plover| GUI  | Alt  |Lower |Shift |Space |Raise | Alt  | GUI  |  Fn  |Enter |
  65  * `-----------------------------------------------------------------------------------'
  66  */
  67 [_BASE] = {
  68   {  KC_TAB, KC_QUOT, KC_COMM,  KC_DOT,    KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L, KC_SLSH},
  69   {  KC_ESC,    KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S, KC_MINS},
  70   { DEL_SHF, KC_SCLN,    KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z, KC_BSPC},
  71   { KC_LCTL,  PLOVER, KC_LGUI, KC_LALT,   LOWER,  KC_LSFT,  KC_SPC,   RAISE, KC_RALT, KC_RGUI,    FUNC,  KC_ENT}
  72 },
  73
  74 /* Lower
  75  * ,-----------------------------------------------------------------------------------.
  76  * |      |      |      |      |      |      |      | Home |PgDwn | PgUp | End  |      |
  77  * |------+------+------+------+------+-------------+------+------+------+------+------|
  78  * |      |PrScr | Menu |      |      |      |      | Left | Down |  Up  |Right |      |
  79  * |------+------+------+------+------+------|------+------+------+------+------+------|
  80  * |      |CapsLk|NumLck| Ins  |      |      |      |WkLeft|WkDown| WkUp |WkRigh|      |
  81  * |------+------+------+------+------+------+------+------+------+------+------+------|
  82  * |      |      |      |      |      |      |      |Raise |      |      |      |      |
  83  * `-----------------------------------------------------------------------------------'
  84  */
  85 [_LOWER] = {
  86   { XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_HOME, KC_PGDN, KC_PGUP,  KC_END, XXXXXXX},
  87   { XXXXXXX, KC_PSCR, KC_MENU, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN,   KC_UP, KC_RGHT, XXXXXXX},
  88   { XXXXXXX, KC_CAPS, KC_LNUM,  KC_INS, XXXXXXX, XXXXXXX, XXXXXXX,  WKSP_L,  WKSP_D,  WKSP_U,  WKSP_R, XXXXXXX},
  89   { _______, XXXXXXX, _______, _______, _______, _______, XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX}
  90 },
  91
  92 /* Raise
  93  * ,-----------------------------------------------------------------------------------.
  94  * |Quake |   `  |   ~  |   \  |   |  |   (  |   )  |   7  |   8  |   9  |   /  |  =   |
  95  * |------+------+------+------+------+-------------+------+------+------+------+------|
  96  * |      |   !  |   @  |   #  |   $  |   {  |   }  |   4  |   5  |   6  |   *  |  +   |
  97  * |------+------+------+------+------+------|------+------+------+------+------+------|
  98  * |      |   %  |   ^  |   &  |   *  |   [  |   ]  |   1  |   2  |   3  |   -  |Bkspc |
  99  * |------+------+------+------+------+------+------+------+------+------+------+------|
 100  * |      |      |      |      |Lower |   <  |   >  |      |   0  |   .  |   ,  |      |
 101  * `-----------------------------------------------------------------------------------'
 102  */
 103 [_RAISE] = {
 104   {   QUAKE,  KC_GRV, KC_TILD, KC_BSLS, KC_PIPE, KC_LPRN, KC_RPRN,    KC_7,    KC_8,    KC_9, KC_SLSH,  KC_EQL},
 105   { XXXXXXX, KC_EXLM,   KC_AT, KC_HASH,  KC_DLR, KC_LCBR, KC_RCBR,    KC_4,    KC_5,    KC_6, KC_ASTR, KC_PLUS},
 106   { XXXXXXX, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LBRC, KC_RBRC,    KC_1,    KC_2,    KC_3, KC_MINS, KC_BSPC},
 107   { _______, XXXXXXX, _______, _______, _______, KC_LABK, KC_RABK, _______,    KC_0,  KC_DOT, KC_COMM, XXXXXXX}
 108 },
 109
 110 /* Func
 111  * ,-----------------------------------------------------------------------------------.
 112  * |      |Sleep |Prev-W|Ply/Ps|Next-W|      |      |  F9  | F10  | F11  | F12  |      |
 113  * |------+------+------+------+------+-------------+------+------+------+------+------|
 114  * |      | Wake | Mute | Vol- | Vol+ |      |      |  F5  |  F6  |  F7  |  F8  |      |
 115  * |------+------+------+------+------+------|------+------+------+------+------+------|
 116  * |      |Power |Prev-M|Ply/Ps|Next-M|      |      |  F1  |  F2  |  F3  |  F4  |      |
 117  * |------+------+------+------+------+------+------+------+------+------+------+------|
 118  * |      |      |      |      |      |      |      |      |      |      |      |      |
 119  * `-----------------------------------------------------------------------------------'
 120  */
 121 [_FUNC] = {
 122   { XXXXXXX, KC_SLEP, KC_MPRV, KC_MPLY, KC_MNXT, XXXXXXX, XXXXXXX,   KC_F9,  KC_F10,  KC_F11,  KC_F12, XXXXXXX},
 123   { XXXXXXX, KC_WAKE, KC_MUTE, KC_VOLD, KC_VOLU, XXXXXXX, XXXXXXX,   KC_F5,   KC_F6,   KC_F7,   KC_F8, XXXXXXX},
 124   { XXXXXXX,  KC_PWR, KC_MRWD, KC_MPLY, KC_MFFD, XXXXXXX, XXXXXXX,   KC_F1,   KC_F2,   KC_F3,   KC_F4, XXXXXXX},
 125   { _______, _______, _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX}
 126 },
 127
 128 /* Mouse (Not Reachable on Planck)
 129  * ,-----------------------------------------------------------------------------------.
 130  * |      |      |      |      |      |      |      |      |      |      |      |      |
 131  * |------+------+------+------+------+-------------+------+------+------+------+------|
 132  * |      |      |Click1|Click3|Click2|      |      |MouseL|MouseD|MouseU|MouseR|      |
 133  * |------+------+------+------+------+------|------+------+------+------+------+------|
 134  * |      |      |Accel0|Accel1|Accel2|      |      |ScrllL|ScrllD|ScrllU|ScrllR|      |
 135  * |------+------+------+------+------+------+------+------+------+------+------+------|
 136  * |      |      |      |      |      |      |      |      |      |      |      |      |
 137  * `-----------------------------------------------------------------------------------'
 138  */
 139 [_MOUSE] = {
 140   { XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
 141   { XXXXXXX, XXXXXXX, KC_BTN1, KC_BTN3, KC_BTN2, XXXXXXX, XXXXXXX, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, XXXXXXX},
 142   { XXXXXXX, XXXXXXX, KC_ACL0, KC_ACL1, KC_ACL2, XXXXXXX, XXXXXXX, KC_WH_L, KC_WH_D, KC_WH_U, KC_WH_R, XXXXXXX},
 143   { _______, _______, _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX}
 144 },
 145
 146 /* Plover layer (http://opensteno.org)
 147  * ,-----------------------------------------------------------------------------------.
 148  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 149  * |------+------+------+------+------+-------------+------+------+------+------+------|
 150  * |  FN  |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 151  * |------+------+------+------+------+------|------+------+------+------+------+------|
 152  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 153  * |------+------+------+------+------+------+------+------+------+------+------+------|
 154  * | Exit |      |      |   A  |   O  |             |   E  |   U  |  PWR | RES1 | RES2 |
 155  * `-----------------------------------------------------------------------------------'
 156  */
 157
 158 [_PLOVER] = {
 159   {STN_N1,  STN_N2,  STN_N3,  STN_N4,  STN_N5,  STN_N6,  STN_N7,  STN_N8,  STN_N9,  STN_NA,  STN_NB,  STN_NC },
 160   {STN_FN,  STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1, STN_ST3, STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR },
 161   {XXXXXXX, STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2, STN_ST4, STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR },
 162   {EXT_PLV, XXXXXXX, XXXXXXX, STN_A,   STN_O,   XXXXXXX, XXXXXXX, STN_E,   STN_U,   STN_PWR, STN_RE1, STN_RE2}
 163 },
 164
 165 /* Adjust (Lower + Raise)
 166  * ,-----------------------------------------------------------------------------------.
 167  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 168  * |------+------+------+------+------+-------------+------+------+------+------+------|
 169  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|      |      |      |      |      |
 170  * |------+------+------+------+------+------|------+------+------+------+------+------|
 171  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 172  * |------+------+------+------+------+------+------+------+------+------+------+------|
 173  * |      |      |      |      |      |             |      |      |      |      |      |
 174  * `-----------------------------------------------------------------------------------'
 175  */
 176 [_ADJUST] = {
 177   { _______,   RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
 178   { _______, _______, _______,   AU_ON,  AU_OFF, AG_NORM, AG_SWAP, _______, _______, _______, _______, _______},
 179   { _______,  MUV_DE,  MUV_IN,   MU_ON,  MU_OFF,   MI_ON,  MI_OFF, _______, _______, _______, _______, _______},
 180   { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 181 }
 182
 183 };
 184
 185 #ifdef AUDIO_ENABLE
 186   float plover_song[][2]     = SONG(PLOVER_SOUND);
 187   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 188 #endif
 189
 190 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 191   switch (keycode) {
 192     case LOWER:
 193       if (record->event.pressed) {
 194         layer_on(_LOWER);
 195         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 196       } else {
 197         layer_off(_LOWER);
 198         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 199       }
 200       return false;
 201       break;
 202     case RAISE:
 203       if (record->event.pressed) {
 204         layer_on(_RAISE);
 205         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 206       } else {
 207         layer_off(_RAISE);
 208         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 209       }
 210       return false;
 211       break;
 212     case FUNC:
 213       if (record->event.pressed) {
 214         layer_on(_FUNC);
 215       } else {
 216         layer_off(_FUNC);
 217       }
 218       return false;
 219       break;
 220     case PLOVER:
 221       if (!record->event.pressed) {
 222         #ifdef AUDIO_ENABLE
 223           stop_all_notes();
 224           PLAY_SONG(plover_song);
 225         #endif
 226         layer_on(_PLOVER);
 227       }
 228       return false;
 229       break;
 230     case EXT_PLV:
 231       if (record->event.pressed) {
 232         #ifdef AUDIO_ENABLE
 233           PLAY_SONG(plover_gb_song);
 234         #endif
 235         layer_off(_PLOVER);
 236       }
 237       return false;
 238       break;
 239     case MOUSE:
 240       if (record->event.pressed) {
 241         layer_on(_MOUSE);
 242       } else {
 243         layer_off(_MOUSE);
 244       }
 245       return false;
 246       break;
 247   }
 248   return true;
 249 }
 250
 251 void matrix_init_user() {
 252   steno_set_mode(STENO_MODE_GEMINI);
 253 }