keyboards/planck/keymaps/jeebak/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 #include "eeconfig.h"
  10
  11 extern keymap_config_t keymap_config;
  12
  13 // Each layer gets a name for readability, which is then used in the keymap matrix below.
  14 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  15 // Layer names don't all need to be of the same length, obviously, and you can also skip them
  16 // entirely and just use numbers.
  17 #define _QWERTY 0
  18 #define _COLEMAK 1
  19 #define _DVORAK 2
  20 #define _LOWER 3
  21 #define _RAISE 4
  22 #define _PLOVER 5
  23 #define _TOUCHCURSOR 6
  24 #define _ADJUST 16
  25
  26 enum planck_keycodes {
  27   QWERTY = SAFE_RANGE,
  28   COLEMAK,
  29   DVORAK,
  30   PLOVER,
  31   LOWER,
  32   RAISE,
  33   BACKLIT,
  34   EXT_PLV
  35 };
  36
  37 // Fillers to make layering more clear
  38 #define _______ KC_TRNS
  39 #define XXXXXXX KC_NO
  40
  41 // Custom macros
  42 #define CTL_ESC     CTL_T(KC_ESC)               // Tap for Esc, hold for Ctrl
  43 #define LT_TC       LT(_TOUCHCURSOR, KC_SPC)    // L-ayer T-ap T-ouch C-ursor
  44 //                  ^-- Requires KC_TRNS / _______ for the trigger key in the destination layer
  45 #define SFT_ENT     SFT_T(KC_ENT)               // Tap for Enter, hold for Shift
  46
  47 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  48
  49 /* Qwerty
  50  * ,-----------------------------------------------------------------------------------------.
  51  * | Tab      |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  |  Bksp  |
  52  * |----------+------+------+------+------+-------------+------+------+------+------+--------|
  53  * | Ctrl/Esc |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |   "    |
  54  * |----------+------+------+------+------+------|------+------+------+------+------+--------|
  55  * | Shift    |   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Sft/Ent |
  56  * |----------+------+------+------+------+------+------+------+------+------+------+--------|
  57  * | Brite    | Ctrl | Alt  | GUI  |Lower |  TC/Space   |Raise | Left | Down |  Up  | Right  |
  58  * `-----------------------------------------------------------------------------------------'
  59  */
  60 [_QWERTY] = {
  61   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
  62   {CTL_ESC, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
  63   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_ENT},
  64   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  65 },
  66
  67 /* Colemak
  68  * ,-----------------------------------------------------------------------------------------.
  69  * | Tab      |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  |  Bksp  |
  70  * |----------+------+------+------+------+-------------+------+------+------+------+--------|
  71  * | Ctrl/Esc |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |   "    |
  72  * |----------+------+------+------+------+------|------+------+------+------+------+--------|
  73  * | Shift    |   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Sft/Ent |
  74  * |----------+------+------+------+------+------+------+------+------+------+------+--------|
  75  * | Brite    | Ctrl | Alt  | GUI  |Lower |  TC/Space   |Raise | Left | Down |  Up  | Right  |
  76  * `-----------------------------------------------------------------------------------------'
  77  */
  78 [_COLEMAK] = {
  79   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
  80   {CTL_ESC, KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
  81   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SFT_ENT},
  82   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
  83 },
  84
  85 /* Dvorak
  86  * ,-----------------------------------------------------------------------------------------.
  87  * | Tab      |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  |  Bksp  |
  88  * |----------+------+------+------+------+-------------+------+------+------+------+--------|
  89  * | Ctrl/Esc |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |   /    |
  90  * |----------+------+------+------+------+------|------+------+------+------+------+--------|
  91  * | Shift    |   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Sft/Ent |
  92  * |----------+------+------+------+------+------+------+------+------+------+------+--------|
  93  * | Brite    | Ctrl | Alt  | GUI  |Lower |  TC/Space   |Raise | Left | Down |  Up  | Right  |
  94  * `-----------------------------------------------------------------------------------------'
  95  */
  96 [_DVORAK] = {
  97   {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
  98   {CTL_ESC, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
  99   {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    SFT_ENT},
 100   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   LT_TC,  LT_TC,    RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
 101 },
 102
 103 /* Lower
 104  * ,-----------------------------------------------------------------------------------.
 105  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
 106  * |------+------+------+------+------+-------------+------+------+------+------+------|
 107  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
 108  * |------+------+------+------+------+------|------+------+------+------+------+------|
 109  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |   -  |   =  |   [  |   ]  |  \   |
 110  * |------+------+------+------+------+------+------+------+------+------+------+------|
 111  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 112  * `-----------------------------------------------------------------------------------'
 113  */
 114 [_LOWER] = {
 115   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 116   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 117   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 118   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 119 },
 120
 121 /* Raise
 122  * ,-----------------------------------------------------------------------------------.
 123  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 124  * |------+------+------+------+------+-------------+------+------+------+------+------|
 125  * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |      |      |      |      |      |
 126  * |------+------+------+------+------+------|------+------+------+------+------+------|
 127  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |      |      |      |      |Enter |
 128  * |------+------+------+------+------+------+------+------+------+------+------+------|
 129  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 130  * `-----------------------------------------------------------------------------------'
 131  */
 132 [_RAISE] = {
 133   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 134   {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   _______, _______, _______, _______, _______},
 135   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______, _______, _______, _______},
 136   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 137 },
 138
 139 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
 140  * ,-----------------------------------------------------------------------------------.
 141  * |      |      |      |Shift | GUI  |  ~   |Insert| Home |  Up  | End  | Bksp |      |
 142  * |------+------+------+------+------+-------------+------+------+------+------+------|
 143    |      | Alt  |Space |      |      |      | PgUp | Left | Down |Right |      |      |
 144  * |------+------+------+------+------+------|------+------+------+------+------+------|
 145    |      |      |      |      |      |  `   | PgDn | Del  |      |      |      |      |
 146  * |------+------+------+------+------+------+------+------+------+------+------+------|
 147    |      |      |      |      |      |             |      |      |      |      |      |
 148  * `-----------------------------------------------------------------------------------'
 149  */
 150
 151 [_TOUCHCURSOR] = {
 152   {_______, _______, _______, KC_LSFT, KC_LGUI, KC_TILD, KC_INS,  KC_HOME, KC_UP,   KC_END,  KC_BSPC, _______},
 153   {_______, KC_LALT, KC_SPC,  _______, _______, _______, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
 154   {_______, _______, _______, _______, _______, KC_GRV,  KC_PGDN, KC_DEL,  _______, _______, _______, _______},
 155   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 156 },
 157
 158 /* Plover layer (http://opensteno.org)
 159  * ,-----------------------------------------------------------------------------------.
 160  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 161  * |------+------+------+------+------+-------------+------+------+------+------+------|
 162  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 163  * |------+------+------+------+------+------|------+------+------+------+------+------|
 164  * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 165  * |------+------+------+------+------+------+------+------+------+------+------+------|
 166  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 167  * `-----------------------------------------------------------------------------------'
 168  */
 169
 170 [_PLOVER] = {
 171   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 172   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 173   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 174   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 175 },
 176
 177 /* Adjust (Lower + Raise)
 178  * ,-----------------------------------------------------------------------------------.
 179  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 180  * |------+------+------+------+------+-------------+------+------+------+------+------|
 181  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 182  * |------+------+------+------+------+------|------+------+------+------+------+------|
 183  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 184  * |------+------+------+------+------+------+------+------+------+------+------+------|
 185  * |      |      |      |      |      |             |      |      |      |      |      |
 186  * `-----------------------------------------------------------------------------------'
 187  */
 188 [_ADJUST] = {
 189   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 190   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 191   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 192   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 193 }
 194
 195
 196 };
 197
 198 #ifdef AUDIO_ENABLE
 199
 200 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 201 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 202 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 203 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 204 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 205 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 206 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 207
 208 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 209 #endif
 210
 211
 212 void persistant_default_layer_set(uint16_t default_layer) {
 213   eeconfig_update_default_layer(default_layer);
 214   default_layer_set(default_layer);
 215 }
 216
 217 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 218   switch (keycode) {
 219     case QWERTY:
 220       if (record->event.pressed) {
 221         #ifdef AUDIO_ENABLE
 222           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 223         #endif
 224         persistant_default_layer_set(1UL<<_QWERTY);
 225       }
 226       return false;
 227       break;
 228     case COLEMAK:
 229       if (record->event.pressed) {
 230         #ifdef AUDIO_ENABLE
 231           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 232         #endif
 233         persistant_default_layer_set(1UL<<_COLEMAK);
 234       }
 235       return false;
 236       break;
 237     case DVORAK:
 238       if (record->event.pressed) {
 239         #ifdef AUDIO_ENABLE
 240           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 241         #endif
 242         persistant_default_layer_set(1UL<<_DVORAK);
 243       }
 244       return false;
 245       break;
 246     case LOWER:
 247       if (record->event.pressed) {
 248         layer_on(_LOWER);
 249         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 250       } else {
 251         layer_off(_LOWER);
 252         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 253       }
 254       return false;
 255       break;
 256     case RAISE:
 257       if (record->event.pressed) {
 258         layer_on(_RAISE);
 259         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 260       } else {
 261         layer_off(_RAISE);
 262         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 263       }
 264       return false;
 265       break;
 266     case BACKLIT:
 267       if (record->event.pressed) {
 268         register_code(KC_RSFT);
 269         #ifdef BACKLIGHT_ENABLE
 270           backlight_step();
 271         #endif
 272       } else {
 273         unregister_code(KC_RSFT);
 274       }
 275       return false;
 276       break;
 277     case PLOVER:
 278       if (record->event.pressed) {
 279         #ifdef AUDIO_ENABLE
 280           stop_all_notes();
 281           PLAY_NOTE_ARRAY(tone_plover, false, 0);
 282         #endif
 283         layer_off(_RAISE);
 284         layer_off(_LOWER);
 285         layer_off(_ADJUST);
 286         layer_on(_PLOVER);
 287         if (!eeconfig_is_enabled()) {
 288             eeconfig_init();
 289         }
 290         keymap_config.raw = eeconfig_read_keymap();
 291         keymap_config.nkro = 1;
 292         eeconfig_update_keymap(keymap_config.raw);
 293       }
 294       return false;
 295       break;
 296     case EXT_PLV:
 297       if (record->event.pressed) {
 298         #ifdef AUDIO_ENABLE
 299           PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 300         #endif
 301         layer_off(_PLOVER);
 302       }
 303       return false;
 304       break;
 305   }
 306   return true;
 307 }
 308
 309 void matrix_init_user(void) {
 310     #ifdef AUDIO_ENABLE
 311         startup_user();
 312     #endif
 313 }
 314
 315 #ifdef AUDIO_ENABLE
 316
 317 void startup_user()
 318 {
 319     _delay_ms(20); // gets rid of tick
 320     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 321 }
 322
 323 void shutdown_user()
 324 {
 325     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 326     _delay_ms(150);
 327     stop_all_notes();
 328 }
 329
 330 void music_on_user(void)
 331 {
 332     music_scale_user();
 333 }
 334
 335 void music_scale_user(void)
 336 {
 337     PLAY_NOTE_ARRAY(music_scale, false, 0);
 338 }
 339
 340 #endif