[Keyboard] Add rpk-001 keyboard (qmk#21042)

Co-authored-by: Joel Challis <[email protected]>
Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Duncan Sutherland <[email protected]>
Co-authored-by: Joy <[email protected]>

keyboards/phentech/rpk_001/config.h

@@ -0,0 +1,26 @@
+// Copyright 2023 JoyLee (@itarze)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+/* RGB Config */
+#define DRIVER_1_CS B6
+#define DRIVER_1_EN B7
+#define DRIVER_COUNT 1
+#define RGB_MATRIX_LED_COUNT 67
+
+/* SPI Config */
+#define SPI_DRIVER SPIDQ
+#define SPI_SCK_PIN B3
+#define SPI_MOSI_PIN B5
+#define SPI_MISO_PIN B4
+
+/* SPI Flash */
+#define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN C12
+#define WEAR_LEVELING_BACKING_SIZE (4 * 1024)
+
+/* RGB Matrix */
+#define RGB_DISABLE_WHEN_USB_SUSPENDED
+#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#define RGB_MATRIX_KEYPRESSES
+#define RGB_MATRIX_KEYRELEASES

keyboards/phentech/rpk_001/halconf.h

@@ -0,0 +1,10 @@
+// Copyright 2023 JoyLee (@itarze)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define HAL_USE_SPI TRUE
+#define SPI_USE_WAIT TRUE
+#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD
+
+#include_next <halconf.h>

keyboards/phentech/rpk_001/info.json

@@ -0,0 +1,187 @@
+{
+ "manufacturer": "HENGCANG ELECTRONIC",
+ "keyboard_name": "RPK-001",
+ "maintainer": "JoyLee",
+ "url": "",
+ "processor": "WB32FQ95",
+ "bootloader": "wb32-dfu",
+ "usb": {
+ "device_version": "1.0.0",
+ "vid": "0xAC12",
+ "pid": "0x2236",
+ "force_nkro": true,
+ "suspend_wakeup_delay": 1000
+ },
+ "diode_direction": "ROW2COL",
+ "features": {
+ "nkro": true,
+ "encoder": true,
+ "extrakey": true,
+ "bootmagic": true,
+ "rgb_matrix": true
+ },
+ "matrix_pins": {
+ "cols": ["A6", "A7", "C4", "C5", "B0", "B1", "B10", "B11", "B13", "B14", "B15", "C6", "C7", "C8", "C9"],
+ "rows": ["C3", "A0", "A3", "A4", "A5"]
+ },
+ "encoder": {
+ "rotary": [
+ {"pin_a": "A2", "pin_b": "A1"}
+ ]
+ },
+ "indicators": {
+ "caps_lock": "C15",
+ "scroll_lock": "C0",
+ "on_state": 0
+ },
+ "rgb_matrix": {
+ "driver": "aw20216",
+ "layout": [
+ { "flags": 4, "matrix": [0, 0], "x": 0, "y": 0 },
+ { "flags": 4, "matrix": [0, 1], "x": 16, "y": 0 },
+ { "flags": 4, "matrix": [0, 2], "x": 32, "y": 0 },
+ { "flags": 4, "matrix": [0, 3], "x": 48, "y": 0 },
+ { "flags": 4, "matrix": [0, 4], "x": 64, "y": 0 },
+ { "flags": 4, "matrix": [0, 5], "x": 80, "y": 0 },
+ { "flags": 4, "matrix": [0, 6], "x": 96, "y": 0 },
+ { "flags": 4, "matrix": [0, 7], "x": 112, "y": 0 },
+ { "flags": 4, "matrix": [0, 8], "x": 128, "y": 0 },
+ { "flags": 4, "matrix": [0, 9], "x": 144, "y": 0 },
+ { "flags": 4, "matrix": [0, 10], "x": 160, "y": 0 },
+ { "flags": 4, "matrix": [0, 11], "x": 176, "y": 0 },
+ { "flags": 4, "matrix": [0, 12], "x": 192, "y": 0 },
+ { "flags": 4, "matrix": [0, 13], "x": 208, "y": 0 },
+
+ { "flags": 4, "matrix": [1, 0], "x": 0, "y": 16},
+ { "flags": 4, "matrix": [1, 1], "x": 16, "y": 16},
+ { "flags": 4, "matrix": [1, 2], "x": 32, "y": 16},
+ { "flags": 4, "matrix": [1, 3], "x": 48, "y": 16},
+ { "flags": 4, "matrix": [1, 4], "x": 64, "y": 16},
+ { "flags": 4, "matrix": [1, 5], "x": 80, "y": 16},
+ { "flags": 4, "matrix": [1, 6], "x": 96, "y": 16},
+ { "flags": 4, "matrix": [1, 7], "x": 112, "y": 16},
+ { "flags": 4, "matrix": [1, 8], "x": 128, "y": 16},
+ { "flags": 4, "matrix": [1, 9], "x": 144, "y": 16},
+ { "flags": 4, "matrix": [1, 10], "x": 160, "y": 16},
+ { "flags": 4, "matrix": [1, 11], "x": 176, "y": 16},
+ { "flags": 4, "matrix": [1, 12], "x": 192, "y": 16},
+ { "flags": 4, "matrix": [1, 13], "x": 208, "y": 16},
+ { "flags": 4, "matrix": [1, 14], "x": 224, "y": 16},
+
+ { "flags": 1, "matrix": [2, 0], "x": 0, "y": 32},
+ { "flags": 4, "matrix": [2, 1], "x": 16, "y": 32},
+ { "flags": 4, "matrix": [2, 2], "x": 32, "y": 32},
+ { "flags": 4, "matrix": [2, 3], "x": 48, "y": 32},
+ { "flags": 4, "matrix": [2, 4], "x": 64, "y": 32},
+ { "flags": 4, "matrix": [2, 5], "x": 80, "y": 32},
+ { "flags": 4, "matrix": [2, 6], "x": 96, "y": 32},
+ { "flags": 4, "matrix": [2, 7], "x": 112, "y": 32},
+ { "flags": 4, "matrix": [2, 8], "x": 128, "y": 32},
+ { "flags": 4, "matrix": [2, 9], "x": 144, "y": 32},
+ { "flags": 4, "matrix": [2, 10], "x": 160, "y": 32},
+ { "flags": 4, "matrix": [2, 11], "x": 176, "y": 32},
+ { "flags": 1, "matrix": [2, 12], "x": 192, "y": 32},
+ { "flags": 4, "matrix": [2, 14], "x": 224, "y": 32},
+
+ { "flags": 1, "matrix": [3, 0], "x": 0, "y": 48},
+ { "flags": 4, "matrix": [3, 2], "x": 32, "y": 48},
+ { "flags": 4, "matrix": [3, 3], "x": 48, "y": 48},
+ { "flags": 4, "matrix": [3, 4], "x": 64, "y": 48},
+ { "flags": 4, "matrix": [3, 5], "x": 80, "y": 48},
+ { "flags": 4, "matrix": [3, 6], "x": 96, "y": 48},
+ { "flags": 4, "matrix": [3, 7], "x": 112, "y": 48},
+ { "flags": 4, "matrix": [3, 8], "x": 128, "y": 48},
+ { "flags": 4, "matrix": [3, 9], "x": 144, "y": 48},
+ { "flags": 4, "matrix": [3, 10], "x": 160, "y": 48},
+ { "flags": 4, "matrix": [3, 11], "x": 176, "y": 48},
+ { "flags": 1, "matrix": [4, 12], "x": 192, "y": 48},
+ { "flags": 1, "matrix": [3, 13], "x": 208, "y": 48},
+ { "flags": 4, "matrix": [3, 14], "x": 224, "y": 48},
+
+ { "flags": 1, "matrix": [4, 0], "x": 0, "y": 64},
+ { "flags": 1, "matrix": [4, 1], "x": 16, "y": 64},
+ { "flags": 1, "matrix": [4, 2], "x": 32, "y": 64},
+ { "flags": 4, "matrix": [4, 5], "x": 80, "y": 64},
+ { "flags": 1, "matrix": [4, 8], "x": 144, "y": 64},
+ { "flags": 1, "matrix": [4, 9], "x": 160, "y": 64},
+ { "flags": 4, "matrix": [4, 10], "x": 176, "y": 64},
+ { "flags": 1, "matrix": [4, 11], "x": 192, "y": 64},
+ { "flags": 1, "matrix": [4, 13], "x": 208, "y": 64},
+ { "flags": 1, "matrix": [4, 14], "x": 224, "y": 64}
+ ]
+ },
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ { "matrix": [0, 0], "x": 0, "y": 0 },
+ { "matrix": [0, 1], "x": 1, "y": 0 },
+ { "matrix": [0, 2], "x": 2, "y": 0 },
+ { "matrix": [0, 3], "x": 3, "y": 0 },
+ { "matrix": [0, 4], "x": 4, "y": 0 },
+ { "matrix": [0, 5], "x": 5, "y": 0 },
+ { "matrix": [0, 6], "x": 6, "y": 0 },
+ { "matrix": [0, 7], "x": 7, "y": 0 },
+ { "matrix": [0, 8], "x": 8, "y": 0 },
+ { "matrix": [0, 9], "x": 9, "y": 0 },
+ { "matrix": [0, 10], "x": 10, "y": 0 },
+ { "matrix": [0, 11], "x": 11, "y": 0 },
+ { "matrix": [0, 12], "x": 12, "y": 0 },
+ { "matrix": [0, 13], "w": 2, "x": 13, "y": 0 },
+ { "matrix": [0, 14], "x": 15.5, "y": 0 },
+ { "matrix": [1, 0], "w": 1.5, "x": 0, "y": 1 },
+ { "matrix": [1, 1], "x": 1.5, "y": 1 },
+ { "matrix": [1, 2], "x": 2.5, "y": 1 },
+ { "matrix": [1, 3], "x": 3.5, "y": 1 },
+ { "matrix": [1, 4], "x": 4.5, "y": 1 },
+ { "matrix": [1, 5], "x": 5.5, "y": 1 },
+ { "matrix": [1, 6], "x": 6.5, "y": 1 },
+ { "matrix": [1, 7], "x": 7.5, "y": 1 },
+ { "matrix": [1, 8], "x": 8.5, "y": 1 },
+ { "matrix": [1, 9], "x": 9.5, "y": 1 },
+ { "matrix": [1, 10], "x": 10.5, "y": 1 },
+ { "matrix": [1, 11], "x": 11.5, "y": 1 },
+ { "matrix": [1, 12], "x": 12.5, "y": 1 },
+ { "matrix": [1, 13], "w": 1.5, "x": 13.5, "y": 1 },
+ { "matrix": [1, 14], "x": 15.5, "y": 1 },
+ { "matrix": [2, 0], "w": 1.75, "x": 0, "y": 2 },
+ { "matrix": [2, 1], "x": 1.75, "y": 2 },
+ { "matrix": [2, 2], "x": 2.75, "y": 2 },
+ { "matrix": [2, 3], "x": 3.75, "y": 2 },
+ { "matrix": [2, 4], "x": 4.75, "y": 2 },
+ { "matrix": [2, 5], "x": 5.75, "y": 2 },
+ { "matrix": [2, 6], "x": 6.75, "y": 2 },
+ { "matrix": [2, 7], "x": 7.75, "y": 2 },
+ { "matrix": [2, 8], "x": 8.75, "y": 2 },
+ { "matrix": [2, 9], "x": 9.75, "y": 2 },
+ { "matrix": [2, 10], "x": 10.75, "y": 2 },
+ { "matrix": [2, 11], "x": 11.75, "y": 2 },
+ { "matrix": [2, 12], "w": 2.25, "x": 12.75, "y": 2 },
+ { "matrix": [2, 14], "x": 15.5, "y": 1 },
+ { "matrix": [3, 0], "w": 2.25, "x": 0, "y": 3 },
+ { "matrix": [3, 2], "x": 2.25, "y": 3 },
+ { "matrix": [3, 3], "x": 3.25, "y": 3 },
+ { "matrix": [3, 4], "x": 4.25, "y": 3 },
+ { "matrix": [3, 5], "x": 5.25, "y": 3 },
+ { "matrix": [3, 6], "x": 6.25, "y": 3 },
+ { "matrix": [3, 7], "x": 7.25, "y": 3 },
+ { "matrix": [3, 8], "x": 8.25, "y": 3 },
+ { "matrix": [3, 9], "x": 9.25, "y": 3 },
+ { "matrix": [3, 10], "x": 10.25, "y": 3 },
+ { "matrix": [3, 11], "x": 11.25, "y": 3 },
+ { "matrix": [4, 12], "w": 1.75, "x": 12.25, "y": 3 },
+ { "matrix": [3, 13], "x": 14.25, "y": 3 },
+ { "matrix": [3, 14], "x": 15.5, "y": 3 },
+ { "matrix": [4, 0], "w": 1.25, "x": 0, "y": 4 },
+ { "matrix": [4, 1], "w": 1.25, "x": 1.25, "y": 4 },
+ { "matrix": [4, 2], "w": 1.25, "x": 2.5, "y": 4 },
+ { "matrix": [4, 5], "w": 6.25, "x": 3.75, "y": 4 },
+ { "matrix": [4, 8], "w": 1, "x": 10, "y": 4 },
+ { "matrix": [4, 9], "w": 1, "x": 11, "y": 4 },
+ { "matrix": [4, 10], "w": 1.25, "x": 12, "y": 4 },
+ { "matrix": [4, 11], "x": 13.5, "y": 4 },
+ { "matrix": [4, 13], "x": 14.5, "y": 4 },
+ { "matrix": [4, 14], "x": 15.5, "y": 4 }
+ ]
+ }
+ }
+}

keyboards/phentech/rpk_001/keymaps/default/keymap.c

@@ -0,0 +1,36 @@
+// Copyright 2023 JoyLee (@itarze)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ /*
+ * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐ ┌────┐
+ * │Esc│ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ Backsp│ │Mute│
+ * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤ ├────┤
+ * │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ \ │ │Del │
+ * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤ ├────┤
+ * │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ Enter │ │Home│
+ * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─────┬──┘ ├────┤
+ * │ Shift │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ Shift │ ┌───┐ │End │
+ * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬┴───┬───┘ │ ↑ │ └────┘
+ * │Ctrl│GUI │Alt │ │Alt│Ctl│ FN │ ┌───┼───┼───┐
+ * └────┴────┴────┴────────────────────────┴───┴───┴────┘ │ ← │ ↓ │ → │
+ * └───┴───┴───┘
+ */
+ [0] = LAYOUT(
+ KC_ESC, 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_MUTE,
+ 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_DEL,
+ 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_HOME,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_END,
+ KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RCTL, MO(1), KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [1] = LAYOUT(
+ QK_BOOT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, RGB_TOG, RGB_MOD, RGB_RMOD, RGB_SPI, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+ )
+};

keyboards/phentech/rpk_001/keymaps/via/keymap.c

@@ -0,0 +1,44 @@
+// Copyright 2023 JoyLee (@itarze)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ /*
+ * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐ ┌────┐
+ * │Esc│ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ Backsp│ │Mute│
+ * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤ ├────┤
+ * │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ \ │ │Del │
+ * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤ ├────┤
+ * │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ Enter │ │Home│
+ * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─────┬──┘ ├────┤
+ * │ Shift │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ Shift │ ┌───┐ │End │
+ * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬┴───┬───┘ │ ↑ │ └────┘
+ * │Ctrl│GUI │Alt │ │Alt│Ctl│ FN │ ┌───┼───┼───┐
+ * └────┴────┴────┴────────────────────────┴───┴───┴────┘ │ ← │ ↓ │ → │
+ * └───┴───┴───┘
+ */
+ [0] = LAYOUT(
+ KC_ESC, 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_MUTE,
+ 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_DEL,
+ 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, KC_UP, KC_PGDN,
+ KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RCTL, MO(1), KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [1] = LAYOUT(
+ QK_BOOT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, NK_TOGG, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, RGB_TOG, RGB_MOD, RGB_RMOD, RGB_SPI, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, GU_TOGG, _______, _______, _______, _______, _______, _______, _______, _______
+ )
+};
+
+/* encoder; start */
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+ [0] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+ [1] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }
+};
+#endif

keyboards/phentech/rpk_001/keymaps/via/rules.mk

@@ -0,0 +1,2 @@
+ENCODER_MAP_ENABLE = yes
+VIA_ENABLE = yes

keyboards/phentech/rpk_001/mcuconf.h

@@ -0,0 +1,9 @@
+// Copyright 2023 JoyLee (@itarze)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include_next <mcuconf.h>
+
+#undef WB32_SPI_USE_QSPI
+#define WB32_SPI_USE_QSPI TRUE

keyboards/phentech/rpk_001/readme.md

@@ -0,0 +1,25 @@
+
+# RPK-001
+
+[![p9HNfPg.png](https://s1.ax1x.com/2023/05/25/p9HNfPg.png)](https://imgse.com/i/p9HNfPg)
+
+* Keyboard Maintainer: [JoyLee](https://github.com/itarze)
+* Hardware Supported: RPK-001 PCB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make phentech/rpk_001:default
+
+Flashing example for this keyboard:
+
+ make phentech/rpk_001: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available