keymap.c 11 KB

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