2
0

keymap.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  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. /* Symbols (FN 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. /* Colemak
  84. * ,-----------------------------------------------------------------------------------.
  85. * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
  86. * |------+------+------+------+------+-------------+------+------+------+------+------|
  87. * | Esc | A | R | S | T | D | H | N | E | I | O | " |
  88. * |------+------+------+------+------+------|------+------+------+------+------+------|
  89. * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
  90. * |------+------+------+------+------+------+------+------+------+------+------+------|
  91. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  92. * `-----------------------------------------------------------------------------------'
  93. */
  94. [_COLEMAK] = {
  95. {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
  96. {KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
  97. {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
  98. {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
  99. },
  100. /* Dvorak
  101. * ,-----------------------------------------------------------------------------------.
  102. * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
  103. * |------+------+------+------+------+-------------+------+------+------+------+------|
  104. * | Esc | A | O | E | U | I | D | H | T | N | S | / |
  105. * |------+------+------+------+------+------|------+------+------+------+------+------|
  106. * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
  107. * |------+------+------+------+------+------+------+------+------+------+------+------|
  108. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  109. * `-----------------------------------------------------------------------------------'
  110. */
  111. [_DVORAK] = {
  112. {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
  113. {KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
  114. {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT },
  115. {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
  116. },
  117. /* Lower
  118. * ,-----------------------------------------------------------------------------------.
  119. * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
  120. * |------+------+------+------+------+-------------+------+------+------+------+------|
  121. * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
  122. * |------+------+------+------+------+------|------+------+------+------+------+------|
  123. * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | |Enter |
  124. * |------+------+------+------+------+------+------+------+------+------+------+------|
  125. * | | | | | | | | Next | Vol- | Vol+ | Play |
  126. * `-----------------------------------------------------------------------------------'
  127. */
  128. [_LOWER] = {
  129. {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
  130. {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
  131. {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
  132. {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  133. },
  134. /* Raise
  135. * ,-----------------------------------------------------------------------------------.
  136. * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
  137. * |------+------+------+------+------+-------------+------+------+------+------+------|
  138. * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
  139. * |------+------+------+------+------+------|------+------+------+------+------+------|
  140. * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / | | |Enter |
  141. * |------+------+------+------+------+------+------+------+------+------+------+------|
  142. * | | | | | | | | Next | Vol- | Vol+ | Play |
  143. * `-----------------------------------------------------------------------------------'
  144. */
  145. [_RAISE] = {
  146. {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
  147. {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
  148. {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, _______, _______, _______},
  149. {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  150. },
  151. /* Plover layer (http://opensteno.org)
  152. * ,-----------------------------------------------------------------------------------.
  153. * | # | # | # | # | # | # | # | # | # | # | # | # |
  154. * |------+------+------+------+------+-------------+------+------+------+------+------|
  155. * | | S | T | P | H | * | * | F | P | L | T | D |
  156. * |------+------+------+------+------+------|------+------+------+------+------+------|
  157. * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
  158. * |------+------+------+------+------+------+------+------+------+------+------+------|
  159. * | Exit | | | A | O | | E | U | | | |
  160. * `-----------------------------------------------------------------------------------'
  161. */
  162. [_PLOVER] = {
  163. {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
  164. {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
  165. {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
  166. {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
  167. },
  168. /* Adjust (Lower + Raise)
  169. * ,-----------------------------------------------------------------------------------.
  170. * | | Reset| | | | | | | | | | Del |
  171. * |------+------+------+------+------+-------------+------+------+------+------+------|
  172. * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
  173. * |------+------+------+------+------+------|------+------+------+------+------+------|
  174. * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
  175. * |------+------+------+------+------+------+------+------+------+------+------+------|
  176. * | | | | | | | | | | | |
  177. * `-----------------------------------------------------------------------------------'
  178. */
  179. [_ADJUST] = {
  180. {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
  181. {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
  182. {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
  183. {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
  184. }
  185. };
  186. #ifdef AUDIO_ENABLE
  187. float tone_startup[][2] = SONG(STARTUP_SOUND);
  188. float tone_qwerty[][2] = SONG(QWERTY_SOUND);
  189. float tone_dvorak[][2] = SONG(DVORAK_SOUND);
  190. float tone_colemak[][2] = SONG(COLEMAK_SOUND);
  191. float tone_plover[][2] = SONG(PLOVER_SOUND);
  192. float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
  193. float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
  194. float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
  195. #endif
  196. void persistant_default_layer_set(uint16_t default_layer) {
  197. eeconfig_update_default_layer(default_layer);
  198. default_layer_set(default_layer);
  199. }
  200. bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  201. switch (keycode) {
  202. case QWERTY:
  203. if (record->event.pressed) {
  204. #ifdef AUDIO_ENABLE
  205. PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
  206. #endif
  207. persistant_default_layer_set(1UL<<_QWERTY);
  208. }
  209. return false;
  210. break;
  211. case BACKLIT:
  212. if (record->event.pressed) {
  213. register_code(KC_RSFT);
  214. #ifdef BACKLIGHT_ENABLE
  215. backlight_step();
  216. #endif
  217. } else {
  218. unregister_code(KC_RSFT);
  219. }
  220. return false;
  221. break;
  222. case PLOVER:
  223. if (record->event.pressed) {
  224. #ifdef AUDIO_ENABLE
  225. stop_all_notes();
  226. PLAY_NOTE_ARRAY(tone_plover, false, 0);
  227. #endif
  228. layer_off(_RAISE);
  229. layer_off(_LOWER);
  230. layer_off(_ADJUST);
  231. layer_on(_PLOVER);
  232. if (!eeconfig_is_enabled()) {
  233. eeconfig_init();
  234. }
  235. keymap_config.raw = eeconfig_read_keymap();
  236. keymap_config.nkro = 1;
  237. eeconfig_update_keymap(keymap_config.raw);
  238. }
  239. return false;
  240. break;
  241. case EXT_PLV:
  242. if (record->event.pressed) {
  243. #ifdef AUDIO_ENABLE
  244. PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
  245. #endif
  246. layer_off(_PLOVER);
  247. }
  248. return false;
  249. break;
  250. }
  251. return true;
  252. }
  253. void matrix_init_user(void) {
  254. #ifdef AUDIO_ENABLE
  255. startup_user();
  256. #endif
  257. }
  258. #ifdef AUDIO_ENABLE
  259. void startup_user()
  260. {
  261. _delay_ms(20); // gets rid of tick
  262. PLAY_NOTE_ARRAY(tone_startup, false, 0);
  263. }
  264. void shutdown_user()
  265. {
  266. PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
  267. _delay_ms(150);
  268. stop_all_notes();
  269. }
  270. void music_on_user(void)
  271. {
  272. music_scale_user();
  273. }
  274. void music_scale_user(void)
  275. {
  276. PLAY_NOTE_ARRAY(music_scale, false, 0);
  277. }
  278. #endif