[Keyboard] Add/Update Pimoroni keybow 2040 (qmk#23986)

* [Keyboard] Add pimoroni/keybow2040 * [Keyboard] Update pimoroni/keybow2040 Co-Authored-By: Less/Rikki <[email protected]> Co-Authored-By: Joel Challis <[email protected]> Co-Authored-By: Sandy Macdonald <[email protected]> --------- Co-authored-by: Tony Finch <[email protected]> Co-authored-by: Less/Rikki <[email protected]> Co-authored-by: Joel Challis <[email protected]> Co-authored-by: Sandy Macdonald <[email protected]>
stanrc85 · Aug 15, 2024 · fe50774 · fe50774
1 parent 39324e6
commit fe50774
Show file tree

Hide file tree

Showing 9 changed files with 300 additions and 0 deletions.
diff --git a/keyboards/pimoroni/keybow2040/config.h b/keyboards/pimoroni/keybow2040/config.h
@@ -0,0 +1,17 @@
+// Copyright 2024 QMK Collaborators (@qmk)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET
+
+#define IS31FL3731_I2C_ADDRESS_1 IS31FL3731_I2C_ADDRESS_GND
+
+#define I2C_DRIVER I2CD0
+#define I2C1_SDA_PIN GP4
+#define I2C1_SCL_PIN GP5
+#define I2C1_CLOCK_SPEED 100000
+
+#ifdef RGB_MATRIX_ENABLE
+    #define RGB_MATRIX_SLEEP
+#endif
diff --git a/keyboards/pimoroni/keybow2040/halconf.h b/keyboards/pimoroni/keybow2040/halconf.h
@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define HAL_USE_I2C TRUE
+
+#include_next <halconf.h>
diff --git a/keyboards/pimoroni/keybow2040/keyboard.json b/keyboards/pimoroni/keybow2040/keyboard.json
@@ -0,0 +1,119 @@
+{
+    "manufacturer": "Pimoroni",
+    "keyboard_name": "Keybow 2040",
+    "url": "https://shop.pimoroni.com/products/keybow-2040",
+    "maintainer": "fanf2",
+    "processor": "RP2040",
+    "bootloader": "rp2040",
+    "board": "GENERIC_RP_RP2040",
+    "features": {
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgb_matrix": true
+    },
+    "usb": {
+        "device_version": "1.0.0",
+        "vid": "0x5069",
+        "pid": "0x4784"
+    },
+    "rgb_matrix": {
+        "driver": "is31fl3731",
+        "animations": {
+            "alphas_mods": true,
+            "band_pinwheel_sat": true,
+            "band_pinwheel_val": true,
+            "band_sat": true,
+            "band_spiral_sat": true,
+            "band_spiral_val": true,
+            "band_val": true,
+            "breathing": true,
+            "cycle_all": true,
+            "cycle_left_right": true,
+            "cycle_out_in": true,
+            "cycle_out_in_dual": true,
+            "cycle_pinwheel": true,
+            "cycle_spiral": true,
+            "cycle_up_down": true,
+            "digital_rain": true,
+            "dual_beacon": true,
+            "gradient_left_right": true,
+            "gradient_up_down": true,
+            "hue_breathing": true,
+            "hue_pendulum": true,
+            "hue_wave": true,
+            "jellybean_raindrops": true,
+            "multisplash": true,
+            "pixel_flow": true,
+            "pixel_fractal": true,
+            "pixel_rain": true,
+            "rainbow_beacon": true,
+            "rainbow_moving_chevron": true,
+            "rainbow_pinwheels": true,
+            "raindrops": true,
+            "solid_multisplash": true,
+            "solid_reactive": true,
+            "solid_reactive_cross": true,
+            "solid_reactive_multicross": true,
+            "solid_reactive_multinexus": true,
+            "solid_reactive_multiwide": true,
+            "solid_reactive_nexus": true,
+            "solid_reactive_simple": true,
+            "solid_reactive_wide": true,
+            "solid_splash": true,
+            "splash": true,
+            "typing_heatmap": true
+        },
+        "center_point": [112, 112],
+        "layout": [
+            {"matrix": [0, 0], "x": 0, "y": 0, "flags": 4},
+            {"matrix": [0, 1], "x": 75, "y": 0, "flags": 4},
+            {"matrix": [0, 2], "x": 150, "y": 0, "flags": 4},
+            {"matrix": [0, 3], "x": 224, "y": 0, "flags": 4},
+            {"matrix": [1, 0], "x": 0, "y": 75, "flags": 4},
+            {"matrix": [1, 1], "x": 75, "y": 75, "flags": 4},
+            {"matrix": [1, 2], "x": 150, "y": 75, "flags": 4},
+            {"matrix": [1, 3], "x": 224, "y": 75, "flags": 4},
+            {"matrix": [2, 0], "x": 0, "y": 150, "flags": 4},
+            {"matrix": [2, 1], "x": 75, "y": 150, "flags": 4},
+            {"matrix": [2, 2], "x": 150, "y": 150, "flags": 4},
+            {"matrix": [2, 3], "x": 224, "y": 150, "flags": 4},
+            {"matrix": [3, 0], "x": 0, "y": 224, "flags": 4},
+            {"matrix": [3, 1], "x": 75, "y": 224, "flags": 4},
+            {"matrix": [3, 2], "x": 150, "y": 224, "flags": 4},
+            {"matrix": [3, 3], "x": 224, "y": 224, "flags": 4}
+        ]
+    },
+    "matrix_pins": {
+        "direct": [
+            ["GP18", "GP14", "GP10", "GP6"],
+            ["GP19", "GP15", "GP11", "GP7"],
+            ["GP20", "GP16", "GP12", "GP8"],
+            ["GP21", "GP17", "GP13", "GP9"],
+            ["GP23", null, null, null]
+        ]
+    },
+    "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": [1, 0], "x": 0, "y": 1},
+                {"matrix": [1, 1], "x": 1, "y": 1},
+                {"matrix": [1, 2], "x": 2, "y": 1},
+                {"matrix": [1, 3], "x": 3, "y": 1},
+                {"matrix": [2, 0], "x": 0, "y": 2},
+                {"matrix": [2, 1], "x": 1, "y": 2},
+                {"matrix": [2, 2], "x": 2, "y": 2},
+                {"matrix": [2, 3], "x": 3, "y": 2},
+                {"matrix": [3, 0], "x": 0, "y": 3},
+                {"matrix": [3, 1], "x": 1, "y": 3},
+                {"matrix": [3, 2], "x": 2, "y": 3},
+                {"matrix": [3, 3], "x": 3, "y": 3},
+                {"matrix": [4, 0], "x": 0, "y": 4}
+            ]
+        }
+    }
+}
diff --git a/keyboards/pimoroni/keybow2040/keybow2040.c b/keyboards/pimoroni/keybow2040/keybow2040.c
@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "quantum.h"
+
+#ifdef RGB_MATRIX_ENABLE
+const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {
+    /* driver, r, g, b */
+    { 0, C8_9,  C6_9,  C7_9  }, // LEDB12 0,0
+    { 0, C9_9,  C3_9,  C5_9  }, // LEDB11 1,0
+    { 0, C8_1,  C6_1,  C7_1  }, // LEDA12 2,0
+    { 0, C9_1,  C3_1,  C5_1  }, // LEDA11 3,0
+    { 0, C8_10, C6_10, C7_10 }, // LEDB22 0,1
+    { 0, C9_10, C3_10, C5_10 }, // LEDB21 1,1
+    { 0, C8_2,  C6_2,  C7_2  }, // LEDA22 2,1
+    { 0, C9_2,  C3_2,  C5_2  }, // LEDA21 3,1
+    { 0, C8_11, C6_11, C7_11 }, // LEDB32 0,2
+    { 0, C9_11, C2_10, C5_11 }, // LEDB31 1,2
+    { 0, C8_3,  C6_3,  C7_3  }, // LEDA32 2,2
+    { 0, C9_3,  C2_2,  C5_3  }, // LEDA31 3,2
+    { 0, C8_12, C6_12, C7_12 }, // LEDB42 0,3
+    { 0, C9_12, C2_11, C5_12 }, // LEDB41 1,3
+    { 0, C8_4,  C6_4,  C7_4  }, // LEDA42 2,3
+    { 0, C9_4,  C2_3,  C5_4  }, // LEDA41 3,3
+};
+#endif
diff --git a/keyboards/pimoroni/keybow2040/keymaps/acc/keymap.json b/keyboards/pimoroni/keybow2040/keymaps/acc/keymap.json
@@ -0,0 +1,28 @@
+{
+    "keyboard": "pimoroni/keybow2040",
+    "author": "willoucom",
+    "version": 1,
+    "keymap": "acc",
+    "config": {
+        "features": {
+            "via": true
+        }
+    },
+    "layout": "LAYOUT",
+    "layers": [
+        [
+            "KC_F13",        "KC_F14",            "KC_F15",          "KC_F16",
+            "KC_AUDIO_MUTE", "KC_AUDIO_VOL_DOWN", "KC_AUDIO_VOL_UP", "KC_AUDIO_MUTE",
+            "LSFT(KC_A)",    "LSFT(KC_T)",        "LSFT(KC_Y)",      "LSFT(KC_B)",
+            "LCTL(KC_A)",    "LCTL(KC_T)",        "LCTL(KC_Y)",      "LCTL(KC_B)",
+            "TO(1)"
+        ],
+        [
+            "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT",
+            "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT",
+            "RGB_SAD",        "RGB_SAI",        "RGB_HUD",        "RGB_HUI",
+            "KC_TRANSPARENT", "RGB_TOG",        "RGB_RMOD",       "RGB_MOD",
+            "TO(0)"
+        ]
+    ]
+}
diff --git a/keyboards/pimoroni/keybow2040/keymaps/default/keymap.json b/keyboards/pimoroni/keybow2040/keymaps/default/keymap.json
@@ -0,0 +1,23 @@
+{
+    "keyboard": "pimoroni/keybow2040",
+    "author": "fanf2",
+    "version": 1,
+    "keymap": "default",
+    "layout": "LAYOUT",
+    "layers": [
+        [
+            "KC_F13",  "KC_F14",  "KC_F15",  "KC_F16",
+            "KC_F17",  "KC_F18",  "KC_F19",  "KC_F20",
+            "KC_HOME", "KC_UP",   "KC_END",  "KC_PGUP",
+            "KC_LEFT", "KC_DOWN", "KC_RIGHT","KC_PGDN",
+            "TO(1)"
+        ],
+        [
+            "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT",
+            "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT",
+            "RGB_SAD",        "RGB_SAI",        "RGB_HUD",        "RGB_HUI",
+            "KC_TRANSPARENT", "RGB_TOG",        "RGB_RMOD",       "RGB_MOD",
+            "TO(0)"
+        ]
+    ]
+}
diff --git a/keyboards/pimoroni/keybow2040/keymaps/via/keymap.json b/keyboards/pimoroni/keybow2040/keymaps/via/keymap.json
@@ -0,0 +1,28 @@
+{
+    "keyboard": "pimoroni/keybow2040",
+    "author": "fanf2",
+    "version": 1,
+    "keymap": "via",
+    "config": {
+        "features": {
+            "via": true
+        }
+    },
+    "layout": "LAYOUT",
+    "layers": [
+        [
+            "KC_F13",  "KC_F14",  "KC_F15",   "KC_F16",
+            "KC_F17",  "KC_F18",  "KC_F19",   "KC_F20",
+            "KC_HOME", "KC_UP",   "KC_END",   "KC_PGUP",
+            "KC_LEFT", "KC_DOWN", "KC_RIGHT", "KC_PGDN",
+            "TO(1)"
+        ],
+        [
+            "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT",
+            "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT", "KC_TRANSPARENT",
+            "RGB_SAD",        "RGB_SAI",        "RGB_HUD",        "RGB_HUI",
+            "KC_TRANSPARENT", "RGB_TOG",        "RGB_RMOD",       "RGB_MOD",
+            "TO(0)"
+        ]
+    ]
+}
diff --git a/keyboards/pimoroni/keybow2040/mcuconf.h b/keyboards/pimoroni/keybow2040/mcuconf.h
@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include_next <mcuconf.h>
+#undef RP_I2C_USE_I2C0
+#define RP_I2C_USE_I2C0 TRUE
+
+#undef RP_I2C_USE_I2C1
+#define RP_I2C_USE_I2C1 FALSE
diff --git a/keyboards/pimoroni/keybow2040/readme.md b/keyboards/pimoroni/keybow2040/readme.md
@@ -0,0 +1,43 @@
+# Keybow 2040
+
+![Keybow 2040 board](https://i.imgur.com/WDGDOkb.jpeg)
+
+The [Pimoroni Keybow 2040](https://shop.pimoroni.com/products/keybow-2040) is a 16 key mechanical macropad
+controlled by a Raspberry Pi RP2040, with Kailh hot swap sockets and
+per key RGB lighting, in a decorative FR4 sandwich. The Keybow 2040 is
+also known by its codename Venus Dust, or its product codes of the
+form PIM56x.
+
+* Original Keyboard Maintainer: [Tony Finch](https://github.com/fanf2)
+* Keyboard Maintainer: [Wilfried Jeanniard](https://github.com/willoucom) and [Sandy Macdonald](https://github.com/sandyjmacdonald)
+* Hardware Supported: Keybow 2040
+* Hardware Availability: [Pimoroni](https://shop.pimoroni.com/products/keybow-2040)
+
+## Usage
+
+The bootloader button is used to switch from one layer to another, the first layer is used for macros and shortcuts, while the second layer controls RGB lights. You can modify this behavior using the QMK configurator.
+
+## Build
+
+Make example for this keyboard (after setting up your build environment):
+
+    make pimoroni/keybow2040:default
+
+Flashing example for this keyboard:
+
+    make pimoroni/keybow2040: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 top left key and plug in the keyboard
+* **Physical reset button**: Hold down BOOTSEL while pressing RESET
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available