You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

363 lines
15 KiB

  1. /* Copyright 2015-2017 Jack Humbert
  2. *
  3. * This program is free software: you can redistribute it and/or modify
  4. * it under the terms of the GNU General Public License as published by
  5. * the Free Software Foundation, either version 2 of the License, or
  6. * (at your option) any later version.
  7. *
  8. * This program is distributed in the hope that it will be useful,
  9. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. * GNU General Public License for more details.
  12. *
  13. * You should have received a copy of the GNU General Public License
  14. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. #include QMK_KEYBOARD_H
  17. #include "muse.h"
  18. enum planck_layers {
  19. _QWERTY,
  20. _COLEMAK,
  21. _DVORAK,
  22. _LOWER,
  23. _RAISE,
  24. _PLOVER,
  25. _ADJUST,
  26. _NAV,
  27. };
  28. enum planck_keycodes {
  29. QWERTY = SAFE_RANGE,
  30. COLEMAK,
  31. DVORAK,
  32. PLOVER,
  33. BACKLIT,
  34. EXT_PLV
  35. };
  36. #define LOWER MO(_LOWER)
  37. #define RAISE MO(_RAISE)
  38. #define NAV MO(_NAV)
  39. const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  40. // clang-format off
  41. /* Qwerty
  42. * ,-----------------------------------------------------------------------------------.
  43. * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
  44. * |------+------+------+------+------+------+------+------+------+------+------+------|
  45. * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
  46. * |------+------+------+------+------+------+------+------+------+------+------+------|
  47. * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
  48. * |------+------+------+------+------+------+------+------+------+------+------+------|
  49. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  50. * `-----------------------------------------------------------------------------------'
  51. */
  52. [_QWERTY] = LAYOUT_planck_grid(
  53. KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
  54. LCTL_T(KC_ESC), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
  55. KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, RSFT_T(KC_ENT),
  56. BACKLIT, KC_LCTL, KC_LGUI, KC_LALT, LOWER, LT(_NAV, KC_SPC), KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
  57. ),
  58. /* Colemak
  59. * ,-----------------------------------------------------------------------------------.
  60. * | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
  61. * |------+------+------+------+------+------+------+------+------+------+------+------|
  62. * | Esc | A | R | S | T | D | H | N | E | I | O | " |
  63. * |------+------+------+------+------+------+------+------+------+------+------+------|
  64. * | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
  65. * |------+------+------+------+------+------+------+------+------+------+------+------|
  66. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  67. * `-----------------------------------------------------------------------------------'
  68. */
  69. [_COLEMAK] = LAYOUT_planck_grid(
  70. KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
  71. KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
  72. KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
  73. BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
  74. ),
  75. /* Dvorak
  76. * ,-----------------------------------------------------------------------------------.
  77. * | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
  78. * |------+------+------+------+------+------+------+------+------+------+------+------|
  79. * | Esc | A | O | E | U | I | D | H | T | N | S | / |
  80. * |------+------+------+------+------+------+------+------+------+------+------+------|
  81. * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
  82. * |------+------+------+------+------+------+------+------+------+------+------+------|
  83. * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
  84. * `-----------------------------------------------------------------------------------'
  85. */
  86. [_DVORAK] = LAYOUT_planck_grid(
  87. KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC,
  88. KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH,
  89. KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT ,
  90. BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
  91. ),
  92. /* Lower
  93. * ,-----------------------------------------------------------------------------------.
  94. * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
  95. * |------+------+------+------+------+------+------+------+------+------+------+------|
  96. * | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
  97. * |------+------+------+------+------+------+------+------+------+------+------+------|
  98. * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
  99. * |------+------+------+------+------+------+------+------+------+------+------+------|
  100. * | | | | | | | | Next | Vol- | Vol+ | Play |
  101. * `-----------------------------------------------------------------------------------'
  102. */
  103. [_LOWER] = LAYOUT_planck_grid(
  104. KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
  105. KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
  106. _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______,
  107. _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
  108. ),
  109. /* Raise
  110. * ,-----------------------------------------------------------------------------------.
  111. * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
  112. * |------+------+------+------+------+------+------+------+------+------+------+------|
  113. * | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
  114. * |------+------+------+------+------+------+------+------+------+------+------+------|
  115. * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
  116. * |------+------+------+------+------+------+------+------+------+------+------+------|
  117. * | | | | | | | | Next | Vol- | Vol+ | Play |
  118. * `-----------------------------------------------------------------------------------'
  119. */
  120. [_RAISE] = LAYOUT_planck_grid(
  121. KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
  122. KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
  123. _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______,
  124. _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
  125. ),
  126. /* Plover layer (http://opensteno.org)
  127. * ,-----------------------------------------------------------------------------------.
  128. * | # | # | # | # | # | # | # | # | # | # | # | # |
  129. * |------+------+------+------+------+------+------+------+------+------+------+------|
  130. * | | S | T | P | H | * | * | F | P | L | T | D |
  131. * |------+------+------+------+------+------+------+------+------+------+------+------|
  132. * | | S | K | W | R | * | * | R | B | G | S | Z |
  133. * |------+------+------+------+------+------+------+------+------+------+------+------|
  134. * | Exit | | | A | O | | E | U | | | |
  135. * `-----------------------------------------------------------------------------------'
  136. */
  137. [_PLOVER] = LAYOUT_planck_grid(
  138. KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
  139. XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
  140. XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
  141. EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX
  142. ),
  143. /* Adjust (Lower + Raise)
  144. * v------------------------RGB CONTROL--------------------v
  145. * ,-----------------------------------------------------------------------------------.
  146. * | | Reset|Debug | RGB |RGBMOD| HUE+ | HUE- | SAT+ | SAT- |BRGTH+|BRGTH-| Del |
  147. * |------+------+------+------+------+------+------+------+------+------+------+------|
  148. * | | |MUSmod|Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| |
  149. * |------+------+------+------+------+------+------+------+------+------+------+------|
  150. * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|TermOn|TermOf| | | |
  151. * |------+------+------+------+------+------+------+------+------+------+------+------|
  152. * | | | | | | | | | | | |
  153. * `-----------------------------------------------------------------------------------'
  154. */
  155. [_ADJUST] = LAYOUT_planck_grid(
  156. _______, RESET, DEBUG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL ,
  157. _______, _______, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______,
  158. _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, TERM_ON, TERM_OFF, _______, _______, _______,
  159. _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
  160. ),
  161. [_NAV] = LAYOUT_planck_grid(
  162. XXXXXXX, XXXXXXX, XXXXXXX, KC_MS_UP, XXXXXXX, KC_MS_WH_UP, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
  163. XXXXXXX, XXXXXXX, KC_MS_LEFT, KC_MS_DOWN, KC_MS_RIGHT, KC_MS_WH_DOWN, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT, XXXXXXX, XXXXXXX,
  164. XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_MS_BTN1, KC_MS_BTN3, KC_MS_BTN2, XXXXXXX, XXXXXXX,
  165. XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
  166. )
  167. };
  168. // clang-format on
  169. #ifdef AUDIO_ENABLE
  170. float plover_song[][2] = SONG(PLOVER_SOUND);
  171. float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
  172. #endif
  173. layer_state_t layer_state_set_user(layer_state_t state) {
  174. return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
  175. }
  176. bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  177. switch (keycode) {
  178. case QWERTY:
  179. if (record->event.pressed) {
  180. print("mode just switched to qwerty and this is a huge string\n");
  181. set_single_persistent_default_layer(_QWERTY);
  182. }
  183. return false;
  184. break;
  185. case COLEMAK:
  186. if (record->event.pressed) {
  187. set_single_persistent_default_layer(_COLEMAK);
  188. }
  189. return false;
  190. break;
  191. case DVORAK:
  192. if (record->event.pressed) {
  193. set_single_persistent_default_layer(_DVORAK);
  194. }
  195. return false;
  196. break;
  197. case BACKLIT:
  198. if (record->event.pressed) {
  199. register_code(KC_RSFT);
  200. #ifdef BACKLIGHT_ENABLE
  201. backlight_step();
  202. #endif
  203. #ifdef KEYBOARD_planck_rev5
  204. writePinLow(E6);
  205. #endif
  206. } else {
  207. unregister_code(KC_RSFT);
  208. #ifdef KEYBOARD_planck_rev5
  209. writePinHigh(E6);
  210. #endif
  211. }
  212. return false;
  213. break;
  214. case PLOVER:
  215. if (record->event.pressed) {
  216. #ifdef AUDIO_ENABLE
  217. stop_all_notes();
  218. PLAY_SONG(plover_song);
  219. #endif
  220. layer_off(_RAISE);
  221. layer_off(_LOWER);
  222. layer_off(_ADJUST);
  223. layer_on(_PLOVER);
  224. if (!eeconfig_is_enabled()) {
  225. eeconfig_init();
  226. }
  227. keymap_config.raw = eeconfig_read_keymap();
  228. keymap_config.nkro = 1;
  229. eeconfig_update_keymap(keymap_config.raw);
  230. }
  231. return false;
  232. break;
  233. case EXT_PLV:
  234. if (record->event.pressed) {
  235. #ifdef AUDIO_ENABLE
  236. PLAY_SONG(plover_gb_song);
  237. #endif
  238. layer_off(_PLOVER);
  239. }
  240. return false;
  241. break;
  242. }
  243. return true;
  244. }
  245. bool muse_mode = false;
  246. uint8_t last_muse_note = 0;
  247. uint16_t muse_counter = 0;
  248. uint8_t muse_offset = 70;
  249. uint16_t muse_tempo = 50;
  250. bool encoder_update_user(uint8_t index, bool clockwise) {
  251. if (muse_mode) {
  252. if (IS_LAYER_ON(_RAISE)) {
  253. if (clockwise) {
  254. muse_offset++;
  255. } else {
  256. muse_offset--;
  257. }
  258. } else {
  259. if (clockwise) {
  260. muse_tempo+=1;
  261. } else {
  262. muse_tempo-=1;
  263. }
  264. }
  265. } else {
  266. if (clockwise) {
  267. #ifdef MOUSEKEY_ENABLE
  268. tap_code(KC_MS_WH_DOWN);
  269. #else
  270. tap_code(KC_PGDN);
  271. #endif
  272. } else {
  273. #ifdef MOUSEKEY_ENABLE
  274. tap_code(KC_MS_WH_UP);
  275. #else
  276. tap_code(KC_PGUP);
  277. #endif
  278. }
  279. }
  280. return true;
  281. }
  282. bool dip_switch_update_user(uint8_t index, bool active) {
  283. switch (index) {
  284. case 0: {
  285. #ifdef AUDIO_ENABLE
  286. static bool play_sound = false;
  287. #endif
  288. if (active) {
  289. #ifdef AUDIO_ENABLE
  290. if (play_sound) { PLAY_SONG(plover_song); }
  291. #endif
  292. layer_on(_ADJUST);
  293. } else {
  294. #ifdef AUDIO_ENABLE
  295. if (play_sound) { PLAY_SONG(plover_gb_song); }
  296. #endif
  297. layer_off(_ADJUST);
  298. }
  299. #ifdef AUDIO_ENABLE
  300. play_sound = true;
  301. #endif
  302. break;
  303. }
  304. case 1:
  305. if (active) {
  306. muse_mode = true;
  307. } else {
  308. muse_mode = false;
  309. }
  310. }
  311. return true;
  312. }
  313. void matrix_scan_user(void) {
  314. #ifdef AUDIO_ENABLE
  315. if (muse_mode) {
  316. if (muse_counter == 0) {
  317. uint8_t muse_note = muse_offset + SCALE[muse_clock_pulse()];
  318. if (muse_note != last_muse_note) {
  319. stop_note(compute_freq_for_midi_note(last_muse_note));
  320. play_note(compute_freq_for_midi_note(muse_note), 0xF);
  321. last_muse_note = muse_note;
  322. }
  323. }
  324. muse_counter = (muse_counter + 1) % muse_tempo;
  325. } else {
  326. if (muse_counter) {
  327. stop_all_notes();
  328. muse_counter = 0;
  329. }
  330. }
  331. #endif
  332. }
  333. bool music_mask_user(uint16_t keycode) {
  334. switch (keycode) {
  335. case RAISE:
  336. case LOWER:
  337. return false;
  338. default:
  339. return true;
  340. }
  341. }