[Keyboard] Add BINEPAD BNK9 (#22831)

keyboards/binepad/bnk9/config.h

@@ -0,0 +1,12 @@
+// Copyright 2023 binepad (@binepad)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define ENCODER_DEFAULT_POS 0x3  // enable 1:1 resolution
+
+// Default PIO0 cases flickering in this board.  Setting to PIO1 resolves this issue.
+#define WS2812_PIO_USE_PIO1
+
+// Timing for SK6812
+#define WS2812_T1H 650

keyboards/binepad/bnk9/info.json

@@ -0,0 +1,86 @@
+{
+    "manufacturer": "binepad",
+    "keyboard_name": "BNK9",
+    "maintainer": "binepad",
+    "board": "GENERIC_RP_RP2040",
+    "bootloader": "rp2040",
+    "bootloader_instructions": "Hold down the key at (0x0) in the matrix (the 'knob' / rotary encoder) and plug in the keyboard.",
+    "diode_direction": "COL2ROW",
+    "encoder": {
+        "rotary": [
+            {"pin_a": "GP13", "pin_b": "GP14"}
+        ]
+    },
+    "features": {
+        "bootmagic": true,
+        "encoder": true,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgb_matrix": true
+    },
+    "matrix_pins": {
+        "cols": ["GP1", "GP2", "GP3"],
+        "rows": ["GP12", "GP4", "GP5", "GP6"]
+    },
+    "processor": "RP2040",
+    "rgb_matrix": {
+        "animations": {
+            "breathing": true,
+            "cycle_all": true,
+            "cycle_left_right": true,
+            "cycle_pinwheel": true,
+            "cycle_up_down": true,
+            "jellybean_raindrops": true,
+            "riverflow": true,
+            "solid_reactive": true,
+            "solid_reactive_simple": true,
+            "solid_splash": true,
+            "splash": true,
+            "starlight": true,
+            "starlight_dual_hue": true,
+            "starlight_dual_sat": true
+        },
+        "driver": "ws2812",
+        "layout": [
+            {"matrix": [1, 0], "x": 80, "y": 0, "flags": 4},
+            {"matrix": [1, 1], "x": 112, "y": 0, "flags": 4},
+            {"matrix": [1, 2], "x": 144, "y": 0, "flags": 4},
+            {"matrix": [2, 2], "x": 144, "y": 32, "flags": 4},
+            {"matrix": [2, 1], "x": 112, "y": 32, "flags": 4},
+            {"matrix": [2, 0], "x": 80, "y": 32, "flags": 4},
+            {"matrix": [3, 0], "x": 80, "y": 64, "flags": 4},
+            {"matrix": [3, 1], "x": 112, "y": 64, "flags": 4},
+            {"matrix": [3, 2], "x": 144, "y": 64, "flags": 4}
+        ],
+        "led_process_limit": 9,
+        "max_brightness": 180,
+        "sleep": true
+    },
+    "url": "https://www.binepad.com/product-page/bnk9",
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0x4E39",
+        "vid": "0x4249"
+    },
+    "ws2812": {
+        "driver": "vendor",
+        "pin": "GP11"
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"label": "Knob", "matrix": [0, 0], "x": 0, "y": 0, "w": 3, "h": 3, "encoder": 0},
+                {"label": "1", "matrix": [1, 0], "x": 3.25, "y": 0},
+                {"label": "2", "matrix": [1, 1], "x": 4.25, "y": 0},
+                {"label": "3", "matrix": [1, 2], "x": 5.25, "y": 0},
+                {"label": "4", "matrix": [2, 0], "x": 3.25, "y": 1},
+                {"label": "5", "matrix": [2, 1], "x": 4.25, "y": 1},
+                {"label": "6", "matrix": [2, 2], "x": 5.25, "y": 1},
+                {"label": "7", "matrix": [3, 0], "x": 3.25, "y": 2},
+                {"label": "8", "matrix": [3, 1], "x": 4.25, "y": 2},
+                {"label": "9", "matrix": [3, 2], "x": 5.25, "y": 2}
+            ]
+        }
+    }
+}

keyboards/binepad/bnk9/keymaps/default/keymap.c

@@ -0,0 +1,28 @@
+// Copyright 2023 Binepad (@binpad)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        KC_MUTE,
+        KC_P1,    KC_P2,    KC_P3,
+        KC_P4,    KC_P5,    KC_P6,
+        KC_P7,    KC_P8,    LT(1, KC_P9)
+    ),
+    [1] = LAYOUT(
+        RGB_TOG,
+        RGB_HUI,  RGB_SAI,  RGB_SPI,
+        RGB_HUD,  RGB_SAD,  RGB_SPD,
+        RGB_RMOD, RGB_MOD,  _______
+    )
+};
+
+#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(RGB_VAD, RGB_VAI) }
+};
+
+#endif

keyboards/binepad/bnk9/keymaps/default/rules.mk

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

keyboards/binepad/bnk9/keymaps/via/keymap.c

@@ -0,0 +1,28 @@
+// Copyright 2023 Binepad (@binpad)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        KC_MUTE,
+        KC_P1,    KC_P2,    KC_P3,
+        KC_P4,    KC_P5,    KC_P6,
+        KC_P7,    KC_P8,    LT(1, KC_P9)
+    ),
+    [1] = LAYOUT(
+        RGB_TOG,
+        RGB_HUI,  RGB_SAI,  RGB_SPI,
+        RGB_HUD,  RGB_SAD,  RGB_SPD,
+        RGB_RMOD, RGB_MOD,  _______
+    )
+};
+
+#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(RGB_VAD, RGB_VAI) }
+};
+
+#endif

keyboards/binepad/bnk9/keymaps/via/rules.mk

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

keyboards/binepad/bnk9/readme.md

@@ -0,0 +1,27 @@
+# BINEPAD BNK9
+
+![BINEPAD BNK9](https://i.imgur.com/FrkVRhhh.jpg)
+
+A 3x3 macropad with a large rotary encoder.
+
+* Keyboard Maintainer: [binepad](https://github.com/binepad)
+* Hardware Supported: BINPAD BNK9
+* Hardware Availability: [binepad.com](https://www.binepad.com/product-page/bnk9)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make binepad/bnk9:default
+
+Flashing example for this keyboard:
+
+    make binepad/bnk9: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 (0x0) in the matrix (the 'knob' / rotary encoder) and plug in the keyboard.
+* **Physical reset button**: Briefly press the PCB button located on the back of the PCB.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` *(or* `RESET` *in VIA)* if it is available.

keyboards/binepad/bnk9/rules.mk

@@ -0,0 +1 @@
+# This file intentionally left blank