keyboards/planck/keymaps/experimental/keymap.c

   1
   2 #include "planck.h"
   3 #include "action_layer.h"
   4 #include "keymap_steno.h"
   5 #ifdef AUDIO_ENABLE
   6   #include "audio.h"
   7 #endif
   8
   9 #include "eeconfig.h"
  10 #include "version.h"
  11
  12 extern keymap_config_t keymap_config;
  13
  14 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  15 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  16 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  17 // entirely and just use numbers.
  18 #define _QWERTY 10
  19 #define _COLEMAK 1
  20 #define _DVORAK 2
  21 #define _LOWER 3
  22 #define _RAISE 4
  23 #define _PLOVER 5
  24 #define _ADJUST 16
  25
  26 enum planck_keycodes {
  27   QWERTY = SAFE_RANGE,
  28   COLEMAK,
  29   DVORAK,
  30   PLOVER,
  31   LOWER,
  32   RAISE,
  33   BACKLIT,
  34   EXT_PLV,
  35   RGBLED_TOGGLE,
  36   RGBLED_STEP_MODE,
  37   RGBLED_INCREASE_HUE,
  38   RGBLED_DECREASE_HUE,
  39   RGBLED_INCREASE_SAT,
  40   RGBLED_DECREASE_SAT,
  41   RGBLED_INCREASE_VAL,
  42   RGBLED_DECREASE_VAL,
  43 };
  44
  45 // Fillers to make layering more clear
  46 #define _______ KC_TRNS
  47 #define XXXXXXX KC_NO
  48
  49 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  50 [0] = {
  51   {QWERTY, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
  52   {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
  53   {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL},
  54   {KC_NO, KC_NO, KC_NO, KC_NO, RGBLED_TOGGLE, RGBLED_STEP_MODE, RGBLED_INCREASE_HUE, RGBLED_DECREASE_HUE, RGBLED_INCREASE_SAT, RGBLED_DECREASE_SAT, RGBLED_INCREASE_VAL, RGBLED_DECREASE_VAL}
  55 },
  56
  57 /* Qwerty
  58  ,-----------------------------------------------------------------------------------.
  59  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  60  * |------+------+------+------+------+-------------+------+------+------+------+------|
  61  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  62  * |------+------+------+------+------+------|------+------+------+------+------+------|
  63  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |,  |   .  |   /  |Enter |
  64  * |------+------+------+------+------+------+------+------+------+------+------+------|
  65  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  66  * `-----------------------------------------------------------------------------------'
  67  */
  68 [_QWERTY] = {
  69   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  70   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  71   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  72   {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_FN0,  KC_FN0,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  73 },
  74
  75 /* Colemak
  76  * ,-----------------------------------------------------------------------------------.
  77  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  78  * |------+------+------+------+------+-------------+------+------+------+------+------|
  79  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  80  * |------+------+------+------+------+------|------+------+------+------+------+------|
  81  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  82  * |------+------+------+------+------+------+------+------+------+------+------+------|
  83  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  84  * `-----------------------------------------------------------------------------------'
  85  */
  86 [_COLEMAK] = {
  87   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  88   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  89   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  90   {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_FN0,  KC_FN0,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  91 },
  92
  93 /* Dvorak
  94  * ,-----------------------------------------------------------------------------------.
  95  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  96  * |------+------+------+------+------+-------------+------+------+------+------+------|
  97  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  98  * |------+------+------+------+------+------|------+------+------+------+------+------|
  99  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
 100  * |------+------+------+------+------+------+------+------+------+------+------+------|
 101  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
 102  * `-----------------------------------------------------------------------------------'
 103  */
 104 [_DVORAK] = {
 105   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
 106   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
 107   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
 108   {KC_LEAD, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_FN0,  KC_FN0,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 109 },
 110
 111 /* Lower
 112  * ,-----------------------------------------------------------------------------------.
 113  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 114  * |------+------+------+------+------+-------------+------+------+------+------+------|
 115  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 116  * |------+------+------+------+------+------|------+------+------+------+------+------|
 117  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |Enter |
 118  * |------+------+------+------+------+------+------+------+------+------+------+------|
 119  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 120  * `-----------------------------------------------------------------------------------'
 121  */
 122 [_LOWER] = {
 123   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 124   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 125   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
 126   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 127 },
 128
 129 /* Raise
 130  * ,-----------------------------------------------------------------------------------.
 131  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 132  * |------+------+------+------+------+-------------+------+------+------+------+------|
 133  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 134  * |------+------+------+------+------+------|------+------+------+------+------+------|
 135  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |Enter |
 136  * |------+------+------+------+------+------+------+------+------+------+------+------|
 137  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 138  * `-----------------------------------------------------------------------------------'
 139  */
 140 [_RAISE] = {
 141   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 142   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 143   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUHS, _______, _______, _______},
 144   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 145 },
 146
 147 /* Plover layer (http://opensteno.org)
 148  * ,-----------------------------------------------------------------------------------.
 149  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 150  * |------+------+------+------+------+-------------+------+------+------+------+------|
 151  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 152  * |------+------+------+------+------+------|------+------+------+------+------+------|
 153  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 154  * |------+------+------+------+------+------+------+------+------+------+------+------|
 155  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 156  * `-----------------------------------------------------------------------------------'
 157  */
 158
 159 [_PLOVER] = {
 160   {STN_N1,  STN_N2,  STN_N3,  STN_N4,  STN_N5,  STN_N6,  STN_N7,  STN_N8,  STN_N9,  STN_NA,  STN_NB,  STN_NC },
 161   {STN_FN,  STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1, STN_ST3, STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR },
 162   {XXXXXXX, STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2, STN_ST4, STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR },
 163   {EXT_PLV, XXXXXXX, XXXXXXX, STN_A,   STN_O,   XXXXXXX, XXXXXXX, STN_E,   STN_U,   STN_PWR, STN_RE1, STN_RE2}
 164 },
 165
 166 /* Adjust (Lower + Raise)
 167  * ,-----------------------------------------------------------------------------------.
 168  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 169  * |------+------+------+------+------+-------------+------+------+------+------+------|
 170  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 171  * |------+------+------+------+------+------|------+------+------+------+------+------|
 172  * |      |Voice-|Voice+|Mus on|Musoff|      |      |      |      |      |      |      |
 173  * |------+------+------+------+------+------+------+------+------+------+------+------|
 174  * |      |      |      |      |      |             |      |      |      |      |      |
 175  * `-----------------------------------------------------------------------------------'
 176  */
 177 [_ADJUST] = {
 178   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 179   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 180   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 181   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 182 }
 183
 184
 185 };
 186
 187 const uint16_t PROGMEM fn_actions[] = {
 188   ACTION_SWAP_HANDS_TAP_KEY(KC_SPC),
 189 };
 190
 191 #ifdef AUDIO_ENABLE
 192
 193 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 194 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 195 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 196 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 197 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 198 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 199 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 200
 201 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 202 #endif
 203
 204
 205
 206 void persistent_default_layer_set(uint16_t default_layer) {
 207   eeconfig_update_default_layer(default_layer);
 208   default_layer_set(default_layer);
 209 }
 210
 211
 212 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 213   switch (keycode) {
 214         case QWERTY:
 215           if (record->event.pressed) {
 216             #ifdef AUDIO_ENABLE
 217               PLAY_SONG(tone_qwerty);
 218             #endif
 219             persistent_default_layer_set(1UL<<_QWERTY);
 220           }
 221           break;
 222       return false;
 223         case COLEMAK:
 224           if (record->event.pressed) {
 225             #ifdef AUDIO_ENABLE
 226               PLAY_SONG(tone_colemak);
 227             #endif
 228             persistent_default_layer_set(1UL<<_COLEMAK);
 229           }
 230           break;
 231       return false;
 232         case DVORAK:
 233           if (record->event.pressed) {
 234             #ifdef AUDIO_ENABLE
 235               PLAY_SONG(tone_dvorak);
 236             #endif
 237             persistent_default_layer_set(1UL<<_DVORAK);
 238           }
 239           break;
 240       return false;
 241         case LOWER:
 242           if (record->event.pressed) {
 243             layer_on(_LOWER);
 244             #ifdef BACKLIGHT_ENABLE
 245                 breathing_period_set(2);
 246                 breathing_pulse();
 247             #endif
 248             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 249           } else {
 250             layer_off(_LOWER);
 251             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 252           }
 253           break;
 254       return false;
 255         case RAISE:
 256           if (record->event.pressed) {
 257             layer_on(_RAISE);
 258             #ifdef BACKLIGHT_ENABLE
 259                 breathing_period_set(2);
 260                 breathing_pulse();
 261             #endif
 262             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 263           } else {
 264             layer_off(_RAISE);
 265             update_tri_layer(_LOWER, _RAISE, _ADJUST);
 266           }
 267           break;
 268       return false;
 269         case BACKLIT:
 270           if (record->event.pressed) {
 271             register_code(KC_RSFT);
 272             #ifdef BACKLIGHT_ENABLE
 273               backlight_step();
 274             #endif
 275           } else {
 276             unregister_code(KC_RSFT);
 277           }
 278         break;
 279       return false;
 280         case PLOVER:
 281           if (!record->event.pressed) {
 282             #ifdef AUDIO_ENABLE
 283               stop_all_notes();
 284               PLAY_SONG(tone_plover);
 285             #endif
 286             layer_on(_PLOVER);
 287           }
 288         break;
 289       return false;
 290         case EXT_PLV:
 291           if (record->event.pressed) {
 292             #ifdef AUDIO_ENABLE
 293               PLAY_SONG(tone_plover_gb);
 294             #endif
 295             layer_off(_PLOVER);
 296           }
 297         break;
 298       return false;
 299
 300     case RGBLED_TOGGLE:
 301       //led operations
 302       if (record->event.pressed) {
 303         rgblight_toggle();
 304       }
 305       return false;
 306       break;
 307     case RGBLED_INCREASE_HUE:
 308       if (record->event.pressed) {
 309         rgblight_increase_hue();
 310       }
 311       return false;
 312       break;
 313     case RGBLED_DECREASE_HUE:
 314       if (record->event.pressed) {
 315         rgblight_decrease_hue();
 316       }
 317       return false;
 318       break;
 319     case RGBLED_INCREASE_SAT:
 320       if (record->event.pressed) {
 321         rgblight_increase_sat();
 322       }
 323       return false;
 324       break;
 325     case RGBLED_DECREASE_SAT:
 326       if (record->event.pressed) {
 327         rgblight_decrease_sat();
 328       }
 329       return false;
 330       break;
 331     case RGBLED_INCREASE_VAL:
 332       if (record->event.pressed) {
 333         rgblight_increase_val();
 334       }
 335       return false;
 336       break;
 337     case RGBLED_DECREASE_VAL:
 338       if (record->event.pressed) {
 339         rgblight_decrease_val();
 340       }
 341       return false;
 342       break;
 343     case RGBLED_STEP_MODE:
 344       if (record->event.pressed) {
 345         rgblight_step();
 346       }
 347       return false;
 348       break;
 349
 350
 351       }
 352   return true;
 353 };
 354
 355 void matrix_init_user(void) {
 356   #ifdef AUDIO_ENABLE
 357         startup_user();
 358   #endif
 359 }
 360
 361 #ifdef AUDIO_ENABLE
 362 void startup_user()
 363 {
 364     _delay_ms(20); // gets rid of tick
 365     PLAY_SONG(tone_startup);
 366 }
 367
 368 void shutdown_user()
 369 {
 370     PLAY_SONG(tone_goodbye);
 371     _delay_ms(150);
 372     stop_all_notes();
 373 }
 374
 375 void music_on_user(void)
 376 {
 377     music_scale_user();
 378 }
 379
 380 void music_scale_user(void)
 381 {
 382     PLAY_SONG(music_scale);
 383 }
 384
 385 #endif
 386
 387 LEADER_EXTERNS();
 388
 389 void matrix_scan_user(void) {
 390   LEADER_DICTIONARY() {
 391     leading = false;
 392     leader_end();
 393
 394     SEQ_ONE_KEY (KC_R) {
 395       tap_random_base64();
 396       tap_random_base64();
 397       tap_random_base64();
 398       tap_random_base64();
 399       tap_random_base64();
 400       tap_random_base64();
 401       tap_random_base64();
 402       tap_random_base64();
 403       tap_random_base64();
 404     }
 405     SEQ_ONE_KEY (KC_V) {
 406       SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
 407     }
 408     SEQ_ONE_KEY(KC_F) {
 409       SEND_STRING("if yes\n\tpeanut butter\nelse\n\trice snacks");
 410     }
 411     SEQ_TWO_KEYS(KC_A, KC_S) {
 412       register_code(KC_H);
 413       unregister_code(KC_H);
 414     }
 415     SEQ_THREE_KEYS(KC_A, KC_S, KC_D) {
 416       register_code(KC_LGUI);
 417       register_code(KC_S);
 418       unregister_code(KC_S);
 419       unregister_code(KC_LGUI);
 420     }
 421   }
 422 }