[Keyboard] Add Binepad BNK8 keyboard (#24598)

* Add Binepad BNK8 keyboard * Moved keymap.c to keymap.json * Fix product page URL * RGB_ -> RM_ keycodes after this round of breaking changes Co-authored-by: Ryan <[email protected]> --------- Co-authored-by: Ryan <[email protected]>
qmk · Dec 4, 2024 · 3c324cb · 3c324cb
1 parent d01303c
commit 3c324cb
Show file tree

Hide file tree

Showing 4 changed files with 161 additions and 0 deletions.
diff --git a/keyboards/binepad/bnk8/config.h b/keyboards/binepad/bnk8/config.h
@@ -0,0 +1,7 @@
+// Copyright 2024 binepad (@binepad)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+// Timing for SK6812
+#define WS2812_T1H 650
diff --git a/keyboards/binepad/bnk8/keyboard.json b/keyboards/binepad/bnk8/keyboard.json
@@ -0,0 +1,88 @@
+{
+    "manufacturer": "binepad",
+    "keyboard_name": "BNK8",
+    "maintainer": "binepad",
+    "bootloader": "stm32duino",
+    "bootloader_instructions": "Hold down the key at (0x0) in the matrix (the top left key) and plug in the keyboard.",
+    "diode_direction": "COL2ROW",
+    "encoder": {
+        "rotary": [
+            {"pin_a": "A7", "pin_b": "A0", "resolution": 2}
+        ]
+    },
+    "features": {
+        "bootmagic": true,
+        "encoder": true,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgb_matrix": true
+    },
+    "matrix_pins": {
+        "cols": ["B3", "B4", "C13"],
+        "rows": ["C14", "B13", "B12"]
+    },
+    "processor": "STM32F103",
+    "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": [0, 0], "x": 80, "y": 0, "flags": 4},
+            {"matrix": [0, 1], "x": 112, "y": 0, "flags": 4},
+            {"matrix": [1, 0], "x": 80, "y": 32, "flags": 4},
+            {"matrix": [1, 1], "x": 112, "y": 32, "flags": 4},
+            {"matrix": [1, 2], "x": 144, "y": 32, "flags": 4},
+            {"matrix": [2, 0], "x": 80, "y": 64, "flags": 4},
+            {"matrix": [2, 1], "x": 112, "y": 64, "flags": 4},
+            {"matrix": [2, 2], "x": 144, "y": 64, "flags": 4}
+        ],
+        "led_process_limit": 9,
+        "max_brightness": 180,
+        "sleep": true
+    },
+    "url": "https://www.binepad.com/product-page/bnk8",
+    "usb": {
+        "device_version": "1.0.0",
+        "vid": "0x4249",
+        "pid": "0x4E41"
+    },
+    "eeprom": {
+        "wear_leveling": {
+            "backing_size": 1024
+        }
+    },
+    "ws2812": {
+        "pin": "C15"
+    },
+    "community_layouts": ["ortho_3x3"],
+    "layouts": {
+        "LAYOUT_ortho_3x3": {
+            "layout": [
+                {"label": "1", "matrix": [0, 0], "x": 0, "y": 0},
+                {"label": "2", "matrix": [0, 1], "x": 1, "y": 0},
+                {"label": "Knob", "matrix": [0, 2], "x": 2, "y": 0, "encoder": 0},
+                {"label": "3", "matrix": [1, 0], "x": 0, "y": 1},
+                {"label": "4", "matrix": [1, 1], "x": 1, "y": 1},
+                {"label": "5", "matrix": [1, 2], "x": 2, "y": 1},
+                {"label": "6", "matrix": [2, 0], "x": 0, "y": 2},
+                {"label": "7", "matrix": [2, 1], "x": 1, "y": 2},
+                {"label": "8", "matrix": [2, 2], "x": 2, "y": 2}
+            ]
+        }
+    }
+}
diff --git a/keyboards/binepad/bnk8/keymaps/default/keymap.json b/keyboards/binepad/bnk8/keymaps/default/keymap.json
@@ -0,0 +1,40 @@
+{
+    "keyboard": "binepad/bnk8",
+    "version": 1,
+    "author": "binepad",
+    "notes": "Copyright 2024 Binepad (@binepad) \n SPDX-License-Identifier: GPL-2.0-or-later \n This file is a keymap.json file for binepad/bnk8",
+    "keymap": "default",
+    "layout": "LAYOUT_ortho_3x3",
+    "layers": [
+        [
+            "KC_P1", "KC_P2", "KC_MUTE",
+            "KC_P3", "KC_P4", "KC_P5",
+            "KC_P6", "KC_P7", "LT(1, KC_P8)"
+        ],
+        [
+            "RM_HUEU", "RM_SATU", "RM_SPDU",
+            "RM_HUED", "RM_SATD", "RM_SPDD",
+            "RM_TOGG", "RM_NEXT", "_______"
+
+        ]
+    ],
+    "config": {
+        "features": {
+            "encoder_map": true
+        }
+    },
+    "encoders": [
+        [
+            {
+                "ccw": "KC_VOLD",
+                "cw": "KC_VOLU"
+            }
+        ],
+        [
+            {
+                "ccw": "RM_VALD",
+                "cw": "RM_VALU"
+            }
+        ]
+    ]
+}
diff --git a/keyboards/binepad/bnk8/readme.md b/keyboards/binepad/bnk8/readme.md
@@ -0,0 +1,26 @@
+# BINEPAD BNK8
+
+![BINEPAD BNK8](https://i.imgur.com/HFIZg48h.jpeg)
+
+A compact 8-key 3x3 macropad with a rotary encoder at the top right.
+
+* Keyboard Maintainer: [binepad](https://github.com/binepad)
+* Hardware Supported: BINPAD BNK8
+* Hardware Availability: [binepad.com](https://binepad.com/products/bnk8)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make binepad/bnk8:default
+
+Flashing example for this keyboard:
+
+    make binepad/bnk8: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 2 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key) and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available