keyboards/planck/keymaps/chance/keymap.c

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