keymap.c 13 KB

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