keymap.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  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 3
  17. #define _COLEMAK 4
  18. #define _DVORAK 5
  19. #define _LOWER 6
  20. #define _RAISE 7
  21. #define _PLOVER 8
  22. #define _ADJUST 16
  23. enum planck_keycodes {
  24. QWERTY = SAFE_RANGE,
  25. COLEMAK,
  26. DVORAK,
  27. PLOVER,
  28. LOWER,
  29. RAISE,
  30. BACKLIT,
  31. EXT_PLV
  32. };
  33. // Fillers to make layering more clear
  34. #define _______ KC_TRNS
  35. #define XXXXXXX KC_NO
  36. const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  37. /* Alpha-numeric
  38. ,-----------------------------------------------------------------------------------------------.
  39. | Q | D | R | W | B | F | U | P | J | 7 | 8 | 9 |
  40. |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  41. | A | S | H | T | G | N | E | O | I | 4 | 5 | 6 |
  42. |-------+-------+-------+-------+-------+-------|-------+-------+-------+-------+-------+-------|
  43. | Z | X | M | C | V | L | Y | K | Up | 1 | 2 | 3 |
  44. |-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------|
  45. |Alt/Tab|Gui/Esc| , |CTL/Bsp| Fn/Ent|SFT/SPC| . | Left | Down | Right | 0 | / |
  46. `-----------------------------------------------------------------------------------------------'
  47. */
  48. [_ALPHA] = {
  49. {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},
  50. {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},
  51. {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},
  52. {ALT_T(KC_TAB), GUI_T(KC_ESC), KC_COMM, CTL_T(KC_BSPC), LT(_FN, KC_ENTER), SFT_T(KC_SPC), KC_DOT,
  53. KC_LEFT, KC_DOWN, KC_RGHT, KC_KP_0, KC_SLASH}
  54. },
  55. [_FN] = {
  56. {KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_FN12, KC_FN7, KC_FN8, KC_FN9},
  57. {KC_CAPSLOCK, KC_LBRACKET, KC_RBRACKET, KC_MINUS, KC_DELETE, KC_EQUAL, KC_LPRN, KC_RPRN, KC_FN11, KC_FN4, KC_FN5, KC_FN6},
  58. {RESET, KC_INS, KC_PSCR, KC_SLCK, KC_PAUSE, KC_NUMLOCK, KC_MENU, XXXXXXX, KC_PGUP, KC_FN1, KC_FN2, KC_FN3},
  59. {_______, _______, KC_GRAVE, _______, _______, _______, KC_SCOLON, KC_HOME, KC_PGDN, KC_END, KC_FN10, KC_BSLASH}
  60. },
  61. /* Qwerty
  62. * ,-----------------------------------------------------------------------------------.
  63. * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
  64. * |------+------+------+------+------+-------------+------+------+------+------+------|
  65. * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
  66. * |------+------+------+------+------+------|------+------+------+------+------+------|
  67. * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
  68. * |------+------+------+------+------+------+------+------+------+------+------+------|
  69. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  70. * `-----------------------------------------------------------------------------------'
  71. */
  72. [_QWERTY] = {
  73. {KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC},
  74. {KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
  75. {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
  76. {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
  77. },
  78. /* Colemak
  79. * ,-----------------------------------------------------------------------------------.
  80. * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
  81. * |------+------+------+------+------+-------------+------+------+------+------+------|
  82. * | Esc | A | R | S | T | D | H | N | E | I | O | " |
  83. * |------+------+------+------+------+------|------+------+------+------+------+------|
  84. * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
  85. * |------+------+------+------+------+------+------+------+------+------+------+------|
  86. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  87. * `-----------------------------------------------------------------------------------'
  88. */
  89. [_COLEMAK] = {
  90. {KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC},
  91. {KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT},
  92. {KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT },
  93. {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
  94. },
  95. /* Dvorak
  96. * ,-----------------------------------------------------------------------------------.
  97. * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
  98. * |------+------+------+------+------+-------------+------+------+------+------+------|
  99. * | Esc | A | O | E | U | I | D | H | T | N | S | / |
  100. * |------+------+------+------+------+------|------+------+------+------+------+------|
  101. * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
  102. * |------+------+------+------+------+------+------+------+------+------+------+------|
  103. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  104. * `-----------------------------------------------------------------------------------'
  105. */
  106. [_DVORAK] = {
  107. {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC},
  108. {KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH},
  109. {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT },
  110. {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
  111. },
  112. /* Lower
  113. * ,-----------------------------------------------------------------------------------.
  114. * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
  115. * |------+------+------+------+------+-------------+------+------+------+------+------|
  116. * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
  117. * |------+------+------+------+------+------|------+------+------+------+------+------|
  118. * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | | |Enter |
  119. * |------+------+------+------+------+------+------+------+------+------+------+------|
  120. * | | | | | | | | Next | Vol- | Vol+ | Play |
  121. * `-----------------------------------------------------------------------------------'
  122. */
  123. [_LOWER] = {
  124. {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
  125. {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
  126. {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,S(KC_NUHS),S(KC_NUBS),_______, _______, _______},
  127. {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  128. },
  129. /* Raise
  130. * ,-----------------------------------------------------------------------------------.
  131. * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
  132. * |------+------+------+------+------+-------------+------+------+------+------+------|
  133. * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
  134. * |------+------+------+------+------+------|------+------+------+------+------+------|
  135. * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / | | |Enter |
  136. * |------+------+------+------+------+------+------+------+------+------+------+------|
  137. * | | | | | | | | Next | Vol- | Vol+ | Play |
  138. * `-----------------------------------------------------------------------------------'
  139. */
  140. [_RAISE] = {
  141. {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
  142. {KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
  143. {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, _______, _______, _______},
  144. {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
  145. },
  146. /* Plover layer (http://opensteno.org)
  147. * ,-----------------------------------------------------------------------------------.
  148. * | # | # | # | # | # | # | # | # | # | # | # | # |
  149. * |------+------+------+------+------+-------------+------+------+------+------+------|
  150. * | | S | T | P | H | * | * | F | P | L | T | D |
  151. * |------+------+------+------+------+------|------+------+------+------+------+------|
  152. * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
  153. * |------+------+------+------+------+------+------+------+------+------+------+------|
  154. * | Exit | | | A | O | | E | U | | | |
  155. * `-----------------------------------------------------------------------------------'
  156. */
  157. [_PLOVER] = {
  158. {KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 },
  159. {XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC},
  160. {XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
  161. {EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX}
  162. },
  163. /* Adjust (Lower + Raise)
  164. * ,-----------------------------------------------------------------------------------.
  165. * | | Reset| | | | | | | | | | Del |
  166. * |------+------+------+------+------+-------------+------+------+------+------+------|
  167. * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
  168. * |------+------+------+------+------+------|------+------+------+------+------+------|
  169. * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
  170. * |------+------+------+------+------+------+------+------+------+------+------+------|
  171. * | | | | | | | | | | | |
  172. * `-----------------------------------------------------------------------------------'
  173. */
  174. [_ADJUST] = {
  175. {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
  176. {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______},
  177. {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
  178. {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
  179. }
  180. };
  181. #ifdef AUDIO_ENABLE
  182. float tone_startup[][2] = SONG(STARTUP_SOUND);
  183. float tone_qwerty[][2] = SONG(QWERTY_SOUND);
  184. float tone_dvorak[][2] = SONG(DVORAK_SOUND);
  185. float tone_colemak[][2] = SONG(COLEMAK_SOUND);
  186. float tone_plover[][2] = SONG(PLOVER_SOUND);
  187. float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
  188. float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
  189. float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
  190. #endif
  191. void persistant_default_layer_set(uint16_t default_layer) {
  192. eeconfig_update_default_layer(default_layer);
  193. default_layer_set(default_layer);
  194. }
  195. bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  196. switch (keycode) {
  197. case QWERTY:
  198. if (record->event.pressed) {
  199. #ifdef AUDIO_ENABLE
  200. PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
  201. #endif
  202. persistant_default_layer_set(1UL<<_QWERTY);
  203. }
  204. return false;
  205. break;
  206. case COLEMAK:
  207. if (record->event.pressed) {
  208. #ifdef AUDIO_ENABLE
  209. PLAY_NOTE_ARRAY(tone_colemak, false, 0);
  210. #endif
  211. persistant_default_layer_set(1UL<<_COLEMAK);
  212. }
  213. return false;
  214. break;
  215. case DVORAK:
  216. if (record->event.pressed) {
  217. #ifdef AUDIO_ENABLE
  218. PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
  219. #endif
  220. persistant_default_layer_set(1UL<<_DVORAK);
  221. }
  222. return false;
  223. break;
  224. case LOWER:
  225. if (record->event.pressed) {
  226. layer_on(_LOWER);
  227. update_tri_layer(_LOWER, _RAISE, _ADJUST);
  228. } else {
  229. layer_off(_LOWER);
  230. update_tri_layer(_LOWER, _RAISE, _ADJUST);
  231. }
  232. return false;
  233. break;
  234. case RAISE:
  235. if (record->event.pressed) {
  236. layer_on(_RAISE);
  237. update_tri_layer(_LOWER, _RAISE, _ADJUST);
  238. } else {
  239. layer_off(_RAISE);
  240. update_tri_layer(_LOWER, _RAISE, _ADJUST);
  241. }
  242. return false;
  243. break;
  244. case BACKLIT:
  245. if (record->event.pressed) {
  246. register_code(KC_RSFT);
  247. #ifdef BACKLIGHT_ENABLE
  248. backlight_step();
  249. #endif
  250. } else {
  251. unregister_code(KC_RSFT);
  252. }
  253. return false;
  254. break;
  255. case PLOVER:
  256. if (record->event.pressed) {
  257. #ifdef AUDIO_ENABLE
  258. stop_all_notes();
  259. PLAY_NOTE_ARRAY(tone_plover, false, 0);
  260. #endif
  261. layer_off(_RAISE);
  262. layer_off(_LOWER);
  263. layer_off(_ADJUST);
  264. layer_on(_PLOVER);
  265. if (!eeconfig_is_enabled()) {
  266. eeconfig_init();
  267. }
  268. keymap_config.raw = eeconfig_read_keymap();
  269. keymap_config.nkro = 1;
  270. eeconfig_update_keymap(keymap_config.raw);
  271. }
  272. return false;
  273. break;
  274. case EXT_PLV:
  275. if (record->event.pressed) {
  276. #ifdef AUDIO_ENABLE
  277. PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
  278. #endif
  279. layer_off(_PLOVER);
  280. }
  281. return false;
  282. break;
  283. }
  284. return true;
  285. }
  286. void matrix_init_user(void) {
  287. #ifdef AUDIO_ENABLE
  288. startup_user();
  289. #endif
  290. }
  291. #ifdef AUDIO_ENABLE
  292. void startup_user()
  293. {
  294. _delay_ms(20); // gets rid of tick
  295. PLAY_NOTE_ARRAY(tone_startup, false, 0);
  296. }
  297. void shutdown_user()
  298. {
  299. PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
  300. _delay_ms(150);
  301. stop_all_notes();
  302. }
  303. void music_on_user(void)
  304. {
  305. music_scale_user();
  306. }
  307. void music_scale_user(void)
  308. {
  309. PLAY_NOTE_ARRAY(music_scale, false, 0);
  310. }
  311. #endif