keyboards/planck/keymaps/mgalisa/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 QMK_KEYBOARD_H
  18 #include "muse.h"
  19
  20 extern keymap_config_t keymap_config;
  21
  22 enum planck_layers {
  23   _QWERTY,
  24   _COLEMAK,
  25   _DVORAK,
  26   _LOWER,
  27   _RAISE,
  28   _PLOVER,
  29   _EMOJI,
  30   _ADJUST
  31 };
  32
  33 enum planck_keycodes {
  34   QWERTY = SAFE_RANGE,
  35   COLEMAK,
  36   DVORAK,
  37   PLOVER,
  38   BACKLIT,
  39   EXT_PLV,
  40   AUTO_SQ,
  41   AUTO_PA,
  42   AUTO_CB,
  43   SHRUG,
  44   F4R
  45 };
  46
  47 #define LOWER MO(_LOWER)
  48 #define RAISE MO(_RAISE)
  49
  50 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  51
  52 /* Qwerty
  53  * ,-----------------------------------------------------------------------------------.
  54  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  55  * |------+------+------+------+------+-------------+------+------+------+------+------|
  56  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  57  * |------+------+------+------+------+------|------+------+------+------+------+------|
  58  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  59  * |------+------+------+------+------+------+------+------+------+------+------+------|
  60  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  61  * `-----------------------------------------------------------------------------------'
  62  */
  63 [_QWERTY] = LAYOUT_planck_grid(
  64     KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
  65     LT(_EMOJI,KC_ESC),  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
  66     KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT ,
  67     BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
  68 ),
  69
  70 /* Colemak
  71  * ,-----------------------------------------------------------------------------------.
  72  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  73  * |------+------+------+------+------+-------------+------+------+------+------+------|
  74  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  75  * |------+------+------+------+------+------|------+------+------+------+------+------|
  76  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  77  * |------+------+------+------+------+------+------+------+------+------+------+------|
  78  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  79  * `-----------------------------------------------------------------------------------'
  80  */
  81 [_COLEMAK] = LAYOUT_planck_grid(
  82     KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC,
  83     LT(_EMOJI,KC_ESC),  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT,
  84     KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT ,
  85     BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
  86 ),
  87
  88 /* Dvorak
  89  * ,-----------------------------------------------------------------------------------.
  90  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  91  * |------+------+------+------+------+-------------+------+------+------+------+------|
  92  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  93  * |------+------+------+------+------+------|------+------+------+------+------+------|
  94  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  95  * |------+------+------+------+------+------+------+------+------+------+------+------|
  96  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  97  * `-----------------------------------------------------------------------------------'
  98  */
  99 [_DVORAK] = LAYOUT_planck_grid(
 100     KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC,
 101     LT(_EMOJI,KC_ESC),  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH,
 102     KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT ,
 103     BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
 104 ),
 105
 106 /* Lower
 107  * ,-----------------------------------------------------------------------------------.
 108  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 109  * |------+------+------+------+------+-------------+------+------+------+------+------|
 110  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 111  * |------+------+------+------+------+------|------+------+------+------+------+------|
 112  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
 113  * |------+------+------+------+------+------+------+------+------+------+------+------|
 114  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 115  * `-----------------------------------------------------------------------------------'
 116  */
 117 [_LOWER] = LAYOUT_planck_grid(
 118     KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_BSPC,
 119     KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE,
 120     _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END,  _______,
 121     _______, _______, _______, _______, _______, _______, _______, _______,    KC_MNXT,    KC_VOLD, KC_VOLU, KC_MPLY
 122 ),
 123
 124 /* Raise
 125  * ,-----------------------------------------------------------------------------------.
 126  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 127  * |------+------+------+------+------+-------------+------+------+------+------+------|
 128  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 129  * |------+------+------+------+------+------|------+------+------+------+------+------|
 130  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
 131  * |------+------+------+------+------+------+------+------+------+------+------+------|
 132  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 133  * `-----------------------------------------------------------------------------------'
 134  */
 135 /* [_RAISE] = LAYOUT_planck_grid(
 136     KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC,
 137     KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS,
 138     _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______,
 139     _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
 140 ), */
 141
 142 /* Raise - new
 143  * ,-----------------------------------------------------------------------------------.
 144  * |   `  |  F1  |  F2  |  F3  |  F4  |  {}  |   7  |   8  |   9  |   -  |   *  | Bksp |
 145  * |------+------+------+------+------+-------------+------+------+------+------+------|
 146  * | Del  |  F5  |  F6  |  F7  |  F8  |  ()  |   4  |   5  |   6  |   +  |   /  |      |
 147  * |------+------+------+------+------+------|------+------+------+------+------+------|
 148  * |      |  F9  |  F10 |  F11 |  F12 |  []  |   1  |   2  |   3  |Vol - |Vol + |      |
 149  * |------+------+------+------+------+------+------+------+------+------+------+------|
 150  * |      |      |      |      |      |      0      |      | Home |Pg Dn |Pg Up | End  |
 151  * `-----------------------------------------------------------------------------------'
 152  */
 153 [_RAISE] = LAYOUT_planck_grid(
 154     KC_GRV,  KC_F1,   KC_F2,    KC_F3,    KC_F4,   AUTO_CB,  KC_7,  KC_8, KC_9,  KC_MINS, KC_ASTR, KC_BSPC,
 155     KC_DEL,  KC_F5,   KC_F6,    KC_F7,    KC_F8,   AUTO_PA,  KC_4,  KC_5, KC_6,  KC_PLUS, KC_SLSH, KC_BSLS,
 156     _______, KC_F9,   KC_F10,   KC_F11,   KC_F12,  AUTO_SQ,  KC_1,  KC_2, KC_3,  KC_PGUP, KC_VOLU, _______,
 157     _______, _______, _______, _______, _______, KC_0, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END
 158 ),
 159
 160 /* Plover layer (http://opensteno.org)
 161  * ,-----------------------------------------------------------------------------------.
 162  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 163  * |------+------+------+------+------+-------------+------+------+------+------+------|
 164  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 165  * |------+------+------+------+------+------|------+------+------+------+------+------|
 166  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 167  * |------+------+------+------+------+------+------+------+------+------+------+------|
 168  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 169  * `-----------------------------------------------------------------------------------'
 170  */
 171 [_PLOVER] = LAYOUT_planck_grid(
 172     KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   ,
 173     XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC,
 174     XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
 175     EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX
 176 ),
 177
 178 [_EMOJI] = LAYOUT_planck_grid(
 179     _______, _______, _______, F4R, _______, _______, _______, _______, _______,  _______, _______, _______,
 180     KC_TRNS, _______, _______, SHRUG, _______, _______, _______, _______, _______,  _______, _______, _______,
 181     _______, _______, _______, _______, _______, _______, _______, _______, _______,  _______, _______, _______,
 182     _______, _______, _______, _______, _______, _______, _______, _______, _______,  _______, _______, _______
 183 ),
 184
 185 /* Adjust (Lower + Raise)
 186  * ,-----------------------------------------------------------------------------------.
 187  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 188  * |------+------+------+------+------+-------------+------+------+------+------+------|
 189  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 190  * |------+------+------+------+------+------|------+------+------+------+------+------|
 191  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 192  * |------+------+------+------+------+------+------+------+------+------+------+------|
 193  * |      |      |      |      |      |             |      |      |      |      |      |
 194  * `-----------------------------------------------------------------------------------'
 195  */
 196 [_ADJUST] = LAYOUT_planck_grid(
 197     _______, RESET,   DEBUG,   RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD,  RGB_VAI, RGB_VAD, KC_DEL ,
 198     _______, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK,  DVORAK,  PLOVER,  _______,
 199     _______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  TERM_ON, TERM_OFF, _______, _______, _______,
 200     _______, _______, _______, _______, _______, _______, _______, _______, _______,  _______, _______, _______
 201 )
 202
 203 };
 204
 205 #ifdef AUDIO_ENABLE
 206   float plover_song[][2]     = SONG(PLOVER_SOUND);
 207   float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 208 #endif
 209
 210 uint32_t layer_state_set_user(uint32_t state) {
 211   return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 212 }
 213
 214 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 215   switch (keycode) {
 216     case QWERTY:
 217       if (record->event.pressed) {
 218         print("mode just switched to qwerty and this is a huge string\n");
 219         set_single_persistent_default_layer(_QWERTY);
 220       }
 221       return false;
 222       break;
 223     case COLEMAK:
 224       if (record->event.pressed) {
 225         set_single_persistent_default_layer(_COLEMAK);
 226       }
 227       return false;
 228       break;
 229     case DVORAK:
 230       if (record->event.pressed) {
 231         set_single_persistent_default_layer(_DVORAK);
 232       }
 233       return false;
 234       break;
 235     case BACKLIT:
 236       if (record->event.pressed) {
 237         register_code(KC_RSFT);
 238         #ifdef BACKLIGHT_ENABLE
 239           backlight_step();
 240         #endif
 241         #ifdef KEYBOARD_planck_rev5
 242           PORTE &= ~(1<<6);
 243         #endif
 244       } else {
 245         unregister_code(KC_RSFT);
 246         #ifdef KEYBOARD_planck_rev5
 247           PORTE |= (1<<6);
 248         #endif
 249       }
 250       return false;
 251       break;
 252     case PLOVER:
 253       if (record->event.pressed) {
 254         #ifdef AUDIO_ENABLE
 255           stop_all_notes();
 256           PLAY_SONG(plover_song);
 257         #endif
 258         layer_off(_RAISE);
 259         layer_off(_LOWER);
 260         layer_off(_ADJUST);
 261         layer_on(_PLOVER);
 262         if (!eeconfig_is_enabled()) {
 263             eeconfig_init();
 264         }
 265         keymap_config.raw = eeconfig_read_keymap();
 266         keymap_config.nkro = 1;
 267         eeconfig_update_keymap(keymap_config.raw);
 268       }
 269       return false;
 270       break;
 271     case EXT_PLV:
 272       if (record->event.pressed) {
 273         #ifdef AUDIO_ENABLE
 274           PLAY_SONG(plover_gb_song);
 275         #endif
 276         layer_off(_PLOVER);
 277       }
 278       return false;
 279       break;
 280     case AUTO_SQ:
 281       if (record->event.pressed) {
 282         SEND_STRING("[]SS_TAP(X_LEFT)");
 283       }
 284       return false;
 285       break;
 286     case AUTO_CB:
 287       if (record->event.pressed) {
 288         SEND_STRING("{}SS_TAP(X_LEFT)");
 289       }
 290       return false;
 291       break;
 292     case AUTO_PA:
 293       if (record->event.pressed) {
 294         SEND_STRING("()SS_TAP(X_LEFT)");
 295       }
 296       return false;
 297       break;
 298     case SHRUG:
 299       if (record->event.pressed) {
 300         SEND_STRING("/shrugSS_TAP(X_ENT)");
 301       }
 302       return false;
 303       break;
 304     case F4R:
 305       if (record->event.pressed) {
 306         SEND_STRING(":f-for-respects:");
 307       }
 308       return false;
 309       break;
 310   }
 311   return true;
 312 }
 313
 314 bool muse_mode = false;
 315 uint8_t last_muse_note = 0;
 316 uint16_t muse_counter = 0;
 317 uint8_t muse_offset = 70;
 318 uint16_t muse_tempo = 50;
 319
 320 void encoder_update(bool clockwise) {
 321   if (muse_mode) {
 322     if (IS_LAYER_ON(_RAISE)) {
 323       if (clockwise) {
 324         muse_offset++;
 325       } else {
 326         muse_offset--;
 327       }
 328     } else {
 329       if (clockwise) {
 330         muse_tempo+=1;
 331       } else {
 332         muse_tempo-=1;
 333       }
 334     }
 335   } else {
 336     if (clockwise) {
 337       #ifdef MOUSEKEY_ENABLE
 338         tap_code(KC_MS_WH_DOWN);
 339       #else
 340         tap_code(KC_PGDN);
 341       #endif
 342     } else {
 343       #ifdef MOUSEKEY_ENABLE
 344         tap_code(KC_MS_WH_UP);
 345       #else
 346         tap_code(KC_PGUP);
 347       #endif
 348     }
 349   }
 350 }
 351
 352 void dip_update(uint8_t index, bool active) {
 353   switch (index) {
 354     case 0:
 355       if (active) {
 356         #ifdef AUDIO_ENABLE
 357           PLAY_SONG(plover_song);
 358         #endif
 359         layer_on(_ADJUST);
 360       } else {
 361         #ifdef AUDIO_ENABLE
 362           PLAY_SONG(plover_gb_song);
 363         #endif
 364         layer_off(_ADJUST);
 365       }
 366       break;
 367     case 1:
 368       if (active) {
 369         muse_mode = true;
 370       } else {
 371         muse_mode = false;
 372         #ifdef AUDIO_ENABLE
 373           stop_all_notes();
 374         #endif
 375       }
 376    }
 377 }
 378
 379 void matrix_scan_user(void) {
 380   #ifdef AUDIO_ENABLE
 381     if (muse_mode) {
 382       if (muse_counter == 0) {
 383         uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()];
 384         if (muse_note != last_muse_note) {
 385           stop_note(compute_freq_for_midi_note(last_muse_note));
 386           play_note(compute_freq_for_midi_note(muse_note), 0xF);
 387           last_muse_note = muse_note;
 388         }
 389       }
 390       muse_counter = (muse_counter + 1) % muse_tempo;
 391     }
 392   #endif
 393 }
 394
 395 bool music_mask_user(uint16_t keycode) {
 396   switch (keycode) {
 397     case RAISE:
 398     case LOWER:
 399       return false;
 400     default:
 401       return true;
 402   }
 403 }