keyboards/planck/keymaps/experimental/keymap.c

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