aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--keyboards/bkf/bkf.c16
-rw-r--r--keyboards/bkf/bkf.h53
-rw-r--r--keyboards/bkf/config.h60
-rw-r--r--keyboards/bkf/info.json15
-rw-r--r--keyboards/bkf/keymaps/default/keymap.c62
-rw-r--r--keyboards/bkf/keymaps/default/readme.md1
-rw-r--r--keyboards/bkf/readme.md21
-rw-r--r--keyboards/bkf/rules.mk23
8 files changed, 251 insertions, 0 deletions
diff --git a/keyboards/bkf/bkf.c b/keyboards/bkf/bkf.c
new file mode 100644
index 000000000..6df3ed56f
--- /dev/null
+++ b/keyboards/bkf/bkf.c
@@ -0,0 +1,16 @@
1/* Copyright 2021 drhigsby
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#include "bkf.h"
diff --git a/keyboards/bkf/bkf.h b/keyboards/bkf/bkf.h
new file mode 100644
index 000000000..3ea53e2de
--- /dev/null
+++ b/keyboards/bkf/bkf.h
@@ -0,0 +1,53 @@
1/* Copyright 2021 drhigsby
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#pragma once
17
18#include "quantum.h"
19
20/* This a shortcut to help you visually see your layout.
21 *
22 * The first section contains all of the arguments representing the physical
23 * layout of the board and position of the keys.
24 *
25 * The second converts the arguments into a two-dimensional array which
26 * represents the switch matrix.
27 */
28
29#define zzzz KC_NO
30
31#define LAYOUT_625uC( \
32 k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k311, \
33 k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, \
34 k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, \
35 k300, k301, k302, k306, k308, k309, k310 \
36) { \
37 { k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011 }, \
38 { k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111 }, \
39 { k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211 }, \
40 { k300, k301, k302, zzzz, zzzz, zzzz, k306, zzzz, k308, k309, k310, k311 } \
41}
42
43#define LAYOUT_2x3uC( \
44 k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k311, \
45 k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, \
46 k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, \
47 k300, k301, k302, k304, k306, k308, k309, k310 \
48) { \
49 { k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011 }, \
50 { k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111 }, \
51 { k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211 }, \
52 { k300, k301, k302, zzzz, k304, zzzz, k306, zzzz, k308, k309, k310, k311 } \
53}
diff --git a/keyboards/bkf/config.h b/keyboards/bkf/config.h
new file mode 100644
index 000000000..af1b2be74
--- /dev/null
+++ b/keyboards/bkf/config.h
@@ -0,0 +1,60 @@
1/* Copyright 2021 drhigsby
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#pragma once
17
18#include "config_common.h"
19
20/* USB Device descriptor parameter */
21#define MANUFACTURER DrHigsby
22#define PRODUCT BKF - Base Kit Forty
23#define VENDOR_ID 0x0007
24#define PRODUCT_ID 0x0003
25#define DEVICE_VER 0x0001
26
27/* key matrix size */
28#define MATRIX_ROWS 4
29#define MATRIX_COLS 12
30
31/*
32 * Keyboard Matrix Assignments
33 *
34 * Change this to how you wired your keyboard
35 * COLS: AVR pins used for columns, left to right
36 * ROWS: AVR pins used for rows, top to bottom
37 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
38 * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
39 *
40 */
41
42/* key matrix pins */
43#define MATRIX_ROW_PINS { F6, F7, B1, B3 }
44#define MATRIX_COL_PINS { B6, B2, D3, D2, D1, D0, D4, C6, D7, E6, B4, B5 }
45#define UNUSED_PINS
46
47/* Define encoder pads */
48#define ENCODERS_PAD_A { F4 }
49#define ENCODERS_PAD_B { F5 }
50
51/* COL2ROW or ROW2COL */
52#define DIODE_DIRECTION COL2ROW
53
54/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
55#define DEBOUNCE 5
56
57/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
58#define LOCKING_SUPPORT_ENABLE
59/* Locking resynchronize hack */
60#define LOCKING_RESYNC_ENABLE
diff --git a/keyboards/bkf/info.json b/keyboards/bkf/info.json
new file mode 100644
index 000000000..1ab228c1c
--- /dev/null
+++ b/keyboards/bkf/info.json
@@ -0,0 +1,15 @@
1{
2 "keyboard_name": "BKF - Base Kit Forty",
3 "url": "http://www.keyboard-layout-editor.com/#/gists/8a9ebae3a5f3f601bb928f7265db0e2e",
4 "maintainer": "drhigsby",
5 "layouts": {
6 "LAYOUT_625uC": {
7 "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}]
8 },
9
10 "LAYOUT_2x3uC": {
11 "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}]
12 },
13
14 }
15}
diff --git a/keyboards/bkf/keymaps/default/keymap.c b/keyboards/bkf/keymaps/default/keymap.c
new file mode 100644
index 000000000..cb047a681
--- /dev/null
+++ b/keyboards/bkf/keymaps/default/keymap.c
@@ -0,0 +1,62 @@
1/* Copyright 2021 drhigsby
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#include QMK_KEYBOARD_H
17
18enum layers{
19 _BASE,
20 _NUM,
21 _FN
22};
23
24#define NUM MO(_NUM)
25#define FN MO(_FN)
26#define xxx KC_TRNS
27
28const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
29 [_BASE] = LAYOUT_625uC(
30 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,
31 KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_ENT,
32 KC_LSPO, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSPC,
33 KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, NUM, FN, KC_QUOT
34 ),
35
36
37 [_NUM] = LAYOUT_625uC(
38 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,
39 KC_CAPS, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_MINS, KC_EQL, KC_PIPE,
40 xxx, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_HOME, KC_END, xxx, xxx, xxx, xxx, xxx,
41 xxx, xxx, xxx, xxx, xxx, xxx, xxx
42 ),
43
44 [_FN] = LAYOUT_625uC(
45 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,
46 xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx,
47 xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx, xxx,
48 xxx, xxx, xxx, xxx, xxx, xxx, xxx
49 )
50
51};
52
53bool encoder_update_user(uint8_t index, bool clockwise) {
54 if (index == 0) {
55 if (clockwise) {
56 tap_code(KC_VOLU);
57 } else {
58 tap_code(KC_VOLD);
59 }
60 }
61 return true;
62}
diff --git a/keyboards/bkf/keymaps/default/readme.md b/keyboards/bkf/keymaps/default/readme.md
new file mode 100644
index 000000000..ea52e6158
--- /dev/null
+++ 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
new file mode 100644
index 000000000..d55f9637e
--- /dev/null
+++ b/keyboards/bkf/readme.md
@@ -0,0 +1,21 @@
1# BKF - Base Kit Forty
2
3![BKF](https://i.imgur.com/3vR0yeW.png)
4
5BKF, 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.
6
7* Keyboard Maintainer: [H. Bond](https://github.com/drhigsby)
8* Hardware Supported: BKF (https://github.com/drhigsby/bkf)
9* Hardware Availability: open-source stacked acrylic case design available at maintainer's github / make your own
10
11Make example for this keyboard (after setting up your build environment):
12
13 make bkf:default
14
15To place this keyboard into bootloader mode, press the reset button on the PCB or short the RST and GND pins on the pro micro.
16
17Flashing example for this keyboard:
18
19 make bkf:default:flash
20
21See 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
new file mode 100644
index 000000000..b39830826
--- /dev/null
+++ b/keyboards/bkf/rules.mk
@@ -0,0 +1,23 @@
1# MCU name
2MCU = atmega32u4
3
4# Bootloader selection
5BOOTLOADER = caterina
6
7# Build Options
8# change yes to no to disable
9#
10BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite
11MOUSEKEY_ENABLE = no # Mouse keys
12EXTRAKEY_ENABLE = yes # Audio control and System control
13CONSOLE_ENABLE = no # Console for debug
14COMMAND_ENABLE = no # Commands for debug and configuration
15# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
16SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
17# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
18NKRO_ENABLE = yes # USB Nkey Rollover
19BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
20RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
21AUDIO_ENABLE = no # Audio output
22LTO_ENABLE = no # Use link time optimization
23ENCODER_ENABLE = yes
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-05 13:26:24 +0000