keymap.c 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  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 _ALPHA 0
  15. #define _FN 1
  16. #define _QWERTY 2
  17. #define _PLOVER 3
  18. #define _ADJUST 4
  19. enum planck_keycodes {
  20. QWERTY = SAFE_RANGE,
  21. PLOVER,
  22. LOWER,
  23. RAISE,
  24. BACKLIT,
  25. EXT_PLV
  26. };
  27. // Fillers to make layering more clear
  28. #define _______ KC_TRNS
  29. #define XXXXXXX KC_NO
  30. const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  31. /* Alpha-numeric
  32. ,-----------------------------------------------------------------------------------------------.
  33. | Q | D | R | W | B | F | U | P | J | 7 | 8 | 9 |
  34. |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  35. | A | S | H | T | G | N | E | O | I | 4 | 5 | 6 |
  36. |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  37. | Z | X | M | C | V | L | Y | K | Up | 1 | 2 | 3 |
  38. |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  39. |Alt/Tab|Gui/Esc| , |CTL/Bsp| Fn/Ent|SFT/SPC| . | Left | Down | Right | 0 | / |
  40. `-----------------------------------------------------------------------------------------------'
  41. */
  42. [_ALPHA] = {
  43. {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},
  44. {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},
  45. {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},
  46. {ALT_T(KC_TAB), GUI_T(KC_ESC), KC_COMM, CTL_T(KC_BSPC), LT(_FN, KC_ENTER), SFT_T(KC_SPC), KC_DOT,
  47. KC_LEFT, KC_DOWN, KC_RGHT, KC_KP_0, KC_SLASH}
  48. },
  49. /* FN-key held
  50. ,-----------------------------------------------------------------------------------------------.
  51. | ! | @ | # | $ | % | ^ | & | * | F12 | F7 | F8 | F9 |
  52. |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  53. | Caps | [ | ] | - | Del | = | ( | ) | F11 | F4 | F5 | F6 |
  54. |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  55. | DFU | Insert| PrtSc | ScrLk | Pause | NumLk | Menu | | PgUp | F1 | F2 | F3 |
  56. |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  57. |Alt/Tab|Gui/Esc| ` |CTL/Bsp| Fn/Ent|SFT/SPC| ; | Home | PgDn | End | F10 | / |
  58. `-----------------------------------------------------------------------------------------------'
  59. */
  60. [_FN] = {
  61. {KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_FN12, KC_FN7, KC_FN8, KC_FN9},
  62. {KC_CAPSLOCK, KC_LBRACKET, KC_RBRACKET, KC_MINUS, KC_DELETE, KC_EQUAL, KC_LPRN, KC_RPRN, KC_FN11, KC_FN4, KC_FN5, KC_FN6},
  63. {RESET, KC_INS, KC_PSCR, KC_SLCK, KC_PAUSE, KC_NUMLOCK, KC_MENU, XXXXXXX, KC_PGUP, KC_FN1, KC_FN2, KC_FN3},
  64. {_______, _______, KC_GRAVE, _______, _______, _______, KC_SCOLON, KC_HOME, KC_PGDN, KC_END, KC_FN10, KC_BSLASH}
  65. },
  66. /* Qwerty
  67. * ,-----------------------------------------------------------------------------------.
  68. * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
  69. * |------+------+------+------+------+-------------+------+------+------+------+------|
  70. * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
  71. * |------+------+------+------+------+------|------+------+------+------+------+------|
  72. * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
  73. * |------+------+------+------+------+------+------+------+------+------+------+------|
  74. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  75. * `-----------------------------------------------------------------------------------'
  76. */
  77. [_QWERTY] = {
  78. {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
  79. {KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
  80. {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
  81. {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
  82. },
  83. /* Plover layer (http://opensteno.org)
  84. * ,-----------------------------------------------------------------------------------.
  85. * | # | # | # | # | # | # | # | # | # | # | # | # |
  86. * |------+------+------+------+------+-------------+------+------+------+------+------|
  87. * | | S | T | P | H | * | * | F | P | L | T | D |
  88. * |------+------+------+------+------+------|------+------+------+------+------+------|
  89. * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
  90. * |------+------+------+------+------+------+------+------+------+------+------+------|
  91. * | Exit | | | A | O | | E | U | | | |
  92. * `-----------------------------------------------------------------------------------'
  93. */
  94. [_PLOVER] = {
  95. {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
  96. {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
  97. {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
  98. {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
  99. },
  100. /* Adjust (Lower + Raise)
  101. * ,-----------------------------------------------------------------------------------.
  102. * | | Reset| | | | | | | | | | Del |
  103. * |------+------+------+------+------+-------------+------+------+------+------+------|
  104. * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
  105. * |------+------+------+------+------+------|------+------+------+------+------+------|
  106. * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
  107. * |------+------+------+------+------+------+------+------+------+------+------+------|
  108. * | | | | | | | | | | | |
  109. * `-----------------------------------------------------------------------------------'
  110. */
  111. [_ADJUST] = {
  112. {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
  113. {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
  114. {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
  115. {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
  116. }
  117. };
  118. #ifdef AUDIO_ENABLE
  119. float tone_startup[][2] = SONG(STARTUP_SOUND);
  120. float tone_qwerty[][2] = SONG(QWERTY_SOUND);
  121. float tone_plover[][2] = SONG(PLOVER_SOUND);
  122. float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
  123. float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
  124. float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
  125. #endif
  126. void persistant_default_layer_set(uint16_t default_layer) {
  127. eeconfig_update_default_layer(default_layer);
  128. default_layer_set(default_layer);
  129. }
  130. bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  131. switch (keycode) {
  132. case QWERTY:
  133. if (record->event.pressed) {
  134. #ifdef AUDIO_ENABLE
  135. PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
  136. #endif
  137. persistant_default_layer_set(1UL<<_QWERTY);
  138. }
  139. return false;
  140. break;
  141. case BACKLIT:
  142. if (record->event.pressed) {
  143. register_code(KC_RSFT);
  144. #ifdef BACKLIGHT_ENABLE
  145. backlight_step();
  146. #endif
  147. } else {
  148. unregister_code(KC_RSFT);
  149. }
  150. return false;
  151. break;
  152. case PLOVER:
  153. if (record->event.pressed) {
  154. #ifdef AUDIO_ENABLE
  155. stop_all_notes();
  156. PLAY_NOTE_ARRAY(tone_plover, false, 0);
  157. #endif
  158. layer_off(_RAISE);
  159. layer_off(_LOWER);
  160. layer_off(_ADJUST);
  161. layer_on(_PLOVER);
  162. if (!eeconfig_is_enabled()) {
  163. eeconfig_init();
  164. }
  165. keymap_config.raw = eeconfig_read_keymap();
  166. keymap_config.nkro = 1;
  167. eeconfig_update_keymap(keymap_config.raw);
  168. }
  169. return false;
  170. break;
  171. case EXT_PLV:
  172. if (record->event.pressed) {
  173. #ifdef AUDIO_ENABLE
  174. PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
  175. #endif
  176. layer_off(_PLOVER);
  177. }
  178. return false;
  179. break;
  180. }
  181. return true;
  182. }
  183. void matrix_init_user(void) {
  184. #ifdef AUDIO_ENABLE
  185. startup_user();
  186. #endif
  187. }
  188. #ifdef AUDIO_ENABLE
  189. void startup_user()
  190. {
  191. _delay_ms(20); // gets rid of tick
  192. PLAY_NOTE_ARRAY(tone_startup, false, 0);
  193. }
  194. void shutdown_user()
  195. {
  196. PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
  197. _delay_ms(150);
  198. stop_all_notes();
  199. }
  200. void music_on_user(void)
  201. {
  202. music_scale_user();
  203. }
  204. void music_scale_user(void)
  205. {
  206. PLAY_NOTE_ARRAY(music_scale, false, 0);
  207. }
  208. #endif