keymap.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
  2. #include "planck.h"
  3. #include "action_layer.h"
  4. #ifdef AUDIO_ENABLE
  5. #include "audio.h"
  6. #endif
  7. #include "eeconfig.h"
  8. extern keymap_config_t keymap_config;
  9. // Each layer gets a name for readability, which is then used in the keymap matrix below.
  10. // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  11. // Layer names don't all need to be of the same length, obviously, and you can also skip them
  12. // entirely and just use numbers.
  13. #define _WORKMAN 0
  14. #define _FN 1
  15. #define _QWERTY 2
  16. #define _QW_FN 3
  17. #define _PLOVER 4
  18. #define _ADJ 5
  19. enum planck_keycodes {
  20. WORKMAN = SAFE_RANGE,
  21. QWERTY,
  22. PLOVER
  23. };
  24. // Fillers to make layering more clear
  25. #define _______ KC_TRNS
  26. #define XXXXXXX KC_NO
  27. const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  28. /* Workman Alpha-numeric
  29. * ,-----------------------------------------------------------------------------------------------.
  30. * | Q | D | R | W | B | F | U | P | J | 7 | 8 | 9 |
  31. * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  32. * | A | S | H | T | G | N | E | O | I | 4 | 5 | 6 |
  33. * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  34. * | Z | X | M | C | V | L | Y | K | Up | 1 | 2 | 3 |
  35. * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  36. * |Alt/Tab|Gui/Esc| , |CTL/Bsp| Fn/Ent|SFT/SPC| . | Left | Down | Right | 0 |Adj/Ent|
  37. * `-----------------------------------------------------------------------------------------------'
  38. */
  39. [_WORKMAN] = {
  40. {KC_Q, KC_D, KC_R, KC_W, KC_B, KC_F, KC_U, KC_P, KC_J, KC_KP_7, KC_KP_8, KC_KP_9},
  41. {KC_A, KC_S, KC_H, KC_T, KC_G, KC_N, KC_E, KC_O, KC_I, KC_KP_4, KC_KP_5, KC_KP_6},
  42. {KC_Z, KC_X, KC_M, KC_C, KC_V, KC_L, KC_Y, KC_K, KC_UP, KC_KP_1, KC_KP_2, KC_KP_3},
  43. {ALT_T(KC_TAB), GUI_T(KC_ESC), KC_COMM, CTL_T(KC_BSPC), LT(_FN, KC_ENT), SFT_T(KC_SPC), KC_DOT, KC_LEFT, KC_DOWN, KC_RGHT, KC_KP_0, LT(_ADJ, KC_ENT)}
  44. },
  45. /* FN-key held (Workman)
  46. * ,-----------------------------------------------------------------------------------------------.
  47. * | ! | @ | # | $ | % | ^ | & | * | F12 | F7 | F8 | F9 |
  48. * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  49. * | Tab | [ | ] | - | Del | ' | ( | ) | F11 | F4 | F5 | F6 |
  50. * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  51. * | Menu | | | = | \ | / | | | PgUp | F1 | F2 | F3 |
  52. * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  53. * |Alt/Tab| Gui | ~ |CTL/Bsp| Fn/Ent|SFT/Spc| ; | Home | PgDn | End | F10 |Adj/Ent|
  54. * `-----------------------------------------------------------------------------------------------'
  55. */
  56. [_FN] = {
  57. {KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_F12, KC_F7, KC_F8, KC_F9},
  58. {KC_TAB, KC_LBRACKET, KC_RBRACKET, KC_MINUS, KC_DELETE, KC_QUOT, KC_LPRN, KC_RPRN, KC_F11, KC_F4, KC_F5, KC_F6},
  59. {KC_MENU, _______, _______, KC_EQUAL, KC_BSLS, KC_SLSH, XXXXXXX, XXXXXXX, KC_PGUP, KC_F1, KC_F2, KC_F3},
  60. {_______, KC_LGUI, KC_GRAVE, _______, _______, _______, KC_SCOLON, KC_HOME, KC_PGDN, KC_END, KC_F10, _______}
  61. },
  62. /* Qwerty
  63. * ,-----------------------------------------------------------------------------------------------.
  64. * |Gui/Esc| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
  65. * |-------+-------+-------+-------+-------+---------------+-------+-------+-------+-------+-------|
  66. * | Ctrl | Q | W | E | R | T | Y | U | I | O | P | / |
  67. * |-------+-------+-------+-------+-------+---------------+-------+-------+-------+-------+-------|
  68. * | Shift | A | S | D | F | G | H | J | K | L | ; | " |
  69. * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  70. * |Alt/Tab| Z | X | C | V | Fn/SPC| B | N | M | , | . |Adj/Ent|
  71. * `-----------------------------------------------------------------------------------------------'
  72. */
  73. [_QWERTY] = {
  74. {GUI_T(KC_ESC), KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
  75. {KC_LCTL, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_ENT},
  76. {KC_LSFT, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
  77. {ALT_T(KC_TAB), KC_Z, KC_X, KC_C, KC_V, LT(_QW_FN, KC_SPC), KC_B, KC_N, KC_M, KC_COMM, KC_DOT, LT(_ADJ, KC_ENT)},
  78. },
  79. /* FN-key held (Qwerty)
  80. * ,-----------------------------------------------------------------------------------------------.
  81. * | Gui | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 |
  82. * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  83. * | Ctrl | ~ | [ | PgUp | ] | | | - | Up | = | | F12 |
  84. * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  85. * | Shift | Tab | Home | PgDn | End | Del | | Left | Down | Right | | |
  86. * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  87. * |Alt/Tab| | | | | Fn/Spc| | | | | Menu |Adj/Ent|
  88. * `-----------------------------------------------------------------------------------------------'
  89. */
  90. [_QW_FN] = {
  91. {KC_LGUI, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11},
  92. {_______, KC_GRAVE, KC_LBRC, KC_PGUP, KC_RBRC, XXXXXXX, XXXXXXX, KC_MINS, KC_UP, KC_EQUAL, XXXXXXX, KC_F12},
  93. {_______, KC_TAB, KC_HOME, KC_PGDN, KC_END, KC_DELETE, XXXXXXX, KC_LEFT, KC_DOWN, KC_RIGHT, XXXXXXX, XXXXXXX},
  94. {_______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX, _______, _______, _______, KC_MENU, _______}
  95. },
  96. /* Plover layer (http://opensteno.org)
  97. * ,-----------------------------------------------------------------------------------------------.
  98. * | S | T | P | H | * | F | P | L | T | D | | |
  99. * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  100. * | S | K | W | R | * | R | B | G | S | Z | | |
  101. * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  102. * | # | # | # | # | | # | # | # | # | # | | |
  103. * |-------+-------+-------+-------+-------+---------------+-------+-------+-------+-------+-------|
  104. * | | | A | O | | E | U | | | | |Adj/Ent|
  105. * `-----------------------------------------------------------------------------------------------'
  106. */
  107. [_PLOVER] = {
  108. {KC_Q, KC_W, KC_E, KC_R, KC_T, KC_U, KC_I, KC_O, KC_P, KC_LBRC, XXXXXXX, XXXXXXX},
  109. {KC_A, KC_S, KC_D, KC_F, KC_G, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, XXXXXXX, XXXXXXX},
  110. {KC_1, KC_1, KC_1, KC_1, XXXXXXX, KC_1, KC_1, KC_1, KC_1, KC_1, XXXXXXX, XXXXXXX},
  111. {XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, LT(_ADJ, KC_ENT)}
  112. },
  113. /* Adjust
  114. * ,-----------------------------------------------------------------------------------------------.
  115. * | | | | | | | | | Insert| PrtSc | Pause | RESET |
  116. * |-------+-------+-------+-------+-------+---------------+-------+-------+-------+-------+-------|
  117. * | | | | | | | | CapLk |Voice +| Audio |MIDIoff| |
  118. * |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  119. * | | | | | | | | ScrLk |Voice -| Music |MIDI on| |
  120. * |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  121. * | | | | | | | | Numlk |Workman| Qwerty| Plover|Adj/Ent|
  122. * `-----------------------------------------------------------------------------------------------'
  123. */
  124. [_ADJ] = {
  125. {_______, _______, _______, _______, _______, _______, _______, _______, KC_INS, KC_PSCR, KC_PAUSE, RESET},
  126. {_______, _______, _______, _______, _______, _______, _______, KC_CLCK, MUV_IN, AU_TOG, MI_OFF, _______},
  127. {_______, _______, _______, _______, _______, _______, _______, KC_SLCK, MUV_DE, MU_TOG, MI_ON, _______},
  128. {_______, _______, _______, _______, _______, _______, _______, KC_NLCK, WORKMAN, QWERTY, PLOVER, _______}
  129. }
  130. };
  131. #ifdef AUDIO_ENABLE
  132. float tone_startup[][2] = SONG(STARTUP_SOUND);
  133. float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
  134. float tone_workman[][2] = SONG(QWERTY_SOUND);
  135. float tone_qwerty[][2] = SONG(COLEMAK_SOUND);
  136. float tone_plover[][2] = SONG(PLOVER_SOUND);
  137. float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
  138. #endif
  139. void persistent_default_layer_set(uint16_t default_layer) {
  140. eeconfig_update_default_layer(default_layer);
  141. default_layer_set(default_layer);
  142. }
  143. bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  144. switch (keycode) {
  145. case WORKMAN:
  146. if (record->event.pressed) {
  147. #ifdef AUDIO_ENABLE
  148. PLAY_SONG(tone_workman);
  149. #endif
  150. persistent_default_layer_set(1UL<<_WORKMAN);
  151. }
  152. return false;
  153. break;
  154. case QWERTY:
  155. if (record->event.pressed) {
  156. #ifdef AUDIO_ENABLE
  157. PLAY_SONG(tone_qwerty);
  158. #endif
  159. persistent_default_layer_set(1UL<<_QWERTY);
  160. }
  161. return false;
  162. break;
  163. case PLOVER:
  164. if (record->event.pressed) {
  165. #ifdef AUDIO_ENABLE
  166. PLAY_SONG(tone_plover);
  167. #endif
  168. if (!eeconfig_is_enabled()) {
  169. eeconfig_init();
  170. }
  171. keymap_config.raw = eeconfig_read_keymap();
  172. keymap_config.nkro = 1;
  173. eeconfig_update_keymap(keymap_config.raw);
  174. persistent_default_layer_set(1UL<<_PLOVER);
  175. }
  176. return false;
  177. break;
  178. }
  179. return true;
  180. }
  181. void matrix_init_user(void) {
  182. #ifdef AUDIO_ENABLE
  183. startup_user();
  184. #endif
  185. }
  186. #ifdef AUDIO_ENABLE
  187. void startup_user()
  188. {
  189. _delay_ms(20); // gets rid of tick
  190. PLAY_SONG(tone_startup);
  191. }
  192. void shutdown_user()
  193. {
  194. PLAY_SONG(tone_goodbye);
  195. _delay_ms(150);
  196. stop_all_notes();
  197. }
  198. void music_on_user(void)
  199. {
  200. music_scale_user();
  201. }
  202. void music_scale_user(void)
  203. {
  204. PLAY_SONG(music_scale);
  205. }
  206. #endif