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
  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  * | Ctrl/Esc |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
  53  * |----------+------+------+------+------+------|------+------+------+------+------+------|
  54  * | Shift    |   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
  55  * |----------+------+------+------+------+------+------+------+------+------+------+------|
  56  * | Brite    | Ctrl | Alt  | GUI  |Lower |  TC/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   {CTL_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, KC_ENT },
  63   {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   LT_TC,   LT_TC,   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  * | Ctrl/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 |  TC/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   {CTL_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,   LT_TC,   LT_TC,   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  * | Ctrl/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 |  TC/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   {CTL_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,   LT_TC,  LT_TC,    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  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |Enter |
 109  * |------+------+------+------+------+------+------+------+------+------+------+------|
 110  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 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,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
 117   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 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  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |Enter |
 127  * |------+------+------+------+------+------+------+------+------+------+------+------|
 128  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 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_NUHS, KC_NUBS, _______, _______, _______},
 135   {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
 136 },
 137
 138 /* TouchCursor layer (http://martin-stone.github.io/touchcursor/) plus personal customizations
 139  * ,-----------------------------------------------------------------------------------.
 140  * |      |      |      |Shift | GUI  |  ~   |Insert| Home |  Up  | End  | Bksp |      |
 141  * |------+------+------+------+------+-------------+------+------+------+------+------|
 142    |      | Alt  |Space |      |      |      | PgUp | Left | Down |Right |      |      |
 143  * |------+------+------+------+------+------|------+------+------+------+------+------|
 144    |      |      |      |      |      |  `   | PgDn | Del  |      |      |      |      |
 145  * |------+------+------+------+------+------+------+------+------+------+------+------|
 146    |      |      |      |      |      |             |      |      |      |      |      |
 147  * `-----------------------------------------------------------------------------------'
 148  */
 149
 150 [_TOUCHCURSOR] = {
 151   {_______, _______, _______, KC_LSFT, KC_LGUI, KC_TILD, KC_INS,  KC_HOME, KC_UP,   KC_END,  KC_BSPC, _______},
 152   {_______, KC_LALT, KC_SPC,  _______, _______, _______, KC_PGUP, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______},
 153   {_______, _______, _______, _______, _______, KC_GRV,  KC_PGDN, KC_DEL,  _______, _______, _______, _______},
 154   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 155 },
 156
 157 /* Plover layer (http://opensteno.org)
 158  * ,-----------------------------------------------------------------------------------.
 159  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 160  * |------+------+------+------+------+-------------+------+------+------+------+------|
 161  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 162  * |------+------+------+------+------+------|------+------+------+------+------+------|
 163  * |TogOut|   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 164  * |------+------+------+------+------+------+------+------+------+------+------+------|
 165  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 166  * `-----------------------------------------------------------------------------------'
 167  */
 168
 169 [_PLOVER] = {
 170   {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
 171   {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
 172   {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
 173   {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
 174 },
 175
 176 /* Adjust (Lower + Raise)
 177  * ,-----------------------------------------------------------------------------------.
 178  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
 179  * |------+------+------+------+------+-------------+------+------+------+------+------|
 180  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 181  * |------+------+------+------+------+------|------+------+------+------+------+------|
 182  * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      |      |
 183  * |------+------+------+------+------+------+------+------+------+------+------+------|
 184  * |      |      |      |      |      |             |      |      |      |      |      |
 185  * `-----------------------------------------------------------------------------------'
 186  */
 187 [_ADJUST] = {
 188   {_______, RESET,   _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
 189   {_______, _______, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______},
 190   {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
 191   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 192 }
 193
 194
 195 };
 196
 197 #ifdef AUDIO_ENABLE
 198
 199 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 200 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 201 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 202 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 203 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 204 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 205 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 206
 207 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 208 #endif
 209
 210
 211 void persistant_default_layer_set(uint16_t default_layer) {
 212   eeconfig_update_default_layer(default_layer);
 213   default_layer_set(default_layer);
 214 }
 215
 216 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 217   switch (keycode) {
 218     case QWERTY:
 219       if (record->event.pressed) {
 220         #ifdef AUDIO_ENABLE
 221           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 222         #endif
 223         persistant_default_layer_set(1UL<<_QWERTY);
 224       }
 225       return false;
 226       break;
 227     case COLEMAK:
 228       if (record->event.pressed) {
 229         #ifdef AUDIO_ENABLE
 230           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 231         #endif
 232         persistant_default_layer_set(1UL<<_COLEMAK);
 233       }
 234       return false;
 235       break;
 236     case DVORAK:
 237       if (record->event.pressed) {
 238         #ifdef AUDIO_ENABLE
 239           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 240         #endif
 241         persistant_default_layer_set(1UL<<_DVORAK);
 242       }
 243       return false;
 244       break;
 245     case LOWER:
 246       if (record->event.pressed) {
 247         layer_on(_LOWER);
 248         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 249       } else {
 250         layer_off(_LOWER);
 251         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 252       }
 253       return false;
 254       break;
 255     case RAISE:
 256       if (record->event.pressed) {
 257         layer_on(_RAISE);
 258         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 259       } else {
 260         layer_off(_RAISE);
 261         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 262       }
 263       return false;
 264       break;
 265     case BACKLIT:
 266       if (record->event.pressed) {
 267         register_code(KC_RSFT);
 268         #ifdef BACKLIGHT_ENABLE
 269           backlight_step();
 270         #endif
 271       } else {
 272         unregister_code(KC_RSFT);
 273       }
 274       return false;
 275       break;
 276     case PLOVER:
 277       if (record->event.pressed) {
 278         #ifdef AUDIO_ENABLE
 279           stop_all_notes();
 280           PLAY_NOTE_ARRAY(tone_plover, false, 0);
 281         #endif
 282         layer_off(_RAISE);
 283         layer_off(_LOWER);
 284         layer_off(_ADJUST);
 285         layer_on(_PLOVER);
 286         if (!eeconfig_is_enabled()) {
 287             eeconfig_init();
 288         }
 289         keymap_config.raw = eeconfig_read_keymap();
 290         keymap_config.nkro = 1;
 291         eeconfig_update_keymap(keymap_config.raw);
 292       }
 293       return false;
 294       break;
 295     case EXT_PLV:
 296       if (record->event.pressed) {
 297         #ifdef AUDIO_ENABLE
 298           PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 299         #endif
 300         layer_off(_PLOVER);
 301       }
 302       return false;
 303       break;
 304   }
 305   return true;
 306 }
 307
 308 void matrix_init_user(void) {
 309     #ifdef AUDIO_ENABLE
 310         startup_user();
 311     #endif
 312 }
 313
 314 #ifdef AUDIO_ENABLE
 315
 316 void startup_user()
 317 {
 318     _delay_ms(20); // gets rid of tick
 319     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 320 }
 321
 322 void shutdown_user()
 323 {
 324     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 325     _delay_ms(150);
 326     stop_all_notes();
 327 }
 328
 329 void music_on_user(void)
 330 {
 331     music_scale_user();
 332 }
 333
 334 void music_scale_user(void)
 335 {
 336     PLAY_NOTE_ARRAY(music_scale, false, 0);
 337 }
 338
 339 #endif