keymap.c 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. #include QMK_KEYBOARD_H
  2. #ifdef BACKLIGHT_ENABLE
  3. #include "flicker.h"
  4. #endif
  5. extern keymap_config_t keymap_config;
  6. // Each layer gets a name for readability, which is then used in the keymap matrix below.
  7. // The underscores don't mean anything - you can have a layer called STUFF or any other name.
  8. // Layer names don't all need to be of the same length, obviously, and you can also skip them
  9. // entirely and just use numbers.
  10. enum planck_layers {
  11. _QWERTY,
  12. _LOWER,
  13. _RAISE,
  14. _ADJUST
  15. };
  16. // keycodes custom to this keymap:
  17. enum planck_keycodes {
  18. QWERTY = SAFE_RANGE,
  19. BL_FLICKER
  20. };
  21. // flicker state:
  22. #ifdef BACKLIGHT_ENABLE
  23. bool flicker_enable = true;
  24. bool flicker_isdown = false;
  25. const uint8_t flicker_min_levels = 2;
  26. const uint8_t flicker_max_levels = 7;
  27. uint8_t flicker_restore_level = 0;
  28. #endif
  29. #define LOWER MO(_LOWER)
  30. #define RAISE MO(_RAISE)
  31. // mod tap definitions:
  32. #define CTRL_ESC MT(MOD_LCTL, KC_ESC)
  33. #define HYPR_SPC MT(MOD_HYPR, KC_SPC)
  34. const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  35. /* Qwerty
  36. * ,-----------------------------------------------------------------------------------.
  37. * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
  38. * |------+------+------+------+------+-------------+------+------+------+------+------|
  39. * | Ctrl | A | S | D | F | G | H | J | K | L | ; | ' |
  40. * |------+------+------+------+------+------|------+------+------+------+------+------|
  41. * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
  42. * |------+------+------+------+------+------+------+------+------+------+------+------|
  43. * | Esc | Del | GUI | Alt |Lower |HyprSp|Space |Raise | Left | Down | Up |Right |
  44. * `-----------------------------------------------------------------------------------'
  45. */
  46. [_QWERTY] = LAYOUT_ortho_4x12(
  47. KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, \
  48. CTRL_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, \
  49. KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT , \
  50. KC_MPLY, KC_DEL, KC_LGUI, KC_LALT, LOWER, HYPR_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT \
  51. ),
  52. /* Lower
  53. * ,-----------------------------------------------------------------------------------.
  54. * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
  55. * |------+------+------+------+------+-------------+------+------+------+------+------|
  56. * | | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
  57. * |------+------+------+------+------+------|------+------+------+------+------+------|
  58. * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
  59. * |------+------+------+------+------+------+------+------+------+------+------+------|
  60. * | | | | | | | | Next | Vol- | Vol+ | Play |
  61. * `-----------------------------------------------------------------------------------'
  62. */
  63. [_LOWER] = LAYOUT_ortho_4x12(
  64. KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC, \
  65. _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, \
  66. _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______, \
  67. _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
  68. ),
  69. /* Raise
  70. * ,-----------------------------------------------------------------------------------.
  71. * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
  72. * |------+------+------+------+------+-------------+------+------+------+------+------|
  73. * | | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
  74. * |------+------+------+------+------+------|------+------+------+------+------+------|
  75. * | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
  76. * |------+------+------+------+------+------+------+------+------+------+------+------|
  77. * | | | | | | | | Next | Vol- | Vol+ | Play |
  78. * `-----------------------------------------------------------------------------------'
  79. */
  80. [_RAISE] = LAYOUT_ortho_4x12(
  81. KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC, \
  82. _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, \
  83. _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______, \
  84. _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
  85. ),
  86. /* Adjust (Lower + Raise)
  87. * ,-----------------------------------------------------------------------------------.
  88. * | | Reset| | | | | | | | | | Del |
  89. * |------+------+------+------+------+-------------+------+------+------+------+------|
  90. * | | | |Aud on|Audoff|AGnorm|AGswap| | | | | |
  91. * |------+------+------+------+------+------|------+------+------+------+------+------|
  92. * | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
  93. * |------+------+------+------+------+------+------+------+------+------+------+------|
  94. * | | | | | | | |Clicky|ClkDn |ClkUp |ClkRst|
  95. * `-----------------------------------------------------------------------------------'
  96. */
  97. [_ADJUST] = LAYOUT_ortho_4x12(
  98. _______, QK_BOOT, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL, \
  99. _______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, _______, _______, _______, _______, _______, \
  100. _______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, BL_TOGG, BL_DEC, BL_INC, BL_FLICKER, \
  101. _______, _______, _______, _______, _______, _______, _______, _______, CLICKY_TOGGLE, CLICKY_DOWN, CLICKY_UP, CLICKY_RESET \
  102. ),
  103. }; // end keymaps
  104. // if backlighting is enabled, configure it on boot
  105. #ifdef BACKLIGHT_ENABLE
  106. void matrix_init_user(void) {
  107. // set to max
  108. backlight_level(BACKLIGHT_LEVELS);
  109. flicker_restore_level = get_backlight_level();
  110. // if breathing happens to be compiled in, turn it off
  111. #ifdef BACKLIGHT_BREATHING
  112. breathing_disable();
  113. #endif
  114. }
  115. #endif
  116. void persistant_default_layer_set(uint16_t default_layer) {
  117. eeconfig_update_default_layer(default_layer);
  118. default_layer_set(default_layer);
  119. }
  120. bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  121. // handle the _ADJUST layer and custom keycodes:
  122. switch (keycode) {
  123. case LOWER:
  124. if (record->event.pressed) {
  125. layer_on(_LOWER);
  126. update_tri_layer(_LOWER, _RAISE, _ADJUST);
  127. } else {
  128. layer_off(_LOWER);
  129. update_tri_layer(_LOWER, _RAISE, _ADJUST);
  130. }
  131. return false;
  132. break;
  133. case RAISE:
  134. if (record->event.pressed) {
  135. layer_on(_RAISE);
  136. update_tri_layer(_LOWER, _RAISE, _ADJUST);
  137. } else {
  138. layer_off(_RAISE);
  139. update_tri_layer(_LOWER, _RAISE, _ADJUST);
  140. }
  141. return false;
  142. break;
  143. #ifdef BACKLIGHT_ENABLE
  144. case BL_FLICKER:
  145. if (record->event.pressed) {
  146. flicker_toggle();
  147. }
  148. return false;
  149. break;
  150. #endif
  151. } // end switch case over custom keycodes
  152. #ifdef BACKLIGHT_ENABLE
  153. if (flicker_enable) {
  154. if (record->event.pressed) {
  155. flicker_keydown();
  156. } else {
  157. flicker_keyup();
  158. }
  159. }
  160. #endif
  161. return true;
  162. }
  163. bool encoder_update_user(uint8_t index, bool clockwise) {
  164. if (clockwise) {
  165. register_code(KC_VOLU);
  166. unregister_code(KC_VOLU);
  167. } else {
  168. register_code(KC_VOLD);
  169. unregister_code(KC_VOLD);
  170. }
  171. return true;
  172. }
  173. // flicker implementation:
  174. #ifdef BACKLIGHT_ENABLE
  175. void flicker_toggle(void) {
  176. flicker_enable = !flicker_enable;
  177. }
  178. void flicker_keydown(void) {
  179. // guard condition: only set the level to restore if the flicker is NOT already down
  180. if (!flicker_isdown) {
  181. flicker_restore_level = get_backlight_level();
  182. flicker_isdown = true;
  183. }
  184. // calculate a random flicker level between min and max
  185. uint8_t flicker_level = (rand() % (flicker_max_levels - flicker_min_levels)) + flicker_min_levels;
  186. uint8_t level_to_set = flicker_level <= flicker_restore_level ? flicker_restore_level - flicker_level : 0;
  187. backlight_level(level_to_set);
  188. }
  189. void flicker_keyup(void) {
  190. backlight_level(flicker_restore_level);
  191. flicker_isdown = false;
  192. }
  193. #endif