[Keyboard] Bkf (#14534)

Co-authored-by: Ryan <fauxpark@gmail.com>
qmk · Sep 23, 2021 · 4062860 · 4062860
1 parent 1aaef6c
commit 4062860
Show file tree

Hide file tree

Showing 8 changed files with 251 additions and 0 deletions.
diff --git a/keyboards/bkf/bkf.c b/keyboards/bkf/bkf.c
@@ -0,0 +1,16 @@
+/* Copyright 2021 drhigsby
+ *
+ * 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 "bkf.h"
diff --git a/keyboards/bkf/bkf.h b/keyboards/bkf/bkf.h
@@ -0,0 +1,53 @@
+/* Copyright 2021 drhigsby
+ *
+ * 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 "quantum.h"
+
+/* This 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 zzzz KC_NO
+
+#define LAYOUT_625uC( \
+    k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k311, \
+    k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111,        \
+    k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211,         \
+    k300, k301,	k302,                k306,                k308, k309, k310           \
+) { \
+    { k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011 }, \
+    { k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111 },  \
+    { k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211 },   \
+    { k300, k301, k302, zzzz, zzzz, zzzz, k306, zzzz, k308, k309, k310, k311 }     \
+}
+
+#define LAYOUT_2x3uC( \
+    k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k311, \
+    k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111,        \
+    k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211,         \
+    k300, k301, k302,          k304,       k306,          k308, k309, k310           \
+) { \
+    { k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011 }, \
+    { k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111 },  \
+    { k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211 },   \
+    { k300, k301, k302, zzzz, k304, zzzz, k306, zzzz, k308, k309, k310, k311 }     \
+}
diff --git a/keyboards/bkf/config.h b/keyboards/bkf/config.h
@@ -0,0 +1,60 @@
+/* Copyright 2021 drhigsby
+ *
+ * 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 "config_common.h"
+
+/* USB Device descriptor parameter */
+#define MANUFACTURER DrHigsby
+#define PRODUCT BKF - Base Kit Forty
+#define VENDOR_ID 0x0007
+#define PRODUCT_ID 0x0003
+#define DEVICE_VER 0x0001
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 12
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+ */
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS { F6, F7, B1, B3 }
+#define MATRIX_COL_PINS { B6, B2, D3, D2, D1, D0, D4, C6, D7, E6, B4, B5 }
+#define UNUSED_PINS 
+
+/* Define encoder pads */
+#define ENCODERS_PAD_A { F4 }
+#define ENCODERS_PAD_B { F5 }
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* 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
diff --git a/keyboards/bkf/info.json b/keyboards/bkf/info.json
@@ -0,0 +1,15 @@
+{
+  "keyboard_name": "BKF - Base Kit Forty",
+  "url": "http://www.keyboard-layout-editor.com/#/gists/8a9ebae3a5f3f601bb928f7265db0e2e",
+  "maintainer": "drhigsby",
+  "layouts": {
+       "LAYOUT_625uC": {
+            "layout": [{"label":"Tab", "x":0, "y":0, "w":1.5}, {"label":"Q", "x":1.5, "y":0}, {"label":"W", "x":2.5, "y":0}, {"label":"E", "x":3.5, "y":0}, {"label":"R", "x":4.5, "y":0}, {"label":"T", "x":5.5, "y":0}, {"label":"Y", "x":6.5, "y":0}, {"label":"U", "x":7.5, "y":0}, {"label":"I", "x":8.5, "y":0}, {"label":"O", "x":9.5, "y":0}, {"label":"P", "x":10.5, "y":0}, {"label":"{", "x":11.5, "y":0}, {"label":"}", "x":12.5, "y":0}, {"label":"Caps Lock", "x":0, "y":1, "w":1.75}, {"label":"A", "x":1.75, "y":1}, {"label":"S", "x":2.75, "y":1}, {"label":"D", "x":3.75, "y":1}, {"label":"F", "x":4.75, "y":1}, {"label":"G", "x":5.75, "y":1}, {"label":"H", "x":6.75, "y":1}, {"label":"J", "x":7.75, "y":1}, {"label":"K", "x":8.75, "y":1}, {"label":"L", "x":9.75, "y":1}, {"label":":", "x":10.75, "y":1}, {"label":"Control", "x":11.75, "y":1, "w":1.75}, {"label":"Shift", "x":0, "y":2, "w":2.25}, {"label":"Z", "x":2.25, "y":2}, {"label":"X", "x":3.25, "y":2}, {"label":"C", "x":4.25, "y":2}, {"label":"V", "x":5.25, "y":2}, {"label":"B", "x":6.25, "y":2}, {"label":"N", "x":7.25, "y":2}, {"label":"M", "x":8.25, "y":2}, {"label":"<", "x":9.25, "y":2}, {"label":">", "x":10.25, "y":2}, {"label":"?", "x":11.25, "y":2}, {"label":"Shift", "x":12.25, "y":2, "w":1.25}, {"label":"Ctrl", "x":0, "y":3, "w":1.25}, {"label":"Win", "x":1.25, "y":3, "w":1.25}, {"label":"Alt", "x":2.5, "y":3, "w":1.25}, {"label":"", "x":3.75, "y":3, "w":6.25}, {"label":"Alt", "x":10, "y":3, "w":1.25}, {"label":"Win", "x":11.25, "y":3}, {"label":"Menu", "x":12.25, "y":3, "w":1.25}]
+        },
+
+        "LAYOUT_2x3uC": {
+            "layout": [{"label":"Tab", "x":0, "y":0, "w":1.5}, {"label":"Q", "x":1.5, "y":0}, {"label":"W", "x":2.5, "y":0}, {"label":"E", "x":3.5, "y":0}, {"label":"R", "x":4.5, "y":0}, {"label":"T", "x":5.5, "y":0}, {"label":"Y", "x":6.5, "y":0}, {"label":"U", "x":7.5, "y":0}, {"label":"I", "x":8.5, "y":0}, {"label":"O", "x":9.5, "y":0}, {"label":"P", "x":10.5, "y":0}, {"label":"{", "x":11.5, "y":0}, {"label":"}", "x":12.5, "y":0}, {"label":"Caps Lock", "x":0, "y":1, "w":1.75}, {"label":"A", "x":1.75, "y":1}, {"label":"S", "x":2.75, "y":1}, {"label":"D", "x":3.75, "y":1}, {"label":"F", "x":4.75, "y":1}, {"label":"G", "x":5.75, "y":1}, {"label":"H", "x":6.75, "y":1}, {"label":"J", "x":7.75, "y":1}, {"label":"K", "x":8.75, "y":1}, {"label":"L", "x":9.75, "y":1}, {"label":":", "x":10.75, "y":1}, {"label":"Control", "x":11.75, "y":1, "w":1.75}, {"label":"Shift", "x":0, "y":2, "w":2.25}, {"label":"Z", "x":2.25, "y":2}, {"label":"X", "x":3.25, "y":2}, {"label":"C", "x":4.25, "y":2}, {"label":"V", "x":5.25, "y":2}, {"label":"B", "x":6.25, "y":2}, {"label":"N", "x":7.25, "y":2}, {"label":"M", "x":8.25, "y":2}, {"label":"<", "x":9.25, "y":2}, {"label":">", "x":10.25, "y":2}, {"label":"?", "x":11.25, "y":2}, {"label":"Shift", "x":12.25, "y":2, "w":1.25}, {"label":"Ctrl", "x":0, "y":3, "w":1.25}, {"label":"Win", "x":1.25, "y":3, "w":1.25}, {"label":"Alt", "x":2.5, "y":3, "w":1.25}, {"label":"", "x":3.75, "y":3, "w":3}, {"label":"", "x":6.75, "y":3, "w":3}, {"label":"Alt", "x":9.75, "y":3, "w":1.25}, {"label":"Win", "x":11, "y":3, "w":1.25}, {"label":"Menu", "x":12.25, "y":3, "w":1.25}]
+        },
+
+    }
+}
diff --git a/keyboards/bkf/keymaps/default/keymap.c b/keyboards/bkf/keymaps/default/keymap.c
@@ -0,0 +1,62 @@
+/* Copyright 2021 drhigsby
+ *
+ * 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
+
+enum layers{
+  _BASE,
+  _NUM,
+  _FN
+};
+
+#define NUM MO(_NUM)
+#define FN MO(_FN)
+#define xxx KC_TRNS
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_BASE] = LAYOUT_625uC(
+        KC_GESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_DEL,
+        KC_TAB,    KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN,     KC_ENT,
+        KC_LSPO, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSPC,
+        KC_LCTL, KC_LGUI, KC_LALT,           KC_SPC,                        NUM, FN, KC_QUOT
+  ),
+
+
+    [_NUM] = LAYOUT_625uC(
+        KC_GRV,   KC_1,  KC_2,  KC_3,  KC_4,   KC_5,   KC_6,  KC_7,   KC_8,  KC_9,  KC_0,   KC_LBRC,   KC_RBRC,
+        KC_CAPS, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_MINS, KC_EQL, KC_PIPE,
+        xxx,    KC_LEFT,   KC_DOWN,   KC_UP,   KC_RGHT,   KC_HOME,   KC_END,   xxx,   xxx,   xxx,   xxx,   xxx,
+        xxx,   xxx,   xxx,                             xxx,                                  xxx,   xxx,   xxx
+  ),
+
+    [_FN] = LAYOUT_625uC(
+        xxx, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,
+        xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx, 
+        xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx,  xxx, 
+        xxx, xxx, xxx,                xxx,                      xxx, xxx, xxx       
+  )
+
+};
+
+bool encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) {
+        if (clockwise) {
+            tap_code(KC_VOLU);
+        } else {
+            tap_code(KC_VOLD);
+        }
+    }
+    return true;
+}
diff --git a/keyboards/bkf/keymaps/default/readme.md b/keyboards/bkf/keymaps/default/readme.md
@@ -0,0 +1 @@
+# Default BKF - Base Kit Forty Keymap
diff --git a/keyboards/bkf/readme.md b/keyboards/bkf/readme.md
@@ -0,0 +1,21 @@
+# BKF - Base Kit Forty
+
+![BKF](https://i.imgur.com/3vR0yeW.png)
+
+BKF, Base Kit Forty, is a 40% style keyboard that is fully compatbile with a standard base kit of keycaps with 3 different spacebar configurations. It supports both standard R3 1.75u as well as stepped R3 1.75u on the left side. The key in the top right corner also sports rotary encoder support. 
+
+* Keyboard Maintainer: [H. Bond](https://github.com/drhigsby)
+* Hardware Supported: BKF (https://github.com/drhigsby/bkf)
+* Hardware Availability: open-source stacked acrylic case design available at maintainer's github / make your own
+
+Make example for this keyboard (after setting up your build environment):
+
+    make bkf:default
+
+To place this keyboard into bootloader mode, press the reset button on the PCB or short the RST and GND pins on the pro micro. 
+
+Flashing example for this keyboard:
+
+    make bkf: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).
diff --git a/keyboards/bkf/rules.mk b/keyboards/bkf/rules.mk
@@ -0,0 +1,23 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no       # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+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
+NKRO_ENABLE = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output
+LTO_ENABLE = no             # Use link time optimization
+ENCODER_ENABLE = yes