keyboards/planck/keymaps/chance/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 #ifdef AUDIO_ENABLE
   6   #include "audio.h"
   7 #endif
   8 #ifdef BACKLIGHT_ENABLE
   9   #include "backlight.h"
  10 #endif
  11 #include "eeconfig.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 0
  20 #define _COLEMAK 1
  21 #define _DVORAK 2
  22 #define _LOWER 3
  23 #define _RAISE 4
  24 #define _PLOVER 5
  25 #define _NUMPAD 6
  26 #define _ADJUST 16
  27
  28 enum planck_keycodes {
  29   QWERTY = SAFE_RANGE,
  30   NUMPAD,
  31   EXT_NUM,
  32   COLEMAK,
  33   DVORAK,
  34   PLOVER,
  35   LOWER,
  36   RAISE,
  37   BACKLIT,
  38   EXT_PLV
  39 };
  40
  41 // Fillers to make layering more clear
  42 #define _______ KC_TRNS
  43 #define XXXXXXX KC_NO
  44
  45 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  46
  47 /* Qwerty
  48  * ,-----------------------------------------------------------------------------------.
  49  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  50  * |------+------+------+------+------+-------------+------+------+------+------+------|
  51  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  52  * |------+------+------+------+------+------|------+------+------+------+------+------|
  53  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |En/sh |
  54  * |------+------+------+------+------+------+------+------+------+------+------+------|
  55  * | Ctrl | Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  56  * `-----------------------------------------------------------------------------------'
  57  */
  58 [_QWERTY] = {
  59   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  60   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  61   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, F(0) },
  62   {KC_LCTRL,KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  63 },
  64
  65 /* Colemak
  66  * ,-----------------------------------------------------------------------------------.
  67  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  68  * |------+------+------+------+------+-------------+------+------+------+------+------|
  69  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
  70  * |------+------+------+------+------+------|------+------+------+------+------+------|
  71  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
  72  * |------+------+------+------+------+------+------+------+------+------+------+------|
  73  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  74  * `-----------------------------------------------------------------------------------'
  75  */
  76 [_COLEMAK] = {
  77   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  78   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  79   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
  80   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  81 },
  82
  83 /* Dvorak
  84  * ,-----------------------------------------------------------------------------------.
  85  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  86  * |------+------+------+------+------+-------------+------+------+------+------+------|
  87  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
  88  * |------+------+------+------+------+------|------+------+------+------+------+------|
  89  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  90  * |------+------+------+------+------+------+------+------+------+------+------+------|
  91  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  92  * `-----------------------------------------------------------------------------------'
  93  */
  94 [_DVORAK] = {
  95   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  96   {KC_ESC,  KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
  97   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_ENT },
  98   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  99 },
 100
 101 /* Lower
 102  * ,-----------------------------------------------------------------------------------.
 103  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 104  * |------+------+------+------+------+-------------+------+------+------+------+------|
 105  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 106  * |------+------+------+------+------+------|------+------+------+------+------+------|
 107  * | Shift |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |     |      | Home |  End |Enter |
 108  * |------+------+------+------+------+------+------+------+------+------+------+------|
 109  * | Brite|      |      |      |      |             |      | Play | Vol- | Vol+ | Next |
 110  * `-----------------------------------------------------------------------------------'
 111  */
 112 [_LOWER] = {
 113   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 114   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 115   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______,KC_HOME, KC_END, _______},
 116   {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPLY, KC_VOLD, KC_VOLU, KC_MNXT}
 117 },
 118 \
 119 /* Raise
 120  * ,-----------------------------------------------------------------------------------.
 121  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 122  * |------+------+------+------+------+-------------+------+------+------+------+------|
 123  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
 124  * |------+------+------+------+------+------|------+------+------+------+------+------|
 125  * | Shift |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |     |      | PgUp | PgDn |Enter |
 126  * |------+------+------+------+------+------+------+------+------+------+------+------|
 127  * | Brite|      |      |      |      |             |      | Play | Vol- | Vol+ | Next |
 128  * `-----------------------------------------------------------------------------------'
 129  */
 130 [_RAISE] = {
 131   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 132   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 133   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, KC_PGUP, KC_PGDN, _______},
 134   {BACKLIT, _______, _______, _______, _______, _______, _______, _______, KC_MPLY, KC_VOLD, KC_VOLU, KC_MNXT}
 135 },
 136
 137 /* Plover layer (http://opensteno.org)
 138  * ,-----------------------------------------------------------------------------------.
 139  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 140  * |------+------+------+------+------+-------------+------+------+------+------+------|
 141  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 142  * |------+------+------+------+------+------|------+------+------+------+------+------|
 143  * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 144  * |------+------+------+------+------+------+------+------+------+------+------+------|
 145  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 146  * `-----------------------------------------------------------------------------------'
 147  */
 148
 149 [_PLOVER] = {
 150   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 151   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 152   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 153   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 154 },
 155
 156 /* Numpad
 157  * ,-----------------------------------------------------------------------------------.
 158  * |  Tab |      |      |   ^  |   /  |   7  |  8   |   9  |  -   |   =  |      | Bksp |
 159  * |------+------+------+------+------+-------------+------+------+------+------+------|
 160  * |  Esc |      |      |   %  |   *  |   4  |  5   |   6  |  +   |   (  |   )  |      |
 161  * |------+------+------+------+------+------|------+------+------+------+------+------|
 162  * | Shft |      |      |   $  |  Del |   1  |  2   |   3  |Enter |   [  |   ]  |Enter |
 163  * |------+------+------+------+------+------+------+------+------+------+------+------|
 164  * | Exit | Ctrl |  Alt |  Gui |      |      0      |   .  | Left | Down |  Up  |Right |
 165  * `-----------------------------------------------------------------------------------'
 166  */
 167 [_NUMPAD] = {
 168   {KC_TAB,  XXXXXXX, XXXXXXX, KC_CIRC, KC_PSLS, KC_P7,   KC_P8,   KC_P9,   KC_PMNS, KC_EQL, XXXXXXX, KC_BSPC},
 169   {KC_ESC,  XXXXXXX, XXXXXXX, KC_PERC, KC_PAST, KC_P4,   KC_P5,   KC_P6,   KC_PPLS, KC_LPRN, KC_RPRN, XXXXXXX},
 170   {KC_LSFT, XXXXXXX, XXXXXXX, KC_DLR,  KC_DEL,  KC_P1,   KC_P2,   KC_P3,   KC_PENT, KC_LBRC, KC_RBRC, KC_ENT },
 171   {EXT_NUM, KC_LCTL, KC_LALT, KC_LGUI, XXXXXXX, KC_P0,   KC_P0,   KC_PDOT, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 172 },
 173
 174 /* Adjust (Lower + Raise)
 175  * ,-----------------------------------------------------------------------------------.
 176  * |      | Reset|      |      |      |      |      |      |      |      |      | Del  |
 177  * |------+------+------+------+------+-------------+------+------+------+------+------|
 178  * | Login|      |      |      |      |      |  Num |Qwerty|Colemk|Dvorak|Plover|      |
 179  * |------+------+------+------+------+------|------+------+------+------+------+------|
 180  * | Caps |RGBTOG|RGBMOD| Hue+ | Hue- | Sat+ | Sat- | Val+ | Val- |      |      |      |
 181  * |------+------+------+------+------+------+------+------+------+------+------+------|
 182  * |      |      |      |      |      |             |      |      |      |      |      |
 183  * `-----------------------------------------------------------------------------------'
 184  */
 185 [_ADJUST] = {
 186   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL },
 187   { M(1)  , _______, _______, _______, _______, _______,  NUMPAD,  QWERTY, COLEMAK,  DVORAK,  PLOVER,  _______},
 188   {KC_CAPS, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______},
 189   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 190 }
 191
 192
 193 };
 194
 195 const uint16_t PROGMEM fn_actions[] = {
 196   [0]  = ACTION_MODS_TAP_KEY(MOD_RSFT, KC_ENT),
 197 };
 198
 199 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 200 {
 201   // MACRODOWN only works in this function
 202   switch(id) {
 203     case 0:
 204     if (record->event.pressed) {
 205       register_code(KC_RSFT);
 206       register_code(KC_RCTL);
 207       register_code(KC_ESC);
 208     }
 209     else{
 210       clear_keyboard();
 211     }
 212     break;
 213     case 1:
 214     if (record->event.pressed) {
 215       register_code(KC_LCTL);
 216       register_code(KC_LALT);
 217       register_code(KC_DEL);
 218     }
 219     else{
 220       clear_keyboard();
 221     }
 222     break;
 223   }
 224   return MACRO_NONE;
 225 };
 226
 227
 228 #ifdef AUDIO_ENABLE
 229
 230 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 231 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 232 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 233 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 234 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 235 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 236 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 237
 238 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 239 #endif
 240
 241
 242 void persistant_default_layer_set(uint16_t default_layer) {
 243   eeconfig_update_default_layer(default_layer);
 244   default_layer_set(default_layer);
 245 }
 246
 247 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 248   switch (keycode) {
 249     case QWERTY:
 250       if (record->event.pressed) {
 251         #ifdef AUDIO_ENABLE
 252           PLAY_SONG(tone_qwerty);
 253         #endif
 254         persistant_default_layer_set(1UL<<_QWERTY);
 255       }
 256       return false;
 257       break;
 258     case NUMPAD:
 259       if (record->event.pressed) {
 260         layer_off(_RAISE);
 261         layer_off(_LOWER);
 262         layer_off(_ADJUST);
 263         layer_on(_NUMPAD);
 264       }
 265       return false;
 266       break;
 267     case EXT_NUM:
 268       if (record->event.pressed) {
 269         layer_off(_NUMPAD);
 270       }
 271       return false;
 272       break;
 273     case COLEMAK:
 274       if (record->event.pressed) {
 275         #ifdef AUDIO_ENABLE
 276           PLAY_SONG(tone_colemak);
 277         #endif
 278         persistant_default_layer_set(1UL<<_COLEMAK);
 279       }
 280       return false;
 281       break;
 282     case DVORAK:
 283       if (record->event.pressed) {
 284         #ifdef AUDIO_ENABLE
 285           PLAY_SONG(tone_dvorak);
 286         #endif
 287         persistant_default_layer_set(1UL<<_DVORAK);
 288       }
 289       return false;
 290       break;
 291     case LOWER:
 292       if (record->event.pressed) {
 293         layer_on(_LOWER);
 294         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 295       } else {
 296         layer_off(_LOWER);
 297         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 298       }
 299       return false;
 300       break;
 301     case RAISE:
 302       if (record->event.pressed) {
 303         layer_on(_RAISE);
 304         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 305       } else {
 306         layer_off(_RAISE);
 307         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 308       }
 309       return false;
 310       break;
 311     case BACKLIT:
 312       if (record->event.pressed) {
 313         register_code(KC_RSFT);
 314         #ifdef BACKLIGHT_ENABLE
 315           backlight_step();
 316         #endif
 317       } else {
 318         unregister_code(KC_RSFT);
 319       }
 320       return false;
 321       break;
 322     case PLOVER:
 323       if (record->event.pressed) {
 324         #ifdef AUDIO_ENABLE
 325           stop_all_notes();
 326           PLAY_SONG(tone_plover);
 327         #endif
 328         layer_off(_RAISE);
 329         layer_off(_LOWER);
 330         layer_off(_ADJUST);
 331         layer_on(_PLOVER);
 332         if (!eeconfig_is_enabled()) {
 333             eeconfig_init();
 334         }
 335         keymap_config.raw = eeconfig_read_keymap();
 336         keymap_config.nkro = 1;
 337         eeconfig_update_keymap(keymap_config.raw);
 338       }
 339       return false;
 340       break;
 341     case EXT_PLV:
 342       if (record->event.pressed) {
 343         #ifdef AUDIO_ENABLE
 344           PLAY_SONG(tone_plover_gb);
 345         #endif
 346         layer_off(_PLOVER);
 347       }
 348       return false;
 349       break;
 350   }
 351   return true;
 352 }
 353
 354 void matrix_init_user(void) {
 355     #ifdef AUDIO_ENABLE
 356         startup_user();
 357     #endif
 358 }
 359
 360 #ifdef AUDIO_ENABLE
 361
 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