From 4fa32f0f042eecdb662d6d56d508e03cb6ff83c9 Mon Sep 17 00:00:00 2001
From: Ryan <fauxpark@gmail.com>
Date: Mon, 10 May 2021 05:16:29 +1000
Subject: [PATCH] KBDMini refactor (#12850)
---
keyboards/kbdfans/kbdmini/config.h | 29 +++-
keyboards/kbdfans/kbdmini/info.json | 68 ++++++++
keyboards/kbdfans/kbdmini/kbdmini.c | 156 +++++++++---------
keyboards/kbdfans/kbdmini/kbdmini.h | 10 +-
.../kbdfans/kbdmini/keymaps/default/keymap.c | 13 +-
keyboards/kbdfans/kbdmini/readme.md | 6 +-
keyboards/kbdfans/kbdmini/rules.mk | 23 +--
7 files changed, 188 insertions(+), 117 deletions(-)
create mode 100644 keyboards/kbdfans/kbdmini/info.json
diff --git a/keyboards/kbdfans/kbdmini/config.h b/keyboards/kbdfans/kbdmini/config.h
index d24050783..5a36e983d 100644
--- a/keyboards/kbdfans/kbdmini/config.h
+++ b/keyboards/kbdfans/kbdmini/config.h
@@ -7,23 +7,38 @@
#define PRODUCT_ID 0x2001
#define DEVICE_VER 0x0001
#define MANUFACTURER DZTECH
-
#define PRODUCT KBDMINI
+
+/* key matrix size */
#define MATRIX_ROWS 4
#define MATRIX_COLS 13
-#define MATRIX_ROW_PINS {B7, E6, F5, F4}
-#define MATRIX_COL_PINS {B3, B2, B1, B0, F1, F0, C6, B6, B5, B4, D7, D6, D4}
+/*
+ * 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)
+ *
+ */
+#define MATRIX_ROW_PINS { B7, E6, F5, F4 }
+#define MATRIX_COL_PINS { B3, B2, B1, B0, F1, F0, C6, B6, B5, B4, D7, D6, D4 }
#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 3
+
#ifdef RGB_MATRIX_ENABLE
#define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
#define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended
#define RGB_MATRIX_KEYPRESSES
#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
-#define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+#define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
#define DISABLE_RGB_MATRIX_BAND_SAT
#define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
#define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT
@@ -43,4 +58,8 @@
#define DRIVER_COUNT 2
#define DRIVER_1_LED_TOTAL 52
#define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
-#endif
\ No newline at end of file
+#endif
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION
diff --git a/keyboards/kbdfans/kbdmini/info.json b/keyboards/kbdfans/kbdmini/info.json
new file mode 100644
index 000000000..fd4ac4a1e
--- /dev/null
+++ b/keyboards/kbdfans/kbdmini/info.json
@@ -0,0 +1,68 @@
+{
+ "keyboard_name": "KBDMini",
+ "url": "",
+ "maintainer": "KBDFans",
+ "width": 13,
+ "height": 4,
+ "layouts": {
+ "LAYOUT": {
+ "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, "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, "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, "y": 2},
+ {"x": 12, "y": 2},
+
+ {"x": 0, "y": 3},
+ {"x": 1, "y": 3},
+ {"x": 2, "y": 3},
+ {"x": 3, "y": 3},
+ {"x": 4, "y": 3},
+ {"x": 5, "y": 3},
+ {"x": 6, "y": 3},
+ {"x": 7, "y": 3},
+ {"x": 8, "y": 3},
+ {"x": 9, "y": 3},
+ {"x": 10, "y": 3},
+ {"x": 11, "y": 3},
+ {"x": 12, "y": 3}
+ ]
+ }
+ }
+}
diff --git a/keyboards/kbdfans/kbdmini/kbdmini.c b/keyboards/kbdfans/kbdmini/kbdmini.c
index b402eed64..0e0df2f9a 100644
--- a/keyboards/kbdfans/kbdmini/kbdmini.c
+++ b/keyboards/kbdfans/kbdmini/kbdmini.c
@@ -1,96 +1,88 @@
#include "kbdmini.h"
-#include "config.h"
+
const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
- {0, B_9, A_9, C_9}, //LA33
- {0, B_10, A_10, C_10}, //LA37
- {0, B_11, A_11, C_11}, //LA41
- {0, B_12, A_12, C_12}, //LA45
- {0, B_13, A_13, C_13}, //LA49
- {0, B_14, A_14, C_14}, //LA53
- {0, B_15, A_15, C_15}, //LA57
- {0, B_6, A_6, C_6}, //LA21
- {0, B_5, A_5, C_5}, //LA17
- {0, B_4, A_4, C_4}, //LA13
- {0, B_3, A_3, C_3}, //LA9
- {0, B_2, A_2, C_2}, //LA5
- {0, B_1, A_1, C_1}, //LA1
+ { 0, B_9, A_9, C_9 }, //LA33
+ { 0, B_10, A_10, C_10 }, //LA37
+ { 0, B_11, A_11, C_11 }, //LA41
+ { 0, B_12, A_12, C_12 }, //LA45
+ { 0, B_13, A_13, C_13 }, //LA49
+ { 0, B_14, A_14, C_14 }, //LA53
+ { 0, B_15, A_15, C_15 }, //LA57
+ { 0, B_6, A_6, C_6 }, //LA21
+ { 0, B_5, A_5, C_5 }, //LA17
+ { 0, B_4, A_4, C_4 }, //LA13
+ { 0, B_3, A_3, C_3 }, //LA9
+ { 0, B_2, A_2, C_2 }, //LA5
+ { 0, B_1, A_1, C_1 }, //LA1
- {0, E_9, D_9, F_9}, //LA34
- {0, E_10, D_10, F_10}, //LA38
- {0, E_11, D_11, F_11}, //LA42
- {0, E_12, D_12, F_12}, //LA46
- {0, E_13, D_13, F_13}, //LA50
- {0, E_14, D_14, F_14}, //LA54
- {0, E_15, D_15, F_15}, //LA58
- {0, E_6, D_6, F_6}, //LA22
- {0, E_5, D_5, F_5}, //LA18
- {0, E_4, D_4, F_4}, //LA14
- {0, E_3, D_3, F_3}, //LA10
- {0, E_2, D_2, F_2}, //LA6
- {0, E_1, D_1, F_1}, //LA2
+ { 0, E_9, D_9, F_9 }, //LA34
+ { 0, E_10, D_10, F_10 }, //LA38
+ { 0, E_11, D_11, F_11 }, //LA42
+ { 0, E_12, D_12, F_12 }, //LA46
+ { 0, E_13, D_13, F_13 }, //LA50
+ { 0, E_14, D_14, F_14 }, //LA54
+ { 0, E_15, D_15, F_15 }, //LA58
+ { 0, E_6, D_6, F_6 }, //LA22
+ { 0, E_5, D_5, F_5 }, //LA18
+ { 0, E_4, D_4, F_4 }, //LA14
+ { 0, E_3, D_3, F_3 }, //LA10
+ { 0, E_2, D_2, F_2 }, //LA6
+ { 0, E_1, D_1, F_1 }, //LA2
- {0, H_9, G_9, I_9}, //LA35
- {0, H_10, G_10, I_10}, //LA39
- {0, H_11, G_11, I_11}, //LA43
- {0, H_12, G_12, I_12}, //LA47
- {0, H_13, G_13, I_13}, //LA51
- {0, H_14, G_14, I_14}, //LA55
- {0, H_15, G_15, I_15}, //LA59
- {0, H_6, G_6, I_6}, //LA23
- {0, H_5, G_5, I_5}, //LA19
- {0, H_4, G_4, I_4}, //LA15
- {0, H_3, G_3, I_3}, //LA11
- {0, H_2, G_2, I_2}, //LA7
- {0, H_1, G_1, I_1}, //LA3
+ { 0, H_9, G_9, I_9 }, //LA35
+ { 0, H_10, G_10, I_10 }, //LA39
+ { 0, H_11, G_11, I_11 }, //LA43
+ { 0, H_12, G_12, I_12 }, //LA47
+ { 0, H_13, G_13, I_13 }, //LA51
+ { 0, H_14, G_14, I_14 }, //LA55
+ { 0, H_15, G_15, I_15 }, //LA59
+ { 0, H_6, G_6, I_6 }, //LA23
+ { 0, H_5, G_5, I_5 }, //LA19
+ { 0, H_4, G_4, I_4 }, //LA15
+ { 0, H_3, G_3, I_3 }, //LA11
+ { 0, H_2, G_2, I_2 }, //LA7
+ { 0, H_1, G_1, I_1 }, //LA3
- {0, K_9, J_9, L_9}, //LA36
- {0, K_10, J_10, L_10}, //LA40
- {0, K_11, J_11, L_11}, //LA44
- {0, K_12, J_12, L_12}, //LA48
- {0, K_13, J_13, L_13}, //LA52
- {0, K_14, J_14, L_14}, //LA56
- {0, K_15, J_15, L_15}, //LA60
- {0, K_6, J_6, L_6}, //LA24
- {0, K_5, J_5, L_5}, //LA20
- {0, K_4, J_4, L_4}, //LA16
- {0, K_3, J_3, L_3}, //LA12
- {0, K_2, J_2, L_2}, //LA8
- {0, K_1, J_1, L_1}//LA4
+ { 0, K_9, J_9, L_9 }, //LA36
+ { 0, K_10, J_10, L_10 }, //LA40
+ { 0, K_11, J_11, L_11 }, //LA44
+ { 0, K_12, J_12, L_12 }, //LA48
+ { 0, K_13, J_13, L_13 }, //LA52
+ { 0, K_14, J_14, L_14 }, //LA56
+ { 0, K_15, J_15, L_15 }, //LA60
+ { 0, K_6, J_6, L_6 }, //LA24
+ { 0, K_5, J_5, L_5 }, //LA20
+ { 0, K_4, J_4, L_4 }, //LA16
+ { 0, K_3, J_3, L_3 }, //LA12
+ { 0, K_2, J_2, L_2 }, //LA8
+ { 0, K_1, J_1, L_1 } //LA4
};
-led_config_t g_led_config = { {
- { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12},
- { 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25},
- { 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38},
- { 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51}
-}, {
- { 0, 0 }, { 19, 0 }, { 38, 0 }, { 57, 0 }, { 76, 0 }, { 95, 0 }, { 114, 0 }, { 133, 0 }, { 152, 0 }, { 171, 0 }, { 190, 0 }, { 209, 0 }, { 224, 0 },
- { 0, 21 }, { 19, 21 }, { 38, 21 }, { 57, 21 }, { 76, 21 }, { 95, 21 }, { 114, 21 }, { 133, 21 }, { 152, 21 }, { 171, 21 }, { 190, 21 }, { 209, 21 }, { 224, 21 },
- { 0, 42 }, { 19, 42 }, { 38, 42 }, { 57, 42 }, { 76, 42 }, { 95, 42 }, { 114, 42 }, { 133, 42 }, { 152, 42 }, { 171, 42 }, { 190, 42 }, { 209, 42 }, { 224, 42 },
- { 0, 64 }, { 19, 64 }, { 38, 64 }, { 57, 64 }, { 76, 64 }, { 95, 64 }, { 114, 64 }, { 133, 64 }, { 152, 64 }, { 171, 64 }, { 190, 64 }, { 209, 64 }, { 224, 64 }
-}, {
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1,
- 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
-} };
-void matrix_init_kb(void) {
- matrix_init_user();
-}
-void matrix_scan_kb(void) {
- matrix_scan_user();
-}
-bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
- return process_record_user(keycode, record);
-}
-void suspend_power_down_kb(void)
-{
+led_config_t g_led_config = {
+ {
+ { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 },
+ { 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 },
+ { 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38 },
+ { 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51 }
+ }, {
+ { 0, 0 }, { 19, 0 }, { 38, 0 }, { 57, 0 }, { 76, 0 }, { 95, 0 }, { 114, 0 }, { 133, 0 }, { 152, 0 }, { 171, 0 }, { 190, 0 }, { 209, 0 }, { 224, 0 },
+ { 0, 21 }, { 19, 21 }, { 38, 21 }, { 57, 21 }, { 76, 21 }, { 95, 21 }, { 114, 21 }, { 133, 21 }, { 152, 21 }, { 171, 21 }, { 190, 21 }, { 209, 21 }, { 224, 21 },
+ { 0, 42 }, { 19, 42 }, { 38, 42 }, { 57, 42 }, { 76, 42 }, { 95, 42 }, { 114, 42 }, { 133, 42 }, { 152, 42 }, { 171, 42 }, { 190, 42 }, { 209, 42 }, { 224, 42 },
+ { 0, 64 }, { 19, 64 }, { 38, 64 }, { 57, 64 }, { 76, 64 }, { 95, 64 }, { 114, 64 }, { 133, 64 }, { 152, 64 }, { 171, 64 }, { 190, 64 }, { 209, 64 }, { 224, 64 }
+ }, {
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1,
+ 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
+ }
+};
+
+void suspend_power_down_kb(void) {
rgb_matrix_set_suspend_state(true);
suspend_power_down_user();
}
-void suspend_wakeup_init_kb(void)
-{
+void suspend_wakeup_init_kb(void) {
rgb_matrix_set_suspend_state(false);
suspend_wakeup_init_user();
}
diff --git a/keyboards/kbdfans/kbdmini/kbdmini.h b/keyboards/kbdfans/kbdmini/kbdmini.h
index 38596a569..b97da5708 100644
--- a/keyboards/kbdfans/kbdmini/kbdmini.h
+++ b/keyboards/kbdfans/kbdmini/kbdmini.h
@@ -1,15 +1,15 @@
#pragma once
+
#include "quantum.h"
#define LAYOUT( \
- 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,\
+ 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, K33, K34, K35, K36, K37, 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, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C } \
+ { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C } \
}
-
diff --git a/keyboards/kbdfans/kbdmini/keymaps/default/keymap.c b/keyboards/kbdfans/kbdmini/keymaps/default/keymap.c
index 9c8267147..4cf8fcd65 100644
--- a/keyboards/kbdfans/kbdmini/keymaps/default/keymap.c
+++ b/keyboards/kbdfans/kbdmini/keymaps/default/keymap.c
@@ -1,9 +1,10 @@
#include QMK_KEYBOARD_H
-#define _LAYER0 0
+
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
- [_LAYER0] = LAYOUT(
- 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_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_BSPC,
- KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_UP, KC_ENT,
- KC_F5, KC_CAPS, KC_LCTL, KC_LGUI, KC_F1, KC_SPC,KC_F2, KC_RALT, KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),
+ [0] = LAYOUT(
+ 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_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_BSPC,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_UP, KC_ENT,
+ KC_F5, KC_CAPS, KC_LCTL, KC_LGUI, KC_F1, KC_SPC, KC_F2, KC_RALT, KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
+ )
};
diff --git a/keyboards/kbdfans/kbdmini/readme.md b/keyboards/kbdfans/kbdmini/readme.md
index e01684f13..5d5ebe2a7 100644
--- a/keyboards/kbdfans/kbdmini/readme.md
+++ b/keyboards/kbdfans/kbdmini/readme.md
@@ -2,9 +2,9 @@
-Keyboard Maintainer: [DZTECH](https://github.com/moyi4681)
-Hardware Supported: KBDMINI
-Hardware Availability: [KBDFans](https://kbdfans.cn/)
+* Keyboard Maintainer: [DZTECH](https://github.com/moyi4681)
+* Hardware Supported: KBDMINI
+* Hardware Availability: [KBDFans](https://kbdfans.cn/)
Make example for this keyboard (after setting up your build environment):
diff --git a/keyboards/kbdfans/kbdmini/rules.mk b/keyboards/kbdfans/kbdmini/rules.mk
index f83bbdcea..aaab18afc 100644
--- a/keyboards/kbdfans/kbdmini/rules.mk
+++ b/keyboards/kbdfans/kbdmini/rules.mk
@@ -2,13 +2,6 @@
MCU = atmega32u4
# Bootloader selection
-# Teensy halfkay
-# Pro Micro caterina
-# Atmel DFU atmel-dfu
-# LUFA DFU lufa-dfu
-# QMK DFU qmk-dfu
-# ATmega32A bootloadHID
-# ATmega328P USBasp
BOOTLOADER = atmel-dfu
# Build Options
@@ -18,16 +11,14 @@ 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
-NKRO_ENABLE = yes # USB Nkey Rollover
-BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
-MIDI_ENABLE = no # MIDI support
-UNICODE_ENABLE = no # Unicode
-BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
-AUDIO_ENABLE = no # Audio output on port C6
-RGB_MATRIX_ENABLE = yes # Use RGB matrix
+NKRO_ENABLE = yes # USB Nkey Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
+RGB_MATRIX_ENABLE = yes
RGB_MATRIX_DRIVER = IS31FL3733
-NO_USB_STARTUP_CHECK = no # Disable initialization only when usb is plugged in