keyboards/planck/keymaps/chance/keymap.c

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