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