diff options
| author | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2018-12-12 16:46:13 -0800 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-12-12 16:46:13 -0800 |
| commit | ca39fa8222ed339f09b2713bd538880fd4f2ff0e (patch) | |
| tree | fd32cb42b36f0234f7cd8b596a0da5cad282ebe3 | |
| parent | 2cef75cbb3ba9a3c05cf6914c6bafb720f2f2b83 (diff) | |
| download | qmk_firmware-ca39fa8222ed339f09b2713bd538880fd4f2ff0e.tar.gz qmk_firmware-ca39fa8222ed339f09b2713bd538880fd4f2ff0e.zip | |
Keyboard: handwired/kbod Refactor, Configurator support and readme update (#4623)
* handwired/kbod: refactor
- layout macro KEYMAP renamed to LAYOUT
* handwired/kbod: update config.h files to #pragma once
* handwired/kbod: Configurator support
* handwired/kbod: readme update
- updated reademe to current template
- added image
| -rw-r--r-- | keyboards/handwired/kbod/config.h | 5 | ||||
| -rw-r--r-- | keyboards/handwired/kbod/info.json | 74 | ||||
| -rw-r--r-- | keyboards/handwired/kbod/kbod.h | 2 | ||||
| -rw-r--r-- | keyboards/handwired/kbod/keymaps/default/config.h | 7 | ||||
| -rw-r--r-- | keyboards/handwired/kbod/keymaps/default/keymap.c | 54 | ||||
| -rw-r--r-- | keyboards/handwired/kbod/readme.md | 23 |
6 files changed, 113 insertions, 52 deletions
diff --git a/keyboards/handwired/kbod/config.h b/keyboards/handwired/kbod/config.h index a3f3e3908..d3869f99e 100644 --- a/keyboards/handwired/kbod/config.h +++ b/keyboards/handwired/kbod/config.h | |||
| @@ -15,8 +15,7 @@ You should have received a copy of the GNU General Public License | |||
| 15 | along with this program. If not, see <http://www.gnu.org/licenses/>. | 15 | along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 16 | */ | 16 | */ |
| 17 | 17 | ||
| 18 | #ifndef CONFIG_H | 18 | #pragma once |
| 19 | #define CONFIG_H | ||
| 20 | 19 | ||
| 21 | #include "config_common.h" | 20 | #include "config_common.h" |
| 22 | 21 | ||
| @@ -161,5 +160,3 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| 161 | 160 | ||
| 162 | #undef TAPPING_TOGGLE | 161 | #undef TAPPING_TOGGLE |
| 163 | #define TAPPING_TOGGLE 2 | 162 | #define TAPPING_TOGGLE 2 |
| 164 | |||
| 165 | #endif | ||
diff --git a/keyboards/handwired/kbod/info.json b/keyboards/handwired/kbod/info.json new file mode 100644 index 000000000..02586164b --- /dev/null +++ b/keyboards/handwired/kbod/info.json | |||
| @@ -0,0 +1,74 @@ | |||
| 1 | { | ||
| 2 | "keyboard_name": "kbod", | ||
| 3 | "url": "", | ||
| 4 | "maintainer": "qmk", | ||
| 5 | "width": 15, | ||
| 6 | "height": 5, | ||
| 7 | "layouts": { | ||
| 8 | "LAYOUT": { | ||
| 9 | "layout": [ | ||
| 10 | {"label":"`", "x":0, "y":0}, | ||
| 11 | {"label":"1", "x":1, "y":0}, | ||
| 12 | {"label":"2", "x":2, "y":0}, | ||
| 13 | {"label":"3", "x":3, "y":0}, | ||
| 14 | {"label":"4", "x":4, "y":0}, | ||
| 15 | {"label":"5", "x":5, "y":0}, | ||
| 16 | {"label":"6", "x":6, "y":0}, | ||
| 17 | {"label":"7", "x":7, "y":0}, | ||
| 18 | {"label":"8", "x":8, "y":0}, | ||
| 19 | {"label":"9", "x":9, "y":0}, | ||
| 20 | {"label":"0", "x":10, "y":0}, | ||
| 21 | {"label":"-", "x":11, "y":0}, | ||
| 22 | {"label":"=", "x":12, "y":0}, | ||
| 23 | {"label":"Backspace", "x":13, "y":0, "w":2}, | ||
| 24 | {"label":"Tab", "x":0, "y":1, "w":1.5}, | ||
| 25 | {"label":"Q", "x":1.5, "y":1}, | ||
| 26 | {"label":"W", "x":2.5, "y":1}, | ||
| 27 | {"label":"E", "x":3.5, "y":1}, | ||
| 28 | {"label":"R", "x":4.5, "y":1}, | ||
| 29 | {"label":"T", "x":5.5, "y":1}, | ||
| 30 | {"label":"Y", "x":6.5, "y":1}, | ||
| 31 | {"label":"U", "x":7.5, "y":1}, | ||
| 32 | {"label":"I", "x":8.5, "y":1}, | ||
| 33 | {"label":"O", "x":9.5, "y":1}, | ||
| 34 | {"label":"P", "x":10.5, "y":1}, | ||
| 35 | {"label":"[", "x":11.5, "y":1}, | ||
| 36 | {"label":"]", "x":12.5, "y":1}, | ||
| 37 | {"label":"\\", "x":13.5, "y":1, "w":1.5}, | ||
| 38 | {"label":"Caps Lock", "x":0, "y":2, "w":1.75}, | ||
| 39 | {"label":"A", "x":1.75, "y":2}, | ||
| 40 | {"label":"S", "x":2.75, "y":2}, | ||
| 41 | {"label":"D", "x":3.75, "y":2}, | ||
| 42 | {"label":"F", "x":4.75, "y":2}, | ||
| 43 | {"label":"G", "x":5.75, "y":2}, | ||
| 44 | {"label":"H", "x":6.75, "y":2}, | ||
| 45 | {"label":"J", "x":7.75, "y":2}, | ||
| 46 | {"label":"K", "x":8.75, "y":2}, | ||
| 47 | {"label":"L", "x":9.75, "y":2}, | ||
| 48 | {"label":";", "x":10.75, "y":2}, | ||
| 49 | {"label":"'", "x":11.75, "y":2}, | ||
| 50 | {"label":"Enter", "x":12.75, "y":2, "w":2.25}, | ||
| 51 | {"label":"Shift", "x":0, "y":3, "w":2.25}, | ||
| 52 | {"label":"Z", "x":2.25, "y":3}, | ||
| 53 | {"label":"X", "x":3.25, "y":3}, | ||
| 54 | {"label":"C", "x":4.25, "y":3}, | ||
| 55 | {"label":"V", "x":5.25, "y":3}, | ||
| 56 | {"label":"B", "x":6.25, "y":3}, | ||
| 57 | {"label":"N", "x":7.25, "y":3}, | ||
| 58 | {"label":"M", "x":8.25, "y":3}, | ||
| 59 | {"label":",", "x":9.25, "y":3}, | ||
| 60 | {"label":".", "x":10.25, "y":3}, | ||
| 61 | {"label":"/", "x":11.25, "y":3}, | ||
| 62 | {"label":"Shift", "x":12.25, "y":3, "w":2.75}, | ||
| 63 | {"label":"Ctrl", "x":0, "y":4, "w":1.25}, | ||
| 64 | {"label":"GUI", "x":1.25, "y":4, "w":1.25}, | ||
| 65 | {"label":"Alt", "x":2.5, "y":4, "w":1.25}, | ||
| 66 | {"label":"Space", "x":3.75, "y":4, "w":6.25}, | ||
| 67 | {"label":"Alt", "x":10, "y":4, "w":1.25}, | ||
| 68 | {"label":"GUI", "x":11.25, "y":4, "w":1.25}, | ||
| 69 | {"label":"Menu", "x":12.5, "y":4, "w":1.25}, | ||
| 70 | {"label":"Ctrl", "x":13.75, "y":4, "w":1.25} | ||
| 71 | ] | ||
| 72 | } | ||
| 73 | } | ||
| 74 | } | ||
diff --git a/keyboards/handwired/kbod/kbod.h b/keyboards/handwired/kbod/kbod.h index 356063624..5d9dbd05b 100644 --- a/keyboards/handwired/kbod/kbod.h +++ b/keyboards/handwired/kbod/kbod.h | |||
| @@ -3,7 +3,7 @@ | |||
| 3 | 3 | ||
| 4 | #include "quantum.h" | 4 | #include "quantum.h" |
| 5 | 5 | ||
| 6 | #define KEYMAP( \ | 6 | #define LAYOUT( \ |
| 7 | k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, \ | 7 | k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, \ |
| 8 | k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, \ | 8 | k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, \ |
| 9 | k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, \ | 9 | k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, \ |
diff --git a/keyboards/handwired/kbod/keymaps/default/config.h b/keyboards/handwired/kbod/keymaps/default/config.h index df06a2620..271f48d00 100644 --- a/keyboards/handwired/kbod/keymaps/default/config.h +++ b/keyboards/handwired/kbod/keymaps/default/config.h | |||
| @@ -1,8 +1,3 @@ | |||
| 1 | #ifndef CONFIG_USER_H | 1 | #pragma once |
| 2 | #define CONFIG_USER_H | ||
| 3 | |||
| 4 | #include "../../config.h" | ||
| 5 | 2 | ||
| 6 | // place overrides here | 3 | // place overrides here |
| 7 | |||
| 8 | #endif \ No newline at end of file | ||
diff --git a/keyboards/handwired/kbod/keymaps/default/keymap.c b/keyboards/handwired/kbod/keymaps/default/keymap.c index 1386b742f..063a94b4d 100644 --- a/keyboards/handwired/kbod/keymaps/default/keymap.c +++ b/keyboards/handwired/kbod/keymaps/default/keymap.c | |||
| @@ -1,6 +1,4 @@ | |||
| 1 | #include "kbod.h" | 1 | #include QMK_KEYBOARD_H |
| 2 | |||
| 3 | #define _____ KC_TRNS | ||
| 4 | 2 | ||
| 5 | #define MODS_PRESSED(btn) (get_mods() & (MOD_BIT(KC_L##btn)|MOD_BIT(KC_R##btn))) | 3 | #define MODS_PRESSED(btn) (get_mods() & (MOD_BIT(KC_L##btn)|MOD_BIT(KC_R##btn))) |
| 6 | 4 | ||
| @@ -25,33 +23,33 @@ if (record->event.pressed) { \ | |||
| 25 | 23 | ||
| 26 | 24 | ||
| 27 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | 25 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { |
| 28 | KEYMAP( /* Base */ | 26 | LAYOUT( /* Base */ |
| 29 | F(0), KC_1, KC_2, KC_3, F(1), KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQUAL, KC_BSPC, | 27 | F(0), KC_1, KC_2, KC_3, F(1), KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, \ |
| 30 | KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLASH, | 28 | KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, \ |
| 31 | KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCOLON, KC_QUOT, KC_ENTER, | 29 | KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, \ |
| 32 | KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMMA, KC_DOT, KC_SLASH, KC_RSFT, | 30 | KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, \ |
| 33 | TT(1), KC_LCTL, KC_LALT, KC_SPACE, KC_RALT, KC_RGUI, KC_APP, KC_RCTL | 31 | TT(1), KC_LCTL, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_APP, KC_RCTL \ |
| 34 | ), | 32 | ), |
| 35 | KEYMAP( /* Cursor layer */ | 33 | LAYOUT( /* Cursor layer */ |
| 36 | KC_GRAVE, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_DEL, | 34 | KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_DEL, \ |
| 37 | TT(3), _____, _____, _____, _____, _____, _____, _____, _____, _____, _____, _____, _____, KC_INSERT, | 35 | TT(3), _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_INS, \ |
| 38 | TT(2), _____, _____, _____, _____, _____, _____, _____, _____, _____, _____, KC_HOME, _____, | 36 | TT(2), _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, _______, \ |
| 39 | _____, _____, _____, _____, _____, _____, _____, _____, KC_PGUP, KC_PGDN, KC_END, KC_UP, | 37 | _______, _______, _______, _______, _______, _______, _______, _______, KC_PGUP, KC_PGDN, KC_END, KC_UP, \ |
| 40 | _____, _____, _____, _____, _____, KC_LEFT, KC_DOWN, KC_RIGHT | 38 | _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT \ |
| 41 | ), | 39 | ), |
| 42 | KEYMAP( /* Keypad layer */ | 40 | LAYOUT( /* Keypad layer */ |
| 43 | TO(0), KC_1, KC_2, KC_3, F(1), KC_5, KC_6, KC_P7, KC_P8, KC_P9, KC_P0, KC_PMNS, KC_PPLS, KC_BSPC, | 41 | TO(0), KC_1, KC_2, KC_3, F(1), KC_5, KC_6, KC_P7, KC_P8, KC_P9, KC_P0, KC_PMNS, KC_PPLS, KC_BSPC, \ |
| 44 | _____, _____, _____, _____, _____, _____, _____, KC_P4, KC_P5, KC_P6, _____, _____, _____, _____, | 42 | _______, _______, _______, _______, _______, _______, _______, KC_P4, KC_P5, KC_P6, _______, _______, _______, _______, \ |
| 45 | _____, _____, _____, _____, _____, _____, _____, KC_P1, KC_P2, KC_P3, _____, _____, _____, | 43 | _______, _______, _______, _______, _______, _______, _______, KC_P1, KC_P2, KC_P3, _______, _______, _______, \ |
| 46 | _____, _____, _____, _____, _____, _____, _____, KC_P0, KC_PDOT, KC_MS_BTN1, KC_MS_UP, KC_MS_BTN2, | 44 | _______, _______, _______, _______, _______, _______, _______, KC_P0, KC_PDOT, KC_BTN1, KC_MS_U, KC_BTN2, \ |
| 47 | _____, _____, _____, _____, KC_MS_LEFT, KC_MS_DOWN, KC_MS_RIGHT, KC_MS_BTN3 | 45 | _______, _______, _______, _______, KC_MS_L, KC_MS_D, KC_MS_R, KC_BTN3 \ |
| 48 | ), | 46 | ), |
| 49 | KEYMAP( /* Multimedia layer */ | 47 | LAYOUT( /* Multimedia layer */ |
| 50 | TO(0), _____, _____, _____, _____, _____, _____, _____, _____, _____, KC_AUDIO_MUTE, KC_AUDIO_VOL_DOWN, KC_AUDIO_VOL_UP, _____, | 48 | TO(0), _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, \ |
| 51 | _____, _____, KC_WAKE, _____, _____, _____, _____, _____, _____, _____, KC_MSTP, KC_MPRV, KC_MNXT, _____, | 49 | _______, _______, KC_WAKE, _______, _______, _______, _______, _______, _______, _______, KC_MSTP, KC_MPRV, KC_MNXT, _______, \ |
| 52 | _____, _____, KC_SLEP, _____, _____, _____, _____, _____, _____, _____, _____, _____, _____, | 50 | _______, _______, KC_SLEP, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \ |
| 53 | _____, _____, KC_PWR, _____, _____, _____, _____, _____, _____, KC_MS_BTN1, KC_MS_WH_UP, KC_MS_BTN2, | 51 | _______, _______, KC_PWR, _______, _______, _______, _______, _______, _______, KC_BTN1, KC_WH_U, KC_BTN2, \ |
| 54 | _____, _____, _____, KC_MPLY, KC_MS_WH_LEFT, KC_MS_WH_DOWN, KC_MS_WH_RIGHT, KC_MS_BTN3 | 52 | _______, _______, _______, KC_MPLY, KC_WH_L, KC_WH_D, KC_WH_R, KC_BTN3 \ |
| 55 | ), | 53 | ), |
| 56 | }; | 54 | }; |
| 57 | 55 | ||
| @@ -101,4 +99,4 @@ void matrix_scan_user(void) { | |||
| 101 | } else { | 99 | } else { |
| 102 | PORTC &= ~_BV(PC7); | 100 | PORTC &= ~_BV(PC7); |
| 103 | } | 101 | } |
| 104 | } \ No newline at end of file | 102 | } |
diff --git a/keyboards/handwired/kbod/readme.md b/keyboards/handwired/kbod/readme.md index d2f2c01ae..470ccce0e 100644 --- a/keyboards/handwired/kbod/readme.md +++ b/keyboards/handwired/kbod/readme.md | |||
| @@ -1,21 +1,18 @@ | |||
| 1 | KBOD keyboard firmware | 1 | # KBOD |
| 2 | ====================== | ||
| 3 | 2 | ||
| 4 | KBOD is a 60% Keyboard kit, hand-wired, with Arduino Micro as its controller. It's utilize 8x8 matrix and has layout similar to GH-60 | 3 |  |
| 5 | 4 | ||
| 6 | ## Quantum MK Firmware | 5 | KBOD is a 60% Keyboard kit, hand-wired, with Arduino Micro as its controller. It utilizes an 8x8 matrix and has layout similar to GH60. [More info](https://github.com/fudanchii/keyboard_of_disapproval) |
| 7 | 6 | ||
| 8 | For the full Quantum feature list, see [the parent readme](/). | 7 | Keyboard Maintainer: [The QMK Community](https://github.com/qmk) |
| 8 | Hardware Supported: Arduino Micro | ||
| 9 | 9 | ||
| 10 | ## Building | 10 | Make example for this keyboard (after setting up your build environment): |
| 11 | 11 | ||
| 12 | Download or clone the whole firmware and use ```make handwired/kbod:default``` to generate the .hex file. You may flash it with avrdude | 12 | make handwired/kbod:default |
| 13 | 13 | ||
| 14 | ## Flashing | 14 | Flashing your firmware may be done with avrdude. The command should be something along this line: |
| 15 | Something along this line: | ||
| 16 | 15 | ||
| 17 | ``` | 16 | avrdude -p m32u4 -c avr109 -P <COM PORT> -C <avrdude conf file> -e -u flash:w:handwired_kbod_default.hex |
| 18 | avrdude -p m32u4 -c avr109 -P <COM PORT> -C <avrdude conf file> -e -u flash:w:handwired_kbod_default.hex | ||
| 19 | ``` | ||
| 20 | 17 | ||
| 21 | [More info](https://github.com/fudanchii/keyboard_of_disapproval) \ No newline at end of file | 18 | See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |
