diff options
author | James Young <18669334+noroadsleft@users.noreply.github.com> | 2021-01-22 18:02:40 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-22 18:02:40 -0800 |
commit | 3a7573436ae6ab20973389a4051a8785399539f2 (patch) | |
tree | 4e9d11ac68e0744269495f7fae243eb46f120d54 /keyboards/program_yoink/staggered | |
parent | 7e77c2361fbfba60fabb490a8dae310d5b7309ba (diff) |
Program Yoink! refactor (#11636)
* split config.h for each variant
* split rules.mk for each variant
* split source and header files for each variant
* move keymaps to the appropriate variant
* update keyboard readme
* update keymap readmes
* differentiate Staggered and Ortho USB Device Strings
* clean up formatting in info.json
* split info.json files for each variant
* break up the info.json for readability
* correct key positioning and board dimensions
* correct key object sequences
* add weak encoder function to keyboard level
Allows Configurator-compiled firmware to have encoder functionality.
* add variant-specific readme files and bootloader instructions
Diffstat (limited to 'keyboards/program_yoink/staggered')
14 files changed, 429 insertions, 0 deletions
diff --git a/keyboards/program_yoink/staggered/config.h b/keyboards/program_yoink/staggered/config.h new file mode 100644 index 0000000000..a0da031525 --- /dev/null +++ b/keyboards/program_yoink/staggered/config.h @@ -0,0 +1,19 @@ +/* +Copyright 2020 melonbred + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. +*/ + +#define PRODUCT_ID 0xF10B +#define PRODUCT Program Yoink! Staggered diff --git a/keyboards/program_yoink/staggered/info.json b/keyboards/program_yoink/staggered/info.json new file mode 100644 index 0000000000..4e5eb2159a --- /dev/null +++ b/keyboards/program_yoink/staggered/info.json @@ -0,0 +1,114 @@ +{ + "keyboard_name": "program_yoink", + "url": "", + "maintainer": "melonbred", + "width": 13.5, + "height": 4.25, + "layouts": { + "LAYOUT_default": { + "layout": [ + {"x":0, "y":0}, + {"x":1, "y":0}, + {"x":2, "y":0}, + {"x":3, "y":0}, + {"x":4, "y":0}, + {"x":5, "y":0}, + {"x":6, "y":0}, + {"x":7, "y":0}, + {"x":8, "y":0}, + {"x":9, "y":0}, + {"x":10, "y":0}, + {"x":11, "y":0}, + {"x":12.5, "y":0}, + + {"x":0, "y":1, "w":1.25}, + {"x":1.25, "y":1}, + {"x":2.25, "y":1}, + {"x":3.25, "y":1}, + {"x":4.25, "y":1}, + {"x":5.25, "y":1}, + {"x":6.25, "y":1}, + {"x":7.25, "y":1}, + {"x":8.25, "y":1}, + {"x":9.25, "y":1}, + {"x":10.25, "y":1, "w":1.75}, + {"x":12.5, "y":1}, + + {"x":0, "y":2, "w":1.75}, + {"x":1.75, "y":2}, + {"x":2.75, "y":2}, + {"x":3.75, "y":2}, + {"x":4.75, "y":2}, + {"x":5.75, "y":2}, + {"x":6.75, "y":2}, + {"x":7.75, "y":2}, + {"x":8.75, "y":2}, + {"x":9.75, "y":2, "w":1.25}, + {"x":11.25, "y":2.25}, + {"x":12.5, "y":2}, + + {"x":0, "y":3, "w":1.25}, + {"x":1.25, "y":3, "w":1.25}, + {"x":2.5, "y":3, "w":6.25}, + {"x":8.75, "y":3, "w":1.25}, + {"x":10.25, "y":3.25}, + {"x":11.25, "y":3.25}, + {"x":12.25, "y":3.25} + ] + }, + "LAYOUT_split_bar": { + "layout": [ + {"x":0, "y":0}, + {"x":1, "y":0}, + {"x":2, "y":0}, + {"x":3, "y":0}, + {"x":4, "y":0}, + {"x":5, "y":0}, + {"x":6, "y":0}, + {"x":7, "y":0}, + {"x":8, "y":0}, + {"x":9, "y":0}, + {"x":10, "y":0}, + {"x":11, "y":0}, + {"x":12.5, "y":0}, + + {"x":0, "y":1, "w":1.25}, + {"x":1.25, "y":1}, + {"x":2.25, "y":1}, + {"x":3.25, "y":1}, + {"x":4.25, "y":1}, + {"x":5.25, "y":1}, + {"x":6.25, "y":1}, + {"x":7.25, "y":1}, + {"x":8.25, "y":1}, + {"x":9.25, "y":1}, + {"x":10.25, "y":1, "w":1.75}, + {"x":12.5, "y":1}, + + {"x":0, "y":2, "w":1.75}, + {"x":1.75, "y":2}, + {"x":2.75, "y":2}, + {"x":3.75, "y":2}, + {"x":4.75, "y":2}, + {"x":5.75, "y":2}, + {"x":6.75, "y":2}, + {"x":7.75, "y":2}, + {"x":8.75, "y":2}, + {"x":9.75, "y":2, "w":1.25}, + {"x":11.25, "y":2.25}, + {"x":12.5, "y":2}, + + {"x":0, "y":3}, + {"x":1, "y":3}, + {"x":2, "y":3}, + {"x":3, "y":3, "w":2.75}, + {"x":5.75, "y":3, "w":2.25}, + {"x":8, "y":3}, + {"x":9, "y":3}, + {"x":10.25, "y":3.25}, + {"x":11.25, "y":3.25}, + {"x":12.25, "y":3.25} + ] + } + } +} diff --git a/keyboards/program_yoink/staggered/keymaps/default/config.h b/keyboards/program_yoink/staggered/keymaps/default/config.h new file mode 100644 index 0000000000..c4b4470e96 --- /dev/null +++ b/keyboards/program_yoink/staggered/keymaps/default/config.h @@ -0,0 +1,25 @@ +/* Copyright 2020 melonbred + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#pragma once + +// place overrides here +#define TAPPING_TERM 200 + +#ifdef COMBO_ENABLE +# define COMBO_COUNT 10 +# define COMBO_TERM 200 +#endif
\ No newline at end of file diff --git a/keyboards/program_yoink/staggered/keymaps/default/keymap.c b/keyboards/program_yoink/staggered/keymaps/default/keymap.c new file mode 100644 index 0000000000..5aa0c95e69 --- /dev/null +++ b/keyboards/program_yoink/staggered/keymaps/default/keymap.c @@ -0,0 +1,75 @@ +/* Copyright 2020 melonbred + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ +#include QMK_KEYBOARD_H + + +// Defines names for use in layer keycodes and the keymap +enum layer_names { + _BASE, + _LAYER1, + _LAYER2 +}; + +// Defines Combos for use in the keymap +enum combo_events { + COMBO_SLSH, +}; + + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_BASE] = LAYOUT_default( + KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_MUTE, + KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_ENT, RGB_VAI, + KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, MT(MOD_RSFT, KC_DOT), KC_UP, RGB_VAD, + KC_LCTL, MT(MOD_LALT, KC_CAPS), LT(_LAYER2, KC_SPC), LT(_LAYER1, KC_DEL), KC_LEFT, KC_DOWN, KC_RGHT + ), + + [_LAYER1] = LAYOUT_default( + KC_MINS, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC, _______, + KC_EQL, _______, _______, _______, _______, _______, _______, KC_LBRC, KC_RBRC, KC_SCLN, KC_QUOT, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + KC_LGUI, KC_LALT, _______, _______, _______, _______, _______ + ), + + [_LAYER2] = LAYOUT_default( + KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, + _______, _______, _______, _______, _______, _______, RGB_M_B, RGB_M_P, RGB_M_K, RGB_M_G, RGB_M_R, RGB_HUI, + _______, _______, _______, _______, _______, RESET, _______, _______, _______, _______, _______, RGB_HUD, + _______, RGB_TOG, XXXXXXX, RESET, _______, _______, _______ + ), +}; + + +void encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { + if (clockwise) { + tap_code(KC_VOLU); + } else { + tap_code(KC_VOLD); + } + } +} + +#ifdef COMBO_ENABLE +const uint16_t PROGMEM combo_slsh[] = {MT(MOD_RSFT, KC_DOT), KC_COMM, COMBO_END}; + + +combo_t key_combos[COMBO_COUNT] = { + [COMBO_SLSH] = COMBO(combo_slsh,KC_SLSH), + +}; +#endif + diff --git a/keyboards/program_yoink/staggered/keymaps/default/readme.md b/keyboards/program_yoink/staggered/keymaps/default/readme.md new file mode 100644 index 0000000000..b225f4bede --- /dev/null +++ b/keyboards/program_yoink/staggered/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for the Program Yoink! Staggered diff --git a/keyboards/program_yoink/staggered/keymaps/default/rules.mk b/keyboards/program_yoink/staggered/keymaps/default/rules.mk new file mode 100644 index 0000000000..ab1e438182 --- /dev/null +++ b/keyboards/program_yoink/staggered/keymaps/default/rules.mk @@ -0,0 +1 @@ +COMBO_ENABLE = yes diff --git a/keyboards/program_yoink/staggered/keymaps/split_bar/config.h b/keyboards/program_yoink/staggered/keymaps/split_bar/config.h new file mode 100644 index 0000000000..842b3b8011 --- /dev/null +++ b/keyboards/program_yoink/staggered/keymaps/split_bar/config.h @@ -0,0 +1,25 @@ +/* Copyright 2020 melonbred + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#pragma once + +// place overrides here +#define TAPPING_TERM 200 + +#ifdef COMBO_ENABLE +# define COMBO_COUNT 10 +# define COMBO_TERM 200 +#endif diff --git a/keyboards/program_yoink/staggered/keymaps/split_bar/keymap.c b/keyboards/program_yoink/staggered/keymaps/split_bar/keymap.c new file mode 100644 index 0000000000..89865dad32 --- /dev/null +++ b/keyboards/program_yoink/staggered/keymaps/split_bar/keymap.c @@ -0,0 +1,75 @@ +/* Copyright 2020 melonbred + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ +#include QMK_KEYBOARD_H + +// Defines names for use in layer keycodes and the keymap +enum layer_names { + _BASE, + _LAYER1, + _LAYER2 +}; + +// Defines Combos for use in the keymap +enum combo_events { + COMBO_SLSH, +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_BASE] = LAYOUT_split_bar( + KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_MPLY, + CTL_T(KC_TAB), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_ENT, KC_PGUP, + KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, MT(MOD_RSFT, KC_DOT), KC_UP, KC_PGDN, + MO(_LAYER2), KC_LGUI, KC_LALT, LT(_LAYER1, KC_SPC), KC_SPC, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT + ), + + [_LAYER1] = LAYOUT_split_bar( + KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL, _______, + KC_CAPS, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, _______, _______, KC_SCLN, KC_QUOT, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, KC_LGUI, _______, _______, _______, _______, _______, _______, _______, _______ + ), + + [_LAYER2] = LAYOUT_split_bar( + KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, + XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, RGB_M_K, RGB_M_G, RGB_M_R, RGB_M_SW, RGB_HUI, + XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, RESET, XXXXXXX, XXXXXXX, XXXXXXX, RGB_VAI, RGB_VAD, RGB_HUD, + _______, RGB_TOG, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_DEL, KC_RALT, KC_RCTL + ), +}; + + +void encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { + if (clockwise) { + tap_code(KC_VOLU); + } else { + tap_code(KC_VOLD); + } + } +} + +#ifdef COMBO_ENABLE +const uint16_t PROGMEM combo_slsh[] = {MT(MOD_RSFT, KC_DOT), KC_COMM, COMBO_END}; + + +combo_t key_combos[COMBO_COUNT] = { + [COMBO_SLSH] = COMBO(combo_slsh,KC_SLSH), + +}; +#endif + + + diff --git a/keyboards/program_yoink/staggered/keymaps/split_bar/readme.md b/keyboards/program_yoink/staggered/keymaps/split_bar/readme.md new file mode 100644 index 0000000000..db383d07a4 --- /dev/null +++ b/keyboards/program_yoink/staggered/keymaps/split_bar/readme.md @@ -0,0 +1 @@ +# The split space bar keymap for the Program Yoink! Staggered diff --git a/keyboards/program_yoink/staggered/keymaps/split_bar/rules.mk b/keyboards/program_yoink/staggered/keymaps/split_bar/rules.mk new file mode 100644 index 0000000000..ab1e438182 --- /dev/null +++ b/keyboards/program_yoink/staggered/keymaps/split_bar/rules.mk @@ -0,0 +1 @@ +COMBO_ENABLE = yes diff --git a/keyboards/program_yoink/staggered/readme.md b/keyboards/program_yoink/staggered/readme.md new file mode 100644 index 0000000000..1a1b7bb499 --- /dev/null +++ b/keyboards/program_yoink/staggered/readme.md @@ -0,0 +1,20 @@ +# Program Yoink! Staggered + +![Program Yoink! Staggered](https://i.imgur.com/2bBLKJrl.jpeg) + +Program Yoink is a 12u main cluster board accompanied by a macro column with optional encoder support and arrow keys. + +* Keyboard Maintainer: [melonbred](https://github.com/melonbred) +* Hardware Supported: Program Yoink! Staggered PCB (ATmega32u2) +* Hardware Availability: [P3D Store](https://p3dstore.com/products/yoink-gb) + +Make example for this keyboard (after setting up your build environment): + + make program_yoink/staggered:default + +To reset the board into bootloader mode, do one of the following: + +* Tap the Reset switch mounted on the bottom side of the PCB +* Hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings) + +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). diff --git a/keyboards/program_yoink/staggered/rules.mk b/keyboards/program_yoink/staggered/rules.mk new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/keyboards/program_yoink/staggered/rules.mk diff --git a/keyboards/program_yoink/staggered/staggered.c b/keyboards/program_yoink/staggered/staggered.c new file mode 100644 index 0000000000..1bdb4a2162 --- /dev/null +++ b/keyboards/program_yoink/staggered/staggered.c @@ -0,0 +1,17 @@ +/* Copyright 2020 melonbred + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#include "staggered.h" diff --git a/keyboards/program_yoink/staggered/staggered.h b/keyboards/program_yoink/staggered/staggered.h new file mode 100644 index 0000000000..1b35e28da7 --- /dev/null +++ b/keyboards/program_yoink/staggered/staggered.h @@ -0,0 +1,55 @@ +/* Copyright 2020 melonbred + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#pragma once + +#include "program_yoink.h" + +/* This is a shortcut to help you visually see your layout. + * + * The first section contains all of the arguments representing the physical + * layout of the board and position of the keys. + * + * The second converts the arguments into a two-dimensional array which + * represents the switch matrix. + */ +#define XXX KC_NO + +#define LAYOUT_default( \ + K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \ + K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1C, \ + K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2C, \ + K30, K31, K34, K38, K39, K3A, K3C \ +) \ +{ \ + { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C }, \ + { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, XXX, K1C }, \ + { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, XXX, K2C }, \ + { K30, K31, XXX, XXX, K34, XXX, XXX, XXX, K38, K39, K3A, XXX, K3C } \ +} + +#define LAYOUT_split_bar( \ + K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \ + K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1C, \ + K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2C, \ + K30, K31, K32, K33, K35, K37, K38, K39, K3A, K3C \ +) \ +{ \ + { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C }, \ + { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, XXX, K1C }, \ + { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, XXX, K2C }, \ + { K30, K31, K32, K33, XXX, K35, XXX, K37, K38, K39, K3A, XXX, K3C } \ +} |