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