keyboards/planck/keymaps/ishtob/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 // #include "dynamic_macro.h"
   7 #ifdef AUDIO_ENABLE
   8   #include "audio.h"
   9 #endif
  10 #include "eeconfig.h"
  11 #include "ishtob.h"
  12
  13 extern keymap_config_t keymap_config;
  14
  15 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  16 /* Qwerty
  17  ,-----------------------------------------------------------------------------------.
  18  * |Tab/FN|   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  19  * |------+------+------+------+------+-------------+------+------+------+------+------|
  20  * | LCtl |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |Ctl/Et|
  21  * |------+------+------+------+------+------|------+------+------+------+------+------|
  22  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |  ,   |   .  |   /  |  -   |
  23  * |------+------+------+------+------+------+------+------+------+------+------+------|
  24  * | Esc  | Caps | Alt  | GUI  |Lower |    Space    |Raise |NumLay| RAlt | Men  | Del  |
  25  * `-----------------------------------------------------------------------------------'
  26  */
  27 [_QWERTY] = LAYOUT_ortho_4x12_wrapper(
  28   LT_FN(KC_TAB), _________________QWERTY_L1_________________, _________________QWERTY_R1_________________, KC_BSPC,
  29   KC_LCTL,       _________________QWERTY_L2_________________, _________________QWERTY_R2_________________, CTL_ENT,
  30   KC_LSFT,       _________________QWERTY_L3_________________, _________________QWERTY_R3_________________, LT_RAI(KC_MINS),
  31   KC_ESC,        KC_CAPS, KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE, KC_RALT, TG_NUMLAY, KC_APP,  KC_DEL
  32 ),
  33
  34 /* Colemak
  35  * ,-----------------------------------------------------------------------------------.
  36  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  37  * |------+------+------+------+------+-------------+------+------+------+------+------|
  38  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |Ctl/Et|
  39  * |------+------+------+------+------+------|------+------+------+------+------+------|
  40  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |  -   |
  41  * |------+------+------+------+------+------+------+------+------+------+------+------|
  42  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  43  * `-----------------------------------------------------------------------------------'
  44  */
  45 [_COLEMAK] = LAYOUT_ortho_4x12_wrapper(
  46   LT_FN(KC_TAB), _________________COLEMAK_L1________________, _________________COLEMAK_R1________________, KC_BSPC,
  47   KC_LCTL,       _________________COLEMAK_L2________________, _________________COLEMAK_R2________________, KC_ENT,
  48   KC_LSFT,       _________________COLEMAK_L3________________, _________________COLEMAK_R3________________, LT_RAI(KC_MINS),
  49   KC_ESC,        KC_CAPS, KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE, KC_RALT, TG_NUMLAY, KC_APP,  KC_DEL
  50 ),
  51
  52 /* Dvorak
  53  * ,-----------------------------------------------------------------------------------.
  54  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
  55  * |------+------+------+------+------+-------------+------+------+------+------+------|
  56  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |Ctl/Et|
  57  * |------+------+------+------+------+------|------+------+------+------+------+------|
  58  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
  59  * |------+------+------+------+------+------+------+------+------+------+------+------|
  60  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
  61  * `-----------------------------------------------------------------------------------'
  62  */
  63 [_DVORAK] = LAYOUT_ortho_4x12_wrapper(
  64   LT_FN(KC_TAB), _________________DVORAK_L1_________________, _________________DVORAK_R1_________________, KC_BSPC,
  65   KC_LCTL,       _________________DVORAK_L2_________________, _________________DVORAK_R2_________________, KC_ENT,
  66   KC_LSFT,       _________________DVORAK_L3_________________, _________________DVORAK_R3_________________, LT_RAI(KC_MINS),
  67   KC_ESC,        KC_CAPS, KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE, KC_RALT, TG_NUMLAY, KC_APP,  KC_DEL
  68 ),
  69
  70 /* Lower
  71  * ,-----------------------------------------------------------------------------------.
  72  * |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |   ~  |  \   |
  73  * |------+------+------+------+------+-------------+------+------+------+------+------|
  74  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
  75  * |------+------+------+------+------+------|------+------+------+------+------+------|
  76  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |   [  |   ]  |      |
  77  * |------+------+------+------+------+------+------+------+------+------+------+------|
  78  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
  79  * `-----------------------------------------------------------------------------------'
  80  */
  81 [_LOWER] = LAYOUT_ortho_4x12_wrapper(
  82   ________________NUMBER_LEFT________________, ________________NUMBER_RIGHT_______________,    KC_GRV,  KC_BSLS,
  83   _______, __________________LONG_FUNC_LEFT___________________,   KC_UNDS, KC_EQL,  KC_LBRC, KC_RBRC, KC_PIPE,
  84   _______, __________________LONG_FUNC_RIGHT__________________,S(KC_NUHS),S(KC_NUBS),KC_LCBR, KC_RCBR, _______,
  85   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
  86 ),
  87
  88 /* Raise
  89  * ,-----------------------------------------------------------------------------------.
  90  * |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |   *  |  \   |
  91  * |------+------+------+------+------+-------------+------+------+------+------+------|
  92  * |      |   A  |  Up  |   D  |      | Vol+ |   4  |   5  |   6  |   +  |   :  |  '   |
  93  * |------+------+------+------+------+------|------+------+------+------+------+------|
  94  * |      |  Lt  |  Dn  |  Rt  | Mute | Vol- |   1  |   2  |   3  |  Up  |   /  |      |
  95  * |------+------+------+------+------+------+------+------+------+------+------+------|
  96  * |      |      |      |      |      |      |   0  |      | Left | Down | Right| NumLk|
  97  * `-----------------------------------------------------------------------------------'
  98  */
  99 [_RAISE] = LAYOUT_ortho_4x12_wrapper(
 100   ________________NUMBER_LEFT________________, ________________NUMBER_RIGHT_______________,    KC_PLUS,  KC_BSLS,
 101   _______, KC_A,    KC_UP,   KC_D,    KC_PSCR,  KC_VOLU, KC_4,    KC_5,    KC_6,    KC_PAST, KC_COLN, KC_QUOT,
 102   _______, KC_LEFT, KC_DOWN, KC_RIGHT,KC__MUTE, KC_VOLD, KC_1,    KC_2,    KC_3,    KC_UP, KC_SLSH,   _______,
 103   _______, _______, _______, _______, _______, KC_SPC,  KC_0,   _______,  KC_LEFT, KC_DOWN, KC_RIGHT,   KC_NLCK
 104 ),
 105
 106 /* Plover layer (http://opensteno.org)
 107  * ,-----------------------------------------------------------------------------------.
 108  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
 109  * |------+------+------+------+------+-------------+------+------+------+------+------|
 110  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
 111  * |------+------+------+------+------+------|------+------+------+------+------+------|
 112  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
 113  * |------+------+------+------+------+------+------+------+------+------+------+------|
 114  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
 115  * `-----------------------------------------------------------------------------------'
 116  */
 117
 118 [_PLOVER] = LAYOUT_ortho_4x12_wrapper(
 119   KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   ,
 120   XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC,
 121   XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
 122   EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX
 123 ),
 124
 125 /* FN layer on Esc key
 126  * ,-----------------------------------------------------------------------------------.
 127  * |      |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |   +  |
 128  * |------+------+------+------+------+-------------+------+------+------+------+------|
 129  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   =  |   [  |   ]  |  '   |
 130  * |------+------+------+------+------+------|------+------+------+------+------+------|
 131  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |   {  |   }  |Enter |
 132  * |------+------+------+------+------+------+------+------+------+------+------+------|
 133  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
 134  * `-----------------------------------------------------------------------------------'
 135  */
 136 [_FNLAYER] = LAYOUT_ortho_4x12_wrapper(
 137   _______, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PLUS,
 138   _______, __________________LONG_FUNC_LEFT___________________,   KC_UNDS, KC_EQL,  KC_LBRC, KC_RBRC, KC_QUOT,
 139   _______, __________________LONG_FUNC_RIGHT__________________,S(KC_NUHS),S(KC_NUBS),KC_LCBR, KC_RCBR, _______,
 140   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
 141 ),
 142
 143 /* Num Layer
 144  * ,-----------------------------------------------------------------------------------.
 145  * |      |   Q  |  Up  |   4  |      |      |   7  |   8  |   9  |   -  |   +  | Bksp |
 146  * |------+------+------+------+------+-------------+------+------+------+------+------|
 147  * |      |  Lt  |  Dn  |  Rt  |      |      |   4  |   5  |   6  |   *  |   :  |  ENT |
 148  * |------+------+------+------+------+------|------+------+------+------+------+------|
 149  * |      |   Z  |   X  |   C  |   V  |      |   1  |   2  |   3  |   .  |   /  |      |
 150  * |------+------+------+------+------+------+------+------+------+------+------+------|
 151  * |      |      |      |      |      |      |   0  |   .  | Exit | Vol- | Vol+ | Play |
 152  * `-----------------------------------------------------------------------------------'
 153  */
 154 [_NUMLAY] = LAYOUT_ortho_4x12_wrapper(
 155   _______, KC_Q,    KC_UP,   KC_H,     XXXXXXX, XXXXXXX,  KC_P7,   KC_P8,  KC_P9,   KC_MINS,   KC_PLUS,  KC_BSPC,
 156   _______, KC_LEFT, KC_DOWN, KC_RIGHT, XXXXXXX, XXXXXXX,  KC_P4,  KC_P5,  KC_P6,   KC_PAST, KC_COLN,  KC_ENT,
 157   _______, KC_Z,    KC_X,    KC_C,     KC_V,    XXXXXXX,  KC_P1,  KC_P2,  KC_P3,   KC_PDOT, KC_PSLS,  _______,
 158   _______, _______, _______, _______, _______, _______,   KC_P0,  KC_PDOT, _______, _______, KC_NLCK, KC_MPLY
 159 ),
 160
 161 /* Mouse Layer (semi-col)
 162  * ,-----------------------------------------------------------------------------------.
 163  * | ACCL0| ACCL1| ACCL2|Email |Email2| Home | Wh_Up| WHL_L| M_Up | WHL_R|PASS| Meta |
 164  * |------+------+------+------+------+-------------+------+------+------+------+------|
 165  * |      |      |      |      |RT Q6H| End  | Wh_Dn| M_Lft| M_Dn | M_Rt |      | DayRn|
 166  * |------+------+------+------+------+------|------+------+------+------+------+------|
 167  * |      |      |      |      |      |      | BTN2 | BTN3 | BTN4 | BTN5 |      |      |
 168  * |------+------+------+------+------+------+------+------+------+------+------+------|
 169  * |      |      |      |      |      |     BTN1    |      |      |      | Citx |      |
 170  * `-----------------------------------------------------------------------------------'
 171  */
 172
 173 [_MOUSECURSOR] = LAYOUT_ortho_4x12_wrapper(
 174   KC_ACL0, KC_ACL1, KC_ACL2, M_EMAIL,M_EMAIL2, KC_HOME, KC_PGUP, KC_WH_L, KC_MS_U, KC_WH_R, P_MPASS, P_META,
 175   _______, XXXXXXX, XXXXXXX, XXXXXXX, O_RTQ6H, KC_END , KC_PGDN, KC_MS_L, KC_MS_D, KC_MS_R, _______, O_DAYRN,
 176   _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, KC_BTN2, KC_BTN3, KC_BTN4, KC_BTN5, _______, _______,
 177   _______, _______, _______, _______, _______, KC_BTN1, KC_BTN1, _______, _______, _______, P_CITRIX, O_AUTODC
 178 ),
 179
 180 /* Adjust (Lower + Raise)
 181  * ,-----------------------------------------------------------------------------------.
 182  * | Reset|RGB TG|RGB ST|RGBH -|RGBH +|RGBS -|RGBS +|RGBV -|RGBV +|      |      |  Del |
 183  * |------+------+------+------+------+-------------+------+------+------+------+------|
 184  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
 185  * |------+------+------+------+------+------|------+------+------+------+------+------|
 186  * |      |Voice-|Voice+|Mus on|Musoff|      |      |      |      | BL + |BL ST |BL TG |
 187  * |------+------+------+------+------+------+------+------+------+------+------+------|
 188  * |      |      |      |      |      |             |      |      |      |      |      |
 189  * `-----------------------------------------------------------------------------------'
 190  */
 191 [_ADJUST] = LAYOUT_ortho_4x12_wrapper(
 192   DFU, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, KC_DEL,
 193   _______, MAGIC_TOGGLE_NKRO, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______,
 194   _______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, BL_DEC, BL_INC, BL_STEP, BL_TOGG,
 195   _______, _______, _______, _______, _______, _______, _______, _______, CK_RST, CK_DOWN, CK_UP, CK_TOGG
 196 )
 197
 198
 199 };
 200
 201 const uint16_t PROGMEM fn_actions[] = {
 202   ACTION_SWAP_HANDS_TAP_KEY(KC_SPC),
 203 };
 204
 205 #ifdef AUDIO_ENABLE
 206
 207 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 208 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 209 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 210 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 211 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 212 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 213 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
 214
 215 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 216 #endif
 217
 218
 219 void persistant_default_layer_set(uint16_t default_layer) {
 220   eeconfig_update_default_layer(default_layer);
 221   default_layer_set(default_layer);
 222 }
 223
 224 //  Helper Functions
 225 void tap(uint16_t keycode){ register_code(keycode); unregister_code(keycode); };
 226
 227
 228 bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
 229   switch (keycode) {
 230     case QWERTY:
 231       if (record->event.pressed) {
 232         #ifdef AUDIO_ENABLE
 233           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 234         #endif
 235         persistant_default_layer_set(1UL<<_QWERTY);
 236       }
 237       return false;
 238       break;
 239     case COLEMAK:
 240       if (record->event.pressed) {
 241         #ifdef AUDIO_ENABLE
 242           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 243         #endif
 244         persistant_default_layer_set(1UL<<_COLEMAK);
 245       }
 246       return false;
 247       break;
 248     case DVORAK:
 249       if (record->event.pressed) {
 250         #ifdef AUDIO_ENABLE
 251           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
 252         #endif
 253         persistant_default_layer_set(1UL<<_DVORAK);
 254       }
 255       return false;
 256       break;
 257     case LOWER:
 258       if (record->event.pressed) {
 259         layer_on(_LOWER);
 260         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 261       } else {
 262         layer_off(_LOWER);
 263         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 264       }
 265       return false;
 266       break;
 267     case RAISE:
 268       if (record->event.pressed) {
 269         layer_on(_RAISE);
 270         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 271       } else {
 272         layer_off(_RAISE);
 273         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 274       }
 275       return false;
 276       break;
 277     case BACKLIT:
 278       if (record->event.pressed) {
 279         register_code(KC_RSFT);
 280         #ifdef BACKLIGHT_ENABLE
 281           backlight_step();
 282         #endif
 283       } else {
 284         unregister_code(KC_RSFT);
 285       }
 286       return false;
 287       break;
 288     case PLOVER:
 289       if (record->event.pressed) {
 290         #ifdef AUDIO_ENABLE
 291           stop_all_notes();
 292           PLAY_NOTE_ARRAY(tone_plover, false, 0);
 293         #endif
 294         layer_off(_RAISE);
 295         layer_off(_LOWER);
 296         layer_off(_ADJUST);
 297         layer_on(_PLOVER);
 298         if (!eeconfig_is_enabled()) {
 299             eeconfig_init();
 300         }
 301         keymap_config.raw = eeconfig_read_keymap();
 302         keymap_config.nkro = 1;
 303         eeconfig_update_keymap(keymap_config.raw);
 304       }
 305       return false;
 306       break;
 307     case EXT_PLV:
 308       if (record->event.pressed) {
 309         #ifdef AUDIO_ENABLE
 310           PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
 311         #endif
 312         layer_off(_PLOVER);
 313       }
 314       return false;
 315       break;
 316   }
 317   return true;
 318 }
 319
 320 void matrix_init_keymap(void) {
 321     #ifdef AUDIO_ENABLE
 322         startup_user();
 323     #endif
 324 }
 325
 326 #ifdef AUDIO_ENABLE
 327
 328 void startup_user()
 329 {
 330     #ifdef RGB_MATRIX_ENABLE
 331     rgblight_mode(RGB_MATRIX_CYCLE_ALL);
 332     #endif //RGB_matrix
 333     wait_ms(20); // gets rid of tick
 334     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 335 }
 336
 337 void shutdown_user()
 338 {
 339     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 340     wait_ms(150);
 341     stop_all_notes();
 342 }
 343
 344 void music_on_user(void)
 345 {
 346     music_scale_user();
 347 }
 348
 349 void music_scale_user(void)
 350 {
 351     PLAY_NOTE_ARRAY(music_scale, false, 0);
 352 }
 353
 354 #endif
 355