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