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