[Keyboard] Add FoldKB (qmk#12255)

Co-authored-by: Ryan <[email protected]>

keyboards/keebio/foldkb/config.h

@@ -0,0 +1,19 @@
+/* Copyright 2021 Danny Nguyen <[email protected]>
+
+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:https://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#include "config_common.h"

keyboards/keebio/foldkb/foldkb.c

@@ -0,0 +1,17 @@
+/* Copyright 2021 Danny Nguyen <[email protected]>
+
+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:https://www.gnu.org/licenses/>.
+*/
+
+#include "foldkb.h"

keyboards/keebio/foldkb/foldkb.h

@@ -0,0 +1,23 @@
+/* Copyright 2021 Danny Nguyen <[email protected]>
+
+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:https://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#include "quantum.h"
+
+#ifdef KEYBOARD_keebio_foldkb_rev1
+ #include "rev1.h"
+#endif

keyboards/keebio/foldkb/info.json

@@ -0,0 +1,89 @@
+{
+ "keyboard_name": "FoldKB",
+ "url": "https://keeb.io",
+ "maintainer": "nooges",
+ "width": 17.5,
+ "height": 5,
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ { "label": "Mute", "x": 0, "y": 0 },
+ { "label": "Esc", "x": 1.25, "y": 0 },
+ { "label": "~", "x": 2.25, "y": 0 },
+ { "label": "1", "x": 3.25, "y": 0 },
+ { "label": "2", "x": 4.25, "y": 0 },
+ { "label": "3", "x": 5.25, "y": 0 },
+ { "label": "4", "x": 6.25, "y": 0 },
+ { "label": "5", "x": 7.25, "y": 0 },
+ { "label": "6", "x": 9, "y": 0 },
+ { "label": "7", "x": 10, "y": 0 },
+ { "label": "8", "x": 11, "y": 0 },
+ { "label": "9", "x": 12, "y": 0 },
+ { "label": "0", "x": 13, "y": 0 },
+ { "label": "-", "x": 14, "y": 0 },
+ { "label": "=", "x": 15, "y": 0 },
+ { "label": "Bksp", "x": 16, "y": 0 },
+
+ { "label": "Home", "x": 0, "y": 1 },
+ { "label": "Tab", "x": 1.75, "y": 1, "w": 1.5 },
+ { "label": "Q", "x": 3.25, "y": 1 },
+ { "label": "W", "x": 4.25, "y": 1 },
+ { "label": "E", "x": 5.25, "y": 1 },
+ { "label": "R", "x": 6.25, "y": 1 },
+ { "label": "T", "x": 7.25, "y": 1 },
+ { "label": "Y", "x": 9, "y": 1 },
+ { "label": "U", "x": 10, "y": 1 },
+ { "label": "I", "x": 11, "y": 1 },
+ { "label": "O", "x": 12, "y": 1 },
+ { "label": "P", "x": 13, "y": 1 },
+ { "label": "[", "x": 14, "y": 1 },
+ { "label": "]", "x": 15, "y": 1 },
+ { "label": "\\", "x": 16, "y": 1, "w": 1.5 },
+
+ { "label": "End", "x": 0, "y": 2 },
+ { "label": "Caps", "x": 1.5, "y": 2, "w": 1.75 },
+ { "label": "A", "x": 3.25, "y": 2 },
+ { "label": "S", "x": 4.25, "y": 2 },
+ { "label": "D", "x": 5.25, "y": 2 },
+ { "label": "F", "x": 6.25, "y": 2 },
+ { "label": "G", "x": 7.25, "y": 2 },
+ { "label": "H", "x": 9, "y": 2 },
+ { "label": "J", "x": 10, "y": 2 },
+ { "label": "K", "x": 11, "y": 2 },
+ { "label": "L", "x": 12, "y": 2 },
+ { "label": ";", "x": 13, "y": 2 },
+ { "label": "'", "x": 14, "y": 2 },
+ { "label": "Enter", "x": 15, "y": 2, "w": 2.25 },
+
+ { "label": "PgUp", "x": 0, "y": 3 },
+ { "label": "Shift", "x": 1, "y": 3, "w": 2.25 },
+ { "label": "Z", "x": 3.25, "y": 3 },
+ { "label": "X", "x": 4.25, "y": 3 },
+ { "label": "C", "x": 5.25, "y": 3 },
+ { "label": "V", "x": 6.25, "y": 3 },
+ { "label": "B", "x": 7.25, "y": 3 },
+ { "label": "N", "x": 9, "y": 3 },
+ { "label": "M", "x": 10, "y": 3 },
+ { "label": ",", "x": 11, "y": 3 },
+ { "label": ".", "x": 12, "y": 3 },
+ { "label": "/", "x": 13, "y": 3 },
+ { "label": "Shift", "x": 14, "y": 3, "w": 1.75 },
+ { "label": "Fn1", "x": 15.75, "y": 3 },
+
+ { "label": "PgDn", "x": 0, "y": 4 },
+ { "label": "Ctrl", "x": 1.5, "y": 4, "w": 1.25 },
+ { "label": "Win", "x": 2.75, "y": 4, "w": 1.25 },
+ { "label": "Alt", "x": 4, "y": 4, "w": 1.25 },
+ { "label": "Fn1", "x": 5.25, "y": 4 },
+ { "label": "Space", "x": 6.25, "y": 4 },
+ { "label": "Space", "x": 7.25, "y": 4 },
+ { "label": "Space", "x": 9, "y": 4, "w": 1.25 },
+ { "label": "Space", "x": 10.25, "y": 4, "w": 1.5 },
+ { "label": "Alt", "x": 11.75, "y": 4, "w": 1.25 },
+ { "label": "Win", "x": 13, "y": 4, "w": 1.25 },
+ { "label": "Menu", "x": 14.25, "y": 4, "w": 1.25 },
+ { "label": "Ctrl", "x": 15.5, "y": 4, "w": 1.25 }
+ ]
+ }
+ }
+}

keyboards/keebio/foldkb/keymaps/default/keymap.c

@@ -0,0 +1,50 @@
+/* Copyright 2021 Danny Nguyen <[email protected]>
+
+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:https://www.gnu.org/licenses/>.
+*/
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [0] = LAYOUT(
+ KC_MUTE, KC_ESC, KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC,
+ KC_HOME, 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,
+ KC_END, 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,
+ KC_PGUP, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(1),
+ KC_PGDN, KC_LCTL, KC_LGUI, KC_LALT, MO(1), KC_SPC, KC_SPC, KC_SPC, KC_SPC, KC_RALT, KC_RGUI, KC_MENU, KC_RCTL
+ ),
+ [1] = LAYOUT(
+ KC_MUTE, RESET, _______, RGB_HUD, RGB_HUI, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL,
+ BL_STEP, _______, RGB_SAD, RGB_SAI, _______, _______, _______, _______, KC_7, KC_8, KC_9, _______, _______, _______, _______,
+ RGB_MOD, _______, RGB_VAD, RGB_VAI, _______, _______, _______, _______, KC_4, KC_5, KC_6, _______, _______, _______,
+ KC_VOLU, _______, _______, _______, _______, _______, _______, _______, KC_1, KC_2, KC_3, _______, _______, _______,
+ KC_VOLD, _______, _______, _______, _______, _______, _______, _______, KC_0, _______, _______, _______, _______
+ ),
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+ if (index == 0) {
+ if (clockwise) {
+ tap_code(KC_VOLU);
+ } else {
+ tap_code(KC_VOLD);
+ }
+ } else if (index == 1) {
+ if (clockwise) {
+ tap_code(KC_PGDN);
+ } else {
+ tap_code(KC_PGUP);
+ }
+ }
+}

keyboards/keebio/foldkb/keymaps/via/keymap.c

@@ -0,0 +1,64 @@
+/* Copyright 2021 Danny Nguyen <[email protected]>
+
+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:https://www.gnu.org/licenses/>.
+*/
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [0] = LAYOUT(
+ KC_MUTE, KC_ESC, KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC,
+ KC_HOME, 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,
+ KC_END, 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,
+ KC_PGUP, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(1),
+ KC_PGDN, KC_LCTL, KC_LGUI, KC_LALT, MO(1), KC_SPC, KC_SPC, KC_SPC, KC_SPC, KC_RALT, KC_RGUI, KC_MENU, KC_RCTL
+ ),
+ [1] = LAYOUT(
+ KC_MUTE, RESET, _______, RGB_HUD, RGB_HUI, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL,
+ BL_STEP, _______, RGB_SAD, RGB_SAI, _______, _______, _______, _______, KC_7, KC_8, KC_9, _______, _______, _______, _______,
+ RGB_MOD, _______, RGB_VAD, RGB_VAI, _______, _______, _______, _______, KC_4, KC_5, KC_6, _______, _______, _______,
+ KC_VOLU, _______, _______, _______, _______, _______, _______, _______, KC_1, KC_2, KC_3, _______, _______, _______,
+ KC_VOLD, _______, _______, _______, _______, _______, _______, _______, KC_0, _______, _______, _______, _______
+ ),
+ [2] = LAYOUT(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+ ),
+ [3] = LAYOUT(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+ )
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+ if (index == 0) {
+ if (clockwise) {
+ tap_code(KC_VOLU);
+ } else {
+ tap_code(KC_VOLD);
+ }
+ } else if (index == 1) {
+ if (clockwise) {
+ tap_code(KC_PGDN);
+ } else {
+ tap_code(KC_PGUP);
+ }
+ }
+}

keyboards/keebio/foldkb/keymaps/via/rules.mk

@@ -0,0 +1,3 @@
+VIA_ENABLE = yes
+CONSOLE_ENABLE = yes
+LTO_ENABLE = yes

keyboards/keebio/foldkb/readme.md

@@ -0,0 +1,19 @@
+# FoldKB
+
+A split 60% ortholinear keyboard that uses a standard keyset, made and sold by Keebio. [More info at Keebio](https://keeb.io).
+Layout design by friglesnart.
+
+* Keyboard Maintainer: [Bakingpy/nooges](https://github.com/nooges)
+* Hardware Availability: [Keebio](https://keeb.io/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keebio/foldkb/rev1:default
+
+Example of flashing this keyboard:
+
+ make keebio/foldkb/rev1:default:flash
+
+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).
+
+A build guide for this keyboard can be found here: [Keebio Build Guides](https://docs.keeb.io)

keyboards/keebio/foldkb/rev1/config.h

@@ -0,0 +1,58 @@
+/* Copyright 2021 Danny Nguyen <[email protected]>
+
+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:https://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0xCB10
+#define PRODUCT_ID 0x1258
+#define DEVICE_VER 0x0100
+#define MANUFACTURER Keebio
+#define PRODUCT FoldKB Rev. 1
+
+/* key matrix size */
+// Rows are doubled-up
+#define MATRIX_ROWS 10
+#define MATRIX_COLS 8
+
+#define DIODE_DIRECTION COL2ROW
+// wiring of each half
+#define MATRIX_ROW_PINS { B1, B2, C7, B4, D7 }
+#define MATRIX_COL_PINS { F4, F1, F0, B7, B3, D2, D3, D5 }
+#define SPLIT_HAND_PIN F7
+#define ENCODERS_PAD_A { F5 }
+#define ENCODERS_PAD_B { F6 }
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+#define BACKLIGHT_PIN B5
+
+/* serial.c configuration for split keyboard */
+#define SOFT_SERIAL_PIN D0
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* ws2812 RGB LED */
+#define RGB_DI_PIN E6
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 16 // Number of LEDs
+#define RGBLED_SPLIT { 8, 8 }
+#define RGBLIGHT_LED_MAP { 0, 1, 2, 3, 12, 13, 14, 15, 4, 5, 6, 7, 8, 9, 10, 11 }
+#define RGBLIGHT_DEFAULT_MODE (RGBLIGHT_MODE_RAINBOW_SWIRL + 2)

keyboards/keebio/foldkb/rev1/rev1.c

@@ -0,0 +1,26 @@
+/* Copyright 2021 Danny Nguyen <[email protected]>
+
+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:https://www.gnu.org/licenses/>.
+*/
+
+#include "foldkb.h"
+
+void eeconfig_init_kb(void) {
+#ifdef BACKLIGHT_ENABLE
+ backlight_enable();
+ backlight_level(3);
+#endif
+ eeconfig_update_kb(0);
+ eeconfig_init_user();
+}