keyboards/planck/keymaps/juno/keymap.c

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