keyboards/handwired/terminus_mini/keymaps/default/keymap.c

   1 /* Copyright 2017 MogranJM
   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 #include "terminus_mini.h"
  17 #include "action_layer.h"
  18 #ifdef AUDIO_ENABLE
  19   #include "audio.h"
  20 #endif
  21 #include "eeconfig.h"
  22
  23 extern keymap_config_t keymap_config;
  24
  25 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  26 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  27 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  28 // entirely and just use numbers.
  29
  30 enum terminus_mini_layers {
  31   _COLEMAK,
  32   _LOWER,
  33   _RAISE,
  34   _FUNCTION,
  35   _MOUSE,
  36   _ADJUST
  37 };
  38
  39 enum terminus_mini_keycodes {
  40   COLEMAK = SAFE_RANGE,
  41   LOWER,
  42   RAISE,
  43   FUNCTION,
  44   MOUSE
  45 };
  46
  47   // Enable these functions using FUNC(n) macro.
  48   const uint16_t PROGMEM fn_actions[] = { //ACTION_LAYER_TAP_TOGGLE requires that number of taps be defined in *config.h* - default set to 5
  49       [0] = ACTION_LAYER_TAP_KEY(_LOWER, KC_SPC),    //Hold for momentary Lower layer, Tap for Space,
  50       [1] = ACTION_LAYER_TAP_KEY(_RAISE, KC_ENT),    //Hold for momentary Mouse layer, Tap for Enter,
  51       [2] = ACTION_LAYER_TAP_TOGGLE(_LOWER),         //Hold for momentary Lower, Tap for toggle Lower
  52       [3] = ACTION_LAYER_TAP_TOGGLE(_MOUSE),         //Hold for momentary Mouse, Tap for toggle Mouse
  53       [4] = ACTION_LAYER_MOMENTARY(_FUNCTION),       //Hold for momentary Function
  54    };
  55 #define SPC_LW FUNC(0)
  56 #define ENT_RS FUNC(1)
  57 #define LWR FUNC(2)
  58 #define MSE FUNC(3)
  59 #define FNC FUNC(4)
  60
  61 // Fillers to make layering more clear
  62 #define _______ KC_TRNS
  63 #define XXXXXXX KC_NO
  64
  65
  66 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  67 /* Colemak -
  68  * ,----------------------------------------------------------------------------------.
  69  * | Tab |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  |  Del |
  70  * |-----+------+------+------+------+-------------+------+------+------+------+------|
  71  * | BS  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  72  * |-----+------+------+------+------+-------------+------+------+------+------+------|
  73  * | LSPO|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  | RSPC |
  74  * |-----+------+------+------+------+------+------+------+------+------+------+------|
  75  * | Ctrl| LGUI | LAlt | Lower|    SpaceLW  |    RSEnter  |  Fn  | Mouse| Menu | Ctrl |
  76  * `----------------------------------------------------------------------------------'
  77  */
  78 [_COLEMAK] = TERMINUS_MINI(
  79   KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,      KC_Y,    KC_SCLN, KC_DEL , \
  80   KC_BSPC, KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,      KC_I,    KC_O,    KC_QUOT, \
  81   KC_LSPO, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM,   KC_DOT,  KC_SLSH, KC_RSPC, \
  82   KC_LCTL, KC_LGUI, KC_LALT, LWR,          SPC_LW,           ENT_RS,      FNC,       MSE,     KC_APP,  KC_RCTL \
  83   ),
  84
  85 /* Lower
  86  * ,-----------------------------------------------------------------------------------.
  87  * |  Tab | PgUp | Home |  Up  |  End |   /  |   7  |   8  |   9  |  *   |      |  Del |
  88  * |------+------+------+------+------+------+------+------+------+------+------+------|
  89  * |  BS  | PgDn | Left | Down |Right |   -  |   4  |   5  |   6  |  +   |      |      |
  90  * |------+------+------+------+------+------+------+------+------+------+------+------|
  91  * | LSPO |   Z  |   X  |   C  |   V  |   =  |   1  |   2  |   3  | Enter|      | RSPC |
  92  * |------+------+------+------+------+------+------+------+------+------+------+------|
  93  * | Ctrl | LGUI | Alt  | Lower| Space/Lower |      0      |   .  |  Fn  | Menu | Ctrl |
  94  * `-----------------------------------------------------------------------------------'
  95  Want to add tap-dance function to 0 key: Tap=0, doubleTap=Ent
  96  */
  97
  98 [_LOWER] = TERMINUS_MINI(
  99   KC_TAB,  KC_PGUP,  KC_HOME,  KC_UP,    KC_END,   KC_PSLS,  KC_7,  KC_8,  KC_9,   KC_PAST,  XXXXXXX, _______, \
 100   _______, KC_PGDN,  KC_LEFT,  KC_DOWN,  KC_RGHT,  KC_MINS,  KC_4,  KC_5,  KC_6,   KC_PPLS,  XXXXXXX, _______, \
 101   _______, _______,  _______,  _______,  _______,  KC_EQL,   KC_1,  KC_2,  KC_3,   KC_PENT,  XXXXXXX, _______, \
 102   _______, _______,  _______,  _______,       _______,       KC_0,       KC_DOT,   FNC,      _______, _______ \
 103 ),
 104
 105 /* Raise
 106  * ,-----------------------------------------------------------------------------------.
 107  * |  Esc |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   -  |   +  |  Del |
 108  * |------+------+------+------+------+------+------+------+------+------+------+------|
 109  * |  BS  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |   "  |
 110  * |------+------+------+------+------+------+------+------+------+------+------+------|
 111  * | LSPO |      |      |   {  |   [  |   `  |   \  |   ]  |   }  |   .  |   ?  | RSPC |
 112  * |------+------+------+------+------+------+------+------+------+------+------+------|
 113  * | Ctrl | LGUI | Alt  |      | Space/Lower | Raise/Enter |  Fn  | Mouse| Menu | Ctrl |
 114  * `-----------------------------------------------------------------------------------'
 115   */
 116
 117 [_RAISE] = TERMINUS_MINI(
 118    KC_ESC,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,   KC_PERC, KC_CIRC,  KC_AMPR, KC_ASTR, KC_MINS, KC_EQL,  _______, \
 119    _______, KC_1,    KC_2,    KC_3,    KC_4,     KC_5,    KC_6,     KC_7,    KC_8,    KC_9,    KC_0,    _______, \
 120    _______, XXXXXXX, XXXXXXX, KC_LCBR, KC_LBRC,  KC_GRV,  KC_BSLS,  KC_RBRC, KC_RCBR, KC_DOT,  KC_SLSH, _______, \
 121    _______, _______, _______, _______,        SPC_LW,            ENT_RS,     FNC,     MSE,     _______, _______ \
 122    ),
 123
 124 /*Function
 125  * ,-----------------------------------------------------------------------------------.
 126  * | Esc  | Mute | Vol- | Vol+ |      | RESET| POWER|  F1  |  F2  |  F3  |  F4  | Ins  |
 127  * |------+------+------+------+------+------+------+------+------+------+------+------|
 128  * | Caps | Stop | |<<  | >/|| |  >>| |      |      |  F5  |  F6  |  F7  |  F8  |PrtSc |
 129  * |------+------+------+------+------+------+------+------+------+------+------+------|
 130  * | LSOB |      |      |      |      |      |      |  F9  | F10  | F11  | F12  |ScrLk |
 131  * |------+------+------+------+------+------+------+------+------+------+------+------|
 132  * | Ctrl | LGUI | Alt  |      | Space/Lower | Enter/Raise |  Fn  |      |      |PsBrk |
 133  * `-----------------------------------------------------------------------------------'
 134  */
 135
 136 [_FUNCTION] = TERMINUS_MINI(
 137   _______, KC_MUTE, KC_VOLD, KC_VOLU,  XXXXXXX,   RESET,  KC_PWR,  KC_F1,  KC_F2,   KC_F3,   KC_F4, KC_INS , \
 138   KC_CAPS, KC_MSTP, KC_MPRV, KC_MPLY,  KC_MNXT, XXXXXXX, XXXXXXX,  KC_F5,  KC_F6,   KC_F7,   KC_F8, KC_PSCR, \
 139   _______, XXXXXXX, XXXXXXX, XXXXXXX,  XXXXXXX, XXXXXXX, XXXXXXX,  KC_F9,  KC_F10, KC_F11,  KC_F12, KC_SLCK, \
 140   _______, _______, _______, _______,         _______,        _______,     FNC,   _______, _______, KC_PAUS \
 141   ),
 142
 143 /* MOUSE
 144  * ,---------------------------------------------------------------------------------------.
 145  * |  Esc | WhlU  | WhlL  | MsUp | WhlR |      |      |   M1  |   M2  |  M3  |      |      |
 146  * |------+-------+------+-------+------+------+------+-------+-------+------+------+------|
 147  * |      | WhlD  | MsL   | MsDn | MsR  |      |      |LClick |RClick |      |      |      |
 148  * |------+-------+------+-------+------+------+------+-------+-------+------+------+------|
 149  * | LSPO |       |      |       |      |      |      |       |       |      |      | RSCB |
 150  * |------+-------+------+-------+------+------+------+-------+-------+------+------+------|
 151  * | Ctrl |       |      |       | Sensitivity |  Sensitivity |       |MOUSE |      | Ctrl |
 152  * `---------------------------------------------------------------------------------------'
 153  */
 154
 155 [_MOUSE] = TERMINUS_MINI(
 156    KC_ESC,  KC_WH_U, KC_WH_L, KC_MS_U, KC_WH_R,  XXXXXXX, XXXXXXX, KC_BTN3, KC_BTN4,  KC_BTN5, XXXXXXX, XXXXXXX, \
 157    KC_BSPC, KC_WH_D, KC_MS_L, KC_MS_D, KC_MS_R,  XXXXXXX, XXXXXXX, KC_BTN1, KC_BTN2,  XXXXXXX, XXXXXXX, XXXXXXX, \
 158    _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,  XXXXXXX, XXXXXXX, KC_RSPC, \
 159    _______, XXXXXXX, XXXXXXX, XXXXXXX,      KC_ACL2,           KC_ACL0,     XXXXXXX,      MSE, XXXXXXX, KC_RCTL \
 160   ),
 161
 162 };
 163
 164 void persistant_default_layer_set(uint16_t default_layer) {
 165   eeconfig_update_default_layer(default_layer);
 166   default_layer_set(default_layer);
 167 }
 168
 169 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 170   switch (keycode) {
 171     case COLEMAK:
 172       if (record->event.pressed) {
 173         #ifdef AUDIO_ENABLE
 174           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 175         #endif
 176         persistant_default_layer_set(1UL<<_COLEMAK);
 177       }
 178       return false;
 179       break;
 180     case LOWER:
 181       if (record->event.pressed) {
 182         layer_on(_LOWER);
 183         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 184       } else {
 185         layer_off(_LOWER);
 186         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 187       }
 188       return false;
 189       break;
 190     case RAISE:
 191       if (record->event.pressed) {
 192         layer_on(_RAISE);
 193         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 194       } else {
 195         layer_off(_RAISE);
 196         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 197       }
 198       return false;
 199       break;
 200   }
 201   return true;
 202 }
 203
 204
 205 void matrix_init_user(void) {
 206
 207 }
 208
 209 void matrix_scan_user(void) {
 210
 211 }
 212
 213 void led_set_user(uint8_t usb_led) {
 214
 215 }