keyboards/meira/keymaps/grahampheath/keymap.c

   1 /* Copyright 2017 Cole Markham
   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 "meira.h"
  17 #include "action_layer.h"
  18 #include "action_code.h"
  19
  20 #ifdef RGBLIGHT_ENABLE
  21 //Following line allows macro to read current RGB settings
  22 extern rgblight_config_t rgblight_config;
  23 #endif
  24
  25 #define _QWERTY 0
  26 #define _COLEMAK 1
  27 #define _DVORAK 2
  28 #define _LOWER 3
  29 #define _RAISE 4
  30 #define _EMOJI 5
  31 #define _ADJUST 16
  32
  33 enum custom_keycodes {
  34   QWERTY = SAFE_RANGE,
  35   COLEMAK,
  36   DVORAK,
  37   LOWER,
  38   RAISE,
  39   EMOJI,
  40   ADJUST,
  41   TOUNGE,
  42   JOY,
  43   FROWN,
  44   HEART,
  45   THMBUP,
  46   THMBDN,
  47   SHRUG,
  48   WINK,
  49   GRIN,
  50   LLAP,
  51   CRY,
  52   SHIT,
  53   FLIP,
  54   FNGLEFT,
  55   ABOVE,
  56   FNGRIGHT,
  57   CONFUSED
  58 };
  59
  60 // define variables for reactive RGB
  61 bool TOG_STATUS = false;
  62 int RGB_current_mode;
  63
  64 #define KC_X0 MT(MOD_LCTL, KC_ESC)  // Hold for Left Ctrl, Tap for GraveESC
  65 #define KC_X1 MT(MOD_RSFT, KC_ENT)  // Hold for Right Shift, Tap for Enter
  66 #define KC_X2 MT(MOD_RSFT, LGUI(KC_ENT))  // Send Command Enter
  67 #define KC_X3 MT(MOD_LGUI, KC_SPC)  // Hold for Left GUI, Tap for Space
  68 #define KC_EMOJ TT(_EMOJI)  // Hold for Emoji Layer, or tap 5 times.
  69 #define KC_QS LGUI(KC_SPC)  // Send Command + Space (for QuickSilver).
  70 #define KC_TABR LGUI(KC_RCBR)  // Send Command + } (for tab changing).
  71 #define KC_TABL LGUI(KC_LCBR)  // Send Command + { (for tab changing).
  72 #define HYPR_0 HYPR(KC_TILD)  // Send Hyper + ~.
  73 #define HYPR_1 HYPR(KC_EXLM)  // Send Hyper + !.
  74 #define HYPR_2 HYPR(KC_AT)  // Send Hyper + @.
  75
  76 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  77   /* Qwerty
  78    * ,-----------------------------------------------------------------------------------.
  79    * | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  80    * |------+------+------+------+------+-------------+------+------+------+------+------|
  81    * | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  '   |
  82    * |------+------+------+------+------+------|------+------+------+------+------+------|
  83    * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  84    * |------+------+------+------+------+------+------+------+------+------+------+------|
  85    * |Emoji | Ctrl | Alt  |Lower | Cmd  |Space+|Space |Raise | Left | Down |  Up  |Right |
  86    * `-----------------------------------------------------------------------------------'
  87    */
  88   [_QWERTY] = KEYMAP( \
  89     KC_TAB,  KC_Q,     KC_W,    KC_E,    KC_R,   KC_T,     KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC, \
  90     KC_X0,   KC_A,     KC_S,    KC_D,    KC_F,   KC_G,     KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, \
  91     KC_LSFT, KC_Z,     KC_X,    KC_C,    KC_V,   KC_B,     KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,  KC_X1, \
  92     KC_EMOJ, KC_LCTL,  KC_LALT, KC_LGUI, LOWER,  KC_X3,    KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
  93   ),
  94
  95   /* Colemak
  96    * ,-----------------------------------------------------------------------------------.
  97    * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  98    * |------+------+------+------+------+-------------+------+------+------+------+------|
  99    * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
 100    * |------+------+------+------+------+------|------+------+------+------+------+------|
 101    * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
 102    * |------+------+------+------+------+------+------+------+------+------+------+------|
 103    * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
 104    * `-----------------------------------------------------------------------------------'
 105    */
 106   [_COLEMAK] = KEYMAP( \
 107     KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC, \
 108     KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT, \
 109     KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT , \
 110     ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
 111   ),
 112
 113   /* Dvorak
 114    * ,-----------------------------------------------------------------------------------.
 115    * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
 116    * |------+------+------+------+------+-------------+------+------+------+------+------|
 117    * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
 118    * |------+------+------+------+------+------|------+------+------+------+------+------|
 119    * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 120    * |------+------+------+------+------+------+------+------+------+------+------+------|
 121    * |Adjust| Ctrl | Alt  | GUI  |Lower |Space |Space |Raise | Left | Down |  Up  |Right |
 122    * `-----------------------------------------------------------------------------------'
 123    */
 124   [_DVORAK] = KEYMAP( \
 125     KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC, \
 126     KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH, \
 127     KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT , \
 128     ADJUST,  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT \
 129   ),
 130
 131   /* Emoji Layer
 132    *
 133    * ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
 134    * │HYPR0│     │ ;-) │     │     │ :-P │     │     │:'-( │FLIP │     │     │
 135    * ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 136    * │HYPR1│  👆 │SHRUG│     │ :-( │     │ <3  │ :-) │     │LLAP │     │     │
 137    * ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
 138    * │HYPR2│     │     │     | :-\ │     │     │ :-D │ SHIT│     │     │     │
 139    * ├─────┼─────┼─────┼─────┼─────┼─────┴─────┼─────┼─────┼─────┼─────┼─────┤
 140    * │     │     │     │     │Brig-│   Sleep   │Brig+│ 👈  │ 👎  |  👍 │ 👉 │
 141    * └─────┴─────┴─────┴─────┴─────┴───────────┴─────┴─────┴─────┴─────┴─────┘
 142    */
 143   [_EMOJI] = KEYMAP ( \
 144     HYPR_0,  _______, WINK,    _______, _______,  TOUNGE,  _______, _______, CRY,     FLIP,    _______, _______, \
 145     HYPR_1,  ABOVE,   SHRUG,   _______, FROWN,    _______, HEART,   JOY,     _______, LLAP,    _______, _______, \
 146     HYPR_2,  _______, _______, _______, CONFUSED, _______, _______, GRIN,    SHIT,    _______, _______, _______, \
 147     _______, _______, _______, _______, KC_SLCK,  KC_SLEP, KC_SLEP, KC_PAUS, FNGLEFT, THMBDN,  THMBUP,  FNGRIGHT \
 148   ),
 149
 150
 151
 152   /* Lower
 153    * ,-----------------------------------------------------------------------------------.
 154    * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 155    * |------+------+------+------+------+-------------+------+------+------+------+------|
 156    * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 157    * |------+------+------+------+------+------|------+------+------+------+------+------|
 158    * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |Enter |
 159    * |------+------+------+------+------+------+------+------+------+------+------+------|
 160    * |      |      |      |      |      |             |      | Tab- |      |      | Tab+ |
 161    * `-----------------------------------------------------------------------------------'
 162    */
 163   [_LOWER] = KEYMAP( \
 164     KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC, \
 165     KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, \
 166     KC_LSFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______, \
 167     _______, _______, _______, _______, _______, KC_QS,   KC_QS, _______, KC_TABL, _______,  _______, KC_TABR \
 168   ),
 169
 170   /* Raise
 171    * ,-----------------------------------------------------------------------------------.
 172    * |      |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 173    * |------+------+------+------+------+-------------+------+------+------+------+------|
 174    * |   `  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 175    * |------+------+------+------+------+------|------+------+------+------+------+------|
 176    * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |Enter |
 177    * |------+------+------+------+------+------+------+------+------+------+------+------|
 178    * |      |      |      |      |      |             |      | Home | PgUp | PgDn | End  |
 179    * `-----------------------------------------------------------------------------------'
 180    */
 181   [_RAISE] = KEYMAP( \
 182     KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
 183     KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS, \
 184     KC_LSFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, _______, _______, KC_X2, \
 185     _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END \
 186   ),
 187
 188   /* Adjust (Lower + Raise)
 189    * ,-----------------------------------------------------------------------------------.
 190    * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 191    * |------+------+------+------+------+-------------+------+------+------+------+------|
 192    * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|      |      |
 193    * |------+------+------+------+------+------|------+------+------+------+------+------|
 194    * |      |      |      |      |      |      |      |      |      |      |      |      |
 195    * |------+------+------+------+------+------+------+------+------+------+------+------|
 196    * |      |      |      |      |      |             |      |      |      |      |      |
 197    * `-----------------------------------------------------------------------------------'
 198    */
 199   [_ADJUST] =  KEYMAP( \
 200     _______, RESET,   _______, _______, _______, _______, KC_PSCR, _______, _______, _______, _______, KC_DEL, \
 201     _______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  _______, _______, \
 202     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
 203     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \
 204   )
 205 };
 206
 207 const uint16_t PROGMEM fn_actions[] = {
 208
 209 };
 210
 211 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 212 {
 213   // MACRODOWN only works in this function
 214       switch(id) {
 215         case 0:
 216           if (record->event.pressed) {
 217             register_code(KC_RSFT);
 218           } else {
 219             unregister_code(KC_RSFT);
 220           }
 221         break;
 222       }
 223     return MACRO_NONE;
 224 };
 225
 226 #ifdef AUDIO_ENABLE
 227
 228   float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 229   float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 230   float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 231
 232
 233   float plover_song[][2]     = SONG(PLOVER_SOUND);
 234   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 235 #endif
 236
 237 void matrix_init_user(void) {
 238
 239 }
 240
 241 void matrix_scan_user(void) {
 242
 243 }
 244
 245 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 246   switch (keycode) {
 247     case QWERTY:
 248       if (record->event.pressed) {
 249         #ifdef AUDIO_ENABLE
 250           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 251         #endif
 252       }
 253       return false;
 254       break;
 255     case COLEMAK:
 256       if (record->event.pressed) {
 257         #ifdef AUDIO_ENABLE
 258           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 259         #endif
 260       }
 261       return false;
 262       break;
 263     case DVORAK:
 264       if (record->event.pressed) {
 265         #ifdef AUDIO_ENABLE
 266           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 267         #endif
 268       }
 269       return false;
 270       break;
 271     case LOWER:
 272         if (record->event.pressed) {
 273             layer_on(_LOWER);
 274             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 275         } else {
 276             layer_off(_LOWER);
 277             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 278         }
 279         return false;
 280         break;
 281     case RAISE:
 282         if (record->event.pressed) {
 283             layer_on(_RAISE);
 284             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 285         } else {
 286             layer_off(_RAISE);
 287             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 288         }
 289         return false;
 290         break;
 291     case ADJUST:
 292         // FIXME add RGB feedback
 293         if (record->event.pressed) {
 294             layer_on(_ADJUST);
 295         } else {
 296             layer_off(_ADJUST);
 297         }
 298         return false;
 299         break;
 300     case BL_TOGG:
 301 #ifdef ISSI_ENABLE
 302         if (record->event.pressed) {
 303             print("Enabling backlight\n");
 304             issi_init();
 305         }
 306 #endif
 307         return false;
 308         break;
 309     case BL_STEP:
 310         if (record->event.pressed) {
 311             print("Stepping backlight\n");
 312
 313         }
 314         return false;
 315         break;
 316     case FLIP:
 317       if (record->event.pressed) {
 318         SEND_STRING("&fliptable;");
 319       }
 320       return false;
 321       break;
 322     case CONFUSED:
 323       if (record->event.pressed) {
 324         SEND_STRING(":-\\");
 325       }
 326       // register_codeturn false;
 327       break;
 328     case SHIT:
 329       if (record->event.pressed) {
 330         SEND_STRING("&shit; ");
 331       }
 332       return false;
 333       break;
 334     case CRY:
 335       if (record->event.pressed) {
 336         SEND_STRING(":'-( ");
 337       }
 338       return false;
 339       break;
 340     case LLAP:
 341       if (record->event.pressed) {
 342         SEND_STRING("&llap; ");
 343       }
 344       return false;
 345       break;
 346     case GRIN:
 347       if (record->event.pressed) {
 348         SEND_STRING(":-D ");
 349       }
 350       return false;
 351       break;
 352     case TOUNGE:
 353       if (record->event.pressed) {
 354         SEND_STRING(":-P ");
 355       }
 356       return false;
 357       break;
 358     case JOY:
 359       if (record->event.pressed) {
 360         SEND_STRING(":-) ");
 361       }
 362       return false;
 363       break;
 364     case FROWN:
 365       if (record->event.pressed) {
 366         SEND_STRING(":-( ");
 367       }
 368       return false;
 369       break;
 370     case HEART:
 371       if (record->event.pressed) {
 372         SEND_STRING("<3 ");
 373       }
 374       return false;
 375       break;
 376     case SHRUG:
 377       if (record->event.pressed) {
 378         SEND_STRING("&shrug; ");
 379       }
 380       return false;
 381       break;
 382     case THMBUP:
 383       if (record->event.pressed) {
 384         SEND_STRING("&thumbup; ");
 385       }
 386       return false;
 387       break;
 388     case THMBDN:
 389       if (record->event.pressed) {
 390         SEND_STRING("&thumbdown; ");
 391       }
 392       return false;
 393       break;
 394     case FNGLEFT:
 395       if (record->event.pressed) {
 396         SEND_STRING("&fingerleft; ");
 397       }
 398       return false;
 399       break;
 400     case FNGRIGHT:
 401       if (record->event.pressed) {
 402         SEND_STRING("&fingerright; ");
 403       }
 404       return false;
 405       break;
 406     case WINK:
 407       if (record->event.pressed) {
 408         SEND_STRING(";-) ");
 409       }
 410       return false;
 411       break;
 412     case ABOVE:
 413       if (record->event.pressed) {
 414         SEND_STRING("&above; ");
 415       }
 416       return false;
 417       break;
 418
 419   }
 420   return true;
 421 }
 422
 423 void led_set_user(uint8_t usb_led) {
 424
 425 }