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.

190 lines
9.7 KiB

[Keyboard] Add Helix rev3 (#10297) * add Helix Type-R keyboard * add default 4Rows keymaps * cleanup 4row keymaps * update about SPLIT_HAND_MATRIX_GRID and DIP_SWITCH_MATRIX_GRID * change how to toggle mac/win * update "Hardware Availability" * add a section of "How to build" * update "Hardware Supported" * add dip-sw sections * comment updated in function `encoder_update_user` * revert how to toggle mac/win * remove 4Rows variant build options * rename helix_type_r to helix_5r * add helix type-R 4Rows edition * small modifications in keymap.c * small modifications according to renaming * change project root directory * continuous work on ee2c39f1f9bffd97a2deb8f430746933a8d8684c * cleanup unused files * update info.json files * cleanup 5rows' keymaps * rename and update readme.md * update config.h * update helix's readme.md and rules.mk * update keymaps' overviews * split into each keyboard * optimize firmware size for via keymaps * fix LAYOUT to LAYOUT4 in 4rows/rev3.h * remove LAYOUT_kc lines from both keymaps * rename tyep-r to rev3 * enable to SPLIT_HAND_MATRIX_GRID_LOW_IS_RIGHT * remove image from readme * clean up for PR * delete unnecessary comments * change keyboard directory * rename LAYOUT4 to LAYOUT for rev3_4rows * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Cleanup ADJUST Layer code for VIA * change SEND_STRING to tap_code * update readme * moved the oled code from the keymap to the keyboard * moved the dip switch code from the keymap to the keyboard * change layout name for info.json * Update keyboards/helix/rev3_4rows/rev3_4rows.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/rev3_4rows.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/rev3_4rows.h Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/rev3_5rows.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/rev3_5rows.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/keymaps/default/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/keymaps/default/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/rev3_5rows.h Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/oled_display.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/info.json Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rules.mk Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/helix/rev3_4rows/config.h Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * deleted key_count in info.json Co-authored-by: keyaki-namiki <28521374+keyaki-namiki@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Joel Challis <git@zvecr.com>
3 years ago
  1. /* Copyright 2020 yushakobo
  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. // Defines names for use in layer keycodes and the keymap
  18. enum layer_names {
  19. _QWERTY = 0,
  20. _LOWER,
  21. _RAISE,
  22. _ADJUST
  23. };
  24. // Defines the keycodes used by our macros in process_record_user
  25. enum custom_keycodes {
  26. EISU = SAFE_RANGE,
  27. KANA,
  28. ADJUST,
  29. RGBRST
  30. };
  31. #define LOWER FN_MO13
  32. #define RAISE FN_MO23
  33. const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  34. /* Qwerty
  35. * ,-----------------------------------------. ,-----------------------------------------.
  36. * | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
  37. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  38. * | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
  39. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  40. * | Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
  41. * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  42. * | Shift| Z | X | C | V | B | [ | ] | N | M | , | . | / |Enter |
  43. * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  44. * |Adjust| Esc | Alt | GUI | EISU |Lower |Space |Space |Raise | KANA | Left | Down | Up |Right |
  45. * `-------------------------------------------------------------------------------------------------'
  46. */
  47. [_QWERTY] = LAYOUT( \
  48. KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL, \
  49. KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, \
  50. KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, \
  51. KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LBRC, KC_RBRC, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT , \
  52. MO(_ADJUST), KC_ESC, KC_LALT, KC_LGUI, EISU, LOWER, KC_SPC, KC_SPC, RAISE, KANA, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT \
  53. ),
  54. /* Lower
  55. * ,-----------------------------------------. ,-----------------------------------------.
  56. * | | | | | | | | | | | | | |
  57. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  58. * | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
  59. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  60. * | | F1 | F2 | F3 | F4 | F5 | | F6 | _ | + | { | } | | |
  61. * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  62. * | CAPS | F7 | F8 | F9 | F10 | F11 | ( | ) | F12 | | | Home | End | |
  63. * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  64. * | | | | | | | | | | | Next | Vol- | Vol+ | Play |
  65. * `-------------------------------------------------------------------------------------------------'
  66. */
  67. [_LOWER] = LAYOUT( \
  68. _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
  69. KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______, \
  70. _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, \
  71. KC_CAPS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_LPRN, KC_RPRN, KC_F12, _______, _______, KC_HOME, KC_END, _______, \
  72. _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
  73. ),
  74. /* Raise
  75. * ,-----------------------------------------. ,-----------------------------------------.
  76. * | | | | | | | | | | | | | Bksp |
  77. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  78. * | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
  79. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  80. * | | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ |
  81. * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  82. * | CAPS | F7 | F8 | F9 | F10 | F11 | | | F12 | | |PageDn|PageUp| |
  83. * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  84. * | | | | | | | | | | | Next | Vol- | Vol+ | Play |
  85. * `-------------------------------------------------------------------------------------------------'
  86. */
  87. [_RAISE] = LAYOUT( \
  88. _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_BSPC, \
  89. KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL, \
  90. _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, \
  91. KC_CAPS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, _______, _______, KC_F12, _______, _______, KC_PGDN, KC_PGUP, _______, \
  92. _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY \
  93. ),
  94. /* Adjust (Lower + Raise)
  95. * ,-----------------------------------------. ,-----------------------------------------.
  96. * | F1 | F2 | F3 | F4 | F5 | F6 | | F7 | F8 | F9 | F10 | F11 | F12 |
  97. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  98. * | | Reset|RGBRST| | | | | | | | | | Del |
  99. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  100. * | | | | | | Mac | | Win | | | | | |
  101. * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  102. * | | | | | | | | | | |RGB ON| HUE+ | SAT+ | VAL+ |
  103. * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  104. * | | | | | | | | | | | MODE | HUE- | SAT- | VAL- |
  105. * `-------------------------------------------------------------------------------------------------'
  106. */
  107. [_ADJUST] = LAYOUT( \
  108. KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, \
  109. _______, RESET, RGBRST, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL, \
  110. _______, _______, _______, _______, _______, AG_NORM, AG_SWAP, _______, _______, _______, _______, _______, \
  111. _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, \
  112. _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD \
  113. )
  114. };
  115. void encoder_update_user(uint8_t index, bool clockwise) {
  116. if (index == 0) { /* Left side encoder */
  117. if (clockwise) {
  118. tap_code(KC_PGDN);
  119. } else {
  120. tap_code(KC_PGUP);
  121. }
  122. } else if (index == 1) { /* Right side encoder */
  123. if (clockwise) {
  124. tap_code(KC_DOWN);
  125. } else {
  126. tap_code(KC_UP);
  127. }
  128. }
  129. }
  130. bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  131. switch (keycode) {
  132. case EISU:
  133. if (record->event.pressed) {
  134. if (is_mac_mode()) {
  135. register_code(KC_LANG2);
  136. }else{
  137. tap_code16(LALT(KC_GRAVE));
  138. }
  139. } else {
  140. unregister_code(KC_LANG2);
  141. }
  142. return false;
  143. break;
  144. case KANA:
  145. if (record->event.pressed) {
  146. if (is_mac_mode()) {
  147. register_code(KC_LANG1);
  148. }else{
  149. tap_code16(LALT(KC_GRAVE));
  150. }
  151. } else {
  152. unregister_code(KC_LANG1);
  153. }
  154. return false;
  155. break;
  156. case RGBRST:
  157. #ifdef RGBLIGHT_ENABLE
  158. if (record->event.pressed) {
  159. eeconfig_update_rgblight_default();
  160. rgblight_enable();
  161. }
  162. #endif
  163. break;
  164. }
  165. return true;
  166. }
  167. /*
  168. void matrix_init_user(void) {
  169. }
  170. void matrix_scan_user(void) {
  171. }
  172. bool led_update_user(led_t led_state) {
  173. return true;
  174. }
  175. */