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 | |
| 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')
38 files changed, 489 insertions, 286 deletions
diff --git a/keyboards/program_yoink/config.h b/keyboards/program_yoink/config.h index d1fc28ef4d..9d9715ff55 100644 --- a/keyboards/program_yoink/config.h +++ b/keyboards/program_yoink/config.h @@ -21,10 +21,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. /* USB Device descriptor parameter */ #define VENDOR_ID 0xFEED -#define PRODUCT_ID 0xF10B #define DEVICE_VER 0x0001 #define MANUFACTURER melonbred -#define PRODUCT program_yoink /* key matrix size */ #define MATRIX_ROWS 4 diff --git a/keyboards/program_yoink/info.json b/keyboards/program_yoink/info.json deleted file mode 100644 index b34e536098..0000000000 --- a/keyboards/program_yoink/info.json +++ /dev/null @@ -1,207 +0,0 @@ -{ - "keyboard_name": "program_yoink", - "url": "", - "maintainer": "melonbred", - "width": 13.75, - "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.75, "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.75, "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":12.75, "y":2}, - {"x":11.25, "y":2.25}, - {"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.75, "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.75, "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":12.75, "y":2}, - {"x":11.25, "y":2.25}, - {"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}] - }, - "LAYOUT_ortho": { - "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}, - {"x":1, "y":1}, - {"x":2, "y":1}, - {"x":3, "y":1}, - {"x":4, "y":1}, - {"x":5, "y":1}, - {"x":6, "y":1}, - {"x":7, "y":1}, - {"x":8, "y":1}, - {"x":9, "y":1}, - {"x":10, "y":1}, - {"x":11, "y":1}, - {"x":12.5, "y":1}, - {"x":0, "y":2}, - {"x":1, "y":2}, - {"x":2, "y":2}, - {"x":3, "y":2}, - {"x":4, "y":2}, - {"x":5, "y":2}, - {"x":6, "y":2}, - {"x":7, "y":2}, - {"x":8, "y":2}, - {"x":9, "y":2}, - {"x":10, "y":2}, - {"x":12.5, "y":2}, - {"x":11.25, "y":2.25}, - {"x":0, "y":3}, - {"x":1, "y":3}, - {"x":2, "y":3, "w":7}, - {"x":9, "y":3}, - {"x":10.25, "y":3.25}, - {"x":11.25, "y":3.25}, - {"x":12.25, "y":3.25}] - }, - "LAYOUT_ortho_split": { - "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}, - {"x":1, "y":1}, - {"x":2, "y":1}, - {"x":3, "y":1}, - {"x":4, "y":1}, - {"x":5, "y":1}, - {"x":6, "y":1}, - {"x":7, "y":1}, - {"x":8, "y":1}, - {"x":9, "y":1}, - {"x":10, "y":1}, - {"x":11, "y":1}, - {"x":12.5, "y":1}, - {"x":0, "y":2}, - {"x":1, "y":2}, - {"x":2, "y":2}, - {"x":3, "y":2}, - {"x":4, "y":2}, - {"x":5, "y":2}, - {"x":6, "y":2}, - {"x":7, "y":2}, - {"x":8, "y":2}, - {"x":9, "y":2}, - {"x":10, "y":2}, - {"x":12.75, "y":2}, - {"x":11.25, "y":2.25}, - {"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/keymaps/default/readme.md b/keyboards/program_yoink/keymaps/default/readme.md deleted file mode 100644 index 4e0a314f40..0000000000 --- a/keyboards/program_yoink/keymaps/default/readme.md +++ /dev/null @@ -1 +0,0 @@ -# The default keymap for program_yoink diff --git a/keyboards/program_yoink/keymaps/ortho_default/readme.md b/keyboards/program_yoink/keymaps/ortho_default/readme.md deleted file mode 100644 index bc74170158..0000000000 --- a/keyboards/program_yoink/keymaps/ortho_default/readme.md +++ /dev/null @@ -1 +0,0 @@ -# The default keymap for ortho program_yoink diff --git a/keyboards/program_yoink/keymaps/ortho_split/readme.md b/keyboards/program_yoink/keymaps/ortho_split/readme.md deleted file mode 100644 index 0a5899ee45..0000000000 --- a/keyboards/program_yoink/keymaps/ortho_split/readme.md +++ /dev/null @@ -1 +0,0 @@ -# The split space bar keymap for ortho program_yoink diff --git a/keyboards/program_yoink/keymaps/split_bar/readme.md b/keyboards/program_yoink/keymaps/split_bar/readme.md deleted file mode 100644 index 4e0a314f40..0000000000 --- a/keyboards/program_yoink/keymaps/split_bar/readme.md +++ /dev/null @@ -1 +0,0 @@ -# The default keymap for program_yoink diff --git a/keyboards/program_yoink/ortho/config.h b/keyboards/program_yoink/ortho/config.h new file mode 100644 index 0000000000..7620643f1a --- /dev/null +++ b/keyboards/program_yoink/ortho/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 0xF10C +#define PRODUCT Program Yoink! Ortho diff --git a/keyboards/program_yoink/ortho/info.json b/keyboards/program_yoink/ortho/info.json new file mode 100644 index 0000000000..0da81298ef --- /dev/null +++ b/keyboards/program_yoink/ortho/info.json @@ -0,0 +1,118 @@ +{ + "keyboard_name": "program_yoink", + "url": "", + "maintainer": "melonbred", + "width": 13.5, + "height": 4.25, + "layouts": { + "LAYOUT_ortho": { + "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}, + {"x":1, "y":1}, + {"x":2, "y":1}, + {"x":3, "y":1}, + {"x":4, "y":1}, + {"x":5, "y":1}, + {"x":6, "y":1}, + {"x":7, "y":1}, + {"x":8, "y":1}, + {"x":9, "y":1}, + {"x":10, "y":1}, + {"x":11, "y":1}, + {"x":12.5, "y":1}, + + {"x":0, "y":2}, + {"x":1, "y":2}, + {"x":2, "y":2}, + {"x":3, "y":2}, + {"x":4, "y":2}, + {"x":5, "y":2}, + {"x":6, "y":2}, + {"x":7, "y":2}, + {"x":8, "y":2}, + {"x":9, "y":2}, + {"x":10, "y":2}, + {"x":11.25, "y":2.25}, + {"x":12.5, "y":2}, + + {"x":0, "y":3}, + {"x":1, "y":3}, + {"x":2, "y":3, "w":7}, + {"x":9, "y":3}, + {"x":10.25, "y":3.25}, + {"x":11.25, "y":3.25}, + {"x":12.25, "y":3.25} + ] + }, + "LAYOUT_ortho_split": { + "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}, + {"x":1, "y":1}, + {"x":2, "y":1}, + {"x":3, "y":1}, + {"x":4, "y":1}, + {"x":5, "y":1}, + {"x":6, "y":1}, + {"x":7, "y":1}, + {"x":8, "y":1}, + {"x":9, "y":1}, + {"x":10, "y":1}, + {"x":11, "y":1}, + {"x":12.5, "y":1}, + + {"x":0, "y":2}, + {"x":1, "y":2}, + {"x":2, "y":2}, + {"x":3, "y":2}, + {"x":4, "y":2}, + {"x":5, "y":2}, + {"x":6, "y":2}, + {"x":7, "y":2}, + {"x":8, "y":2}, + {"x":9, "y":2}, + {"x":10, "y":2}, + {"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/keymaps/ortho_default/config.h b/keyboards/program_yoink/ortho/keymaps/default/config.h index ea7075aecb..ea7075aecb 100644 --- a/keyboards/program_yoink/keymaps/ortho_default/config.h +++ b/keyboards/program_yoink/ortho/keymaps/default/config.h diff --git a/keyboards/program_yoink/keymaps/ortho_default/keymap.c b/keyboards/program_yoink/ortho/keymaps/default/keymap.c index 6f20f22ddb..6f20f22ddb 100644 --- a/keyboards/program_yoink/keymaps/ortho_default/keymap.c +++ b/keyboards/program_yoink/ortho/keymaps/default/keymap.c diff --git a/keyboards/program_yoink/ortho/keymaps/default/readme.md b/keyboards/program_yoink/ortho/keymaps/default/readme.md new file mode 100644 index 0000000000..7598e7886b --- /dev/null +++ b/keyboards/program_yoink/ortho/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for the Program Yoink! Ortho diff --git a/keyboards/program_yoink/keymaps/default/rules.mk b/keyboards/program_yoink/ortho/keymaps/default/rules.mk index ab1e438182..ab1e438182 100644 --- a/keyboards/program_yoink/keymaps/default/rules.mk +++ b/keyboards/program_yoink/ortho/keymaps/default/rules.mk diff --git a/keyboards/program_yoink/keymaps/ortho_split/config.h b/keyboards/program_yoink/ortho/keymaps/ortho_split/config.h index ea7075aecb..ea7075aecb 100644 --- a/keyboards/program_yoink/keymaps/ortho_split/config.h +++ b/keyboards/program_yoink/ortho/keymaps/ortho_split/config.h diff --git a/keyboards/program_yoink/keymaps/ortho_split/keymap.c b/keyboards/program_yoink/ortho/keymaps/ortho_split/keymap.c index 6217124bf8..6217124bf8 100644 --- a/keyboards/program_yoink/keymaps/ortho_split/keymap.c +++ b/keyboards/program_yoink/ortho/keymaps/ortho_split/keymap.c diff --git a/keyboards/program_yoink/ortho/keymaps/ortho_split/readme.md b/keyboards/program_yoink/ortho/keymaps/ortho_split/readme.md new file mode 100644 index 0000000000..36a1385a31 --- /dev/null +++ b/keyboards/program_yoink/ortho/keymaps/ortho_split/readme.md @@ -0,0 +1 @@ +# The split space bar keymap for the Program Yoink! Ortho diff --git a/keyboards/program_yoink/keymaps/ortho_default/rules.mk b/keyboards/program_yoink/ortho/keymaps/ortho_split/rules.mk index ab1e438182..ab1e438182 100644 --- a/keyboards/program_yoink/keymaps/ortho_default/rules.mk +++ b/keyboards/program_yoink/ortho/keymaps/ortho_split/rules.mk diff --git a/keyboards/program_yoink/ortho/ortho.c b/keyboards/program_yoink/ortho/ortho.c new file mode 100644 index 0000000000..a8e1b732a9 --- /dev/null +++ b/keyboards/program_yoink/ortho/ortho.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 "ortho.h" diff --git a/keyboards/program_yoink/ortho/ortho.h b/keyboards/program_yoink/ortho/ortho.h new file mode 100644 index 0000000000..c906d2e247 --- /dev/null +++ b/keyboards/program_yoink/ortho/ortho.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_ortho( \ + K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \ + K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, \ + K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \ + K30, K31, K35, K39, K3A, K3B, 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, K1B, K1C }, \ + { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C }, \ + { K30, K31, XXX, XXX, XXX, K35, XXX, XXX, XXX, K39, K3A, K3B, K3C } \ +} + +#define LAYOUT_ortho_split( \ + K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \ + K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, \ + K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \ + K30, K31, K32, K34, K36, K38, K39, K3A, K3B, 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, K1B, K1C }, \ + { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C }, \ + { K30, K31, K32, XXX, K34, XXX, K36, XXX, K38, K39, K3A, K3B, K3C } \ +} diff --git a/keyboards/program_yoink/ortho/readme.md b/keyboards/program_yoink/ortho/readme.md new file mode 100644 index 0000000000..c77154db64 --- /dev/null +++ b/keyboards/program_yoink/ortho/readme.md @@ -0,0 +1,18 @@ +# Program Yoink! Ortho + +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! Ortho 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/ortho: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/ortho/rules.mk b/keyboards/program_yoink/ortho/rules.mk new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/keyboards/program_yoink/ortho/rules.mk diff --git a/keyboards/program_yoink/program_yoink.c b/keyboards/program_yoink/program_yoink.c index e549c98e93..a974d7f6fa 100644 --- a/keyboards/program_yoink/program_yoink.c +++ b/keyboards/program_yoink/program_yoink.c @@ -15,3 +15,14 @@ */ #include "program_yoink.h" + +__attribute__ ((weak)) +void encoder_update_user(uint8_t index, bool clockwise) { + if (index == 0) { + if (clockwise) { + tap_code(KC_VOLU); + } else { + tap_code(KC_VOLD); + } + } +} diff --git a/keyboards/program_yoink/program_yoink.h b/keyboards/program_yoink/program_yoink.h index 5aca12c268..d6a1d33b53 100644 --- a/keyboards/program_yoink/program_yoink.h +++ b/keyboards/program_yoink/program_yoink.h @@ -18,67 +18,8 @@ #include "quantum.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 } \ -} - -#define LAYOUT_ortho( \ - K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \ - K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, \ - K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \ - K30, K31, K35, K39, K3A, K3B, 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, K1B, K1C }, \ - { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C }, \ - { K30, K31, XXX, XXX, XXX, K35, XXX, XXX, XXX, K39, K3A, K3B, K3C } \ -} - -#define LAYOUT_ortho_split( \ - K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \ - K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, \ - K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \ - K30, K31, K32, K34, K36, K38, K39, K3A, K3B, 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, K1B, K1C }, \ - { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C }, \ - { K30, K31, K32, XXX, K34, XXX, K36, XXX, K38, K39, K3A, K3B, K3C } \ -} - - - +#if defined(KEYBOARD_program_yoink_staggered) + #include "staggered.h" +#elif defined(KEYBOARD_program_yoink_ortho) + #include "ortho.h" +#endif diff --git a/keyboards/program_yoink/readme.md b/keyboards/program_yoink/readme.md index 6fa3bf4f7d..4a1a867ec2 100644 --- a/keyboards/program_yoink/readme.md +++ b/keyboards/program_yoink/readme.md @@ -1,15 +1,21 @@ -# program_yoink +# Program Yoink! - + 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/yourusername) -* Hardware Supported: The PCBs, controllers supported -* Hardware Availability: Links to where you can find this hardware +* Keyboard Maintainer: [melonbred](https://github.com/melonbred) +* Hardware Supported: [Program Yoink! Staggered](staggered/) and [Ortho](ortho/) PCBs (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:default + make program_yoink/staggered:default + make program_yoink/ortho: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/rules.mk b/keyboards/program_yoink/rules.mk index 4384a0f014..51bb37c86c 100644 --- a/keyboards/program_yoink/rules.mk +++ b/keyboards/program_yoink/rules.mk @@ -7,11 +7,11 @@ BOOTLOADER = atmel-dfu # Build Options # change yes to no to disable # -BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration MOUSEKEY_ENABLE = yes # Mouse keys EXTRAKEY_ENABLE = yes # Audio control and System control CONSOLE_ENABLE = no # Console for debug -COMMAND_ENABLE = no # Commands for debug and configuration +COMMAND_ENABLE = no # Commands for debug and configuration # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend # if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work @@ -20,4 +20,6 @@ BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow BLUETOOTH_ENABLE = no # Enable Bluetooth AUDIO_ENABLE = no # Audio output -ENCODER_ENABLE = yes # Enable rotary encoder +ENCODER_ENABLE = yes # Enable rotary encoder + +DEFAULT_FOLDER = program_yoink/staggered 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/keymaps/default/config.h b/keyboards/program_yoink/staggered/keymaps/default/config.h index c4b4470e96..c4b4470e96 100644 --- a/keyboards/program_yoink/keymaps/default/config.h +++ b/keyboards/program_yoink/staggered/keymaps/default/config.h diff --git a/keyboards/program_yoink/keymaps/default/keymap.c b/keyboards/program_yoink/staggered/keymaps/default/keymap.c index 5aa0c95e69..5aa0c95e69 100644 --- a/keyboards/program_yoink/keymaps/default/keymap.c +++ b/keyboards/program_yoink/staggered/keymaps/default/keymap.c 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/keymaps/ortho_split/rules.mk b/keyboards/program_yoink/staggered/keymaps/default/rules.mk index ab1e438182..ab1e438182 100644 --- a/keyboards/program_yoink/keymaps/ortho_split/rules.mk +++ b/keyboards/program_yoink/staggered/keymaps/default/rules.mk diff --git a/keyboards/program_yoink/keymaps/split_bar/config.h b/keyboards/program_yoink/staggered/keymaps/split_bar/config.h index 842b3b8011..842b3b8011 100644 --- a/keyboards/program_yoink/keymaps/split_bar/config.h +++ b/keyboards/program_yoink/staggered/keymaps/split_bar/config.h diff --git a/keyboards/program_yoink/keymaps/split_bar/keymap.c b/keyboards/program_yoink/staggered/keymaps/split_bar/keymap.c index 89865dad32..89865dad32 100644 --- a/keyboards/program_yoink/keymaps/split_bar/keymap.c +++ b/keyboards/program_yoink/staggered/keymaps/split_bar/keymap.c 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/keymaps/split_bar/rules.mk b/keyboards/program_yoink/staggered/keymaps/split_bar/rules.mk index ab1e438182..ab1e438182 100644 --- a/keyboards/program_yoink/keymaps/split_bar/rules.mk +++ b/keyboards/program_yoink/staggered/keymaps/split_bar/rules.mk 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 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 } \ +} |