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