[Keyboard] ErgoStrafer RGB (#22936)

* adding ergostrafer rgb * removing comment
qmk · Jun 16, 2024 · ad82c47 · ad82c47
1 parent 0262161
commit ad82c47
Show file tree

Hide file tree

Showing 11 changed files with 355 additions and 0 deletions.
diff --git a/keyboards/custommk/ergostrafer_rgb/config.h b/keyboards/custommk/ergostrafer_rgb/config.h
@@ -0,0 +1,28 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+// FRAM configuration
+#define EXTERNAL_EEPROM_SPI_SLAVE_SELECT_PIN B7
+#define EXTERNAL_EEPROM_SPI_CLOCK_DIVISOR 4 // 48MHz / 4 = 12MHz; max supported by MB85R64 is 20MHz
+
+// SPI configuration
+#define SPI_DRIVER SPID1
+#define SPI_SCK_PIN B3
+#define SPI_MOSI_PIN B5
+#define SPI_MISO_PIN B4
+
+// Audio configuration
+#define AUDIO_PIN B8
+#define AUDIO_PWM_DRIVER PWMD4
+#define AUDIO_PWM_CHANNEL 3 
+#define AUDIO_PWM_PAL_MODE 2
+#define AUDIO_STATE_TIMER GPTD5
+#define AUDIO_INIT_DELAY
+
+#define WS2812_PWM_DRIVER PWMD1
+#define WS2812_PWM_CHANNEL 3
+#define WS2812_PWM_PAL_MODE 1
+#define WS2812_DMA_STREAM STM32_DMA2_STREAM5
+#define WS2812_DMA_CHANNEL 6
diff --git a/keyboards/custommk/ergostrafer_rgb/halconf.h b/keyboards/custommk/ergostrafer_rgb/halconf.h
@@ -0,0 +1,30 @@
+/* Copyright 2024 customMK
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#define HAL_USE_PWM TRUE
+
+#define HAL_USE_SPI TRUE
+
+#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD
+
+#define SERIAL_BUFFERS_SIZE 256
+
+// This enables interrupt-driven mode
+#define SPI_USE_WAIT TRUE
+
+#include_next <halconf.h>
diff --git a/keyboards/custommk/ergostrafer_rgb/info.json b/keyboards/custommk/ergostrafer_rgb/info.json
@@ -0,0 +1,189 @@
+{
+    "manufacturer": "customMK",
+    "keyboard_name": "ErgoStrafer RGB",
+    "maintainer": "customMK",
+    "bootloader": "stm32-dfu",
+    "diode_direction": "ROW2COL",
+    "dynamic_keymap": {
+        "layer_count": 32
+    },
+    "eeprom": {
+        "driver": "spi"
+    },
+    "encoder": {
+        "rotary": [
+            {"pin_a": "A8", "pin_b": "A4", "resolution": 2},
+            {"pin_a": "B12", "pin_b": "B14", "resolution": 2},
+            {"pin_a": "B15", "pin_b": "A15", "resolution": 2}
+        ]
+    },
+    "features": {
+        "audio": true,
+        "bootmagic": true,
+        "encoder": true,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgb_matrix": true
+    },
+    "matrix_pins": {
+        "cols": ["B0", "A1", "A2", "A3", "A6", "B6", "B10"],
+        "rows": ["C13", "C14", "C15", "B1", "A7", "A5"]
+    },
+    "processor": "STM32F411",
+    "qmk": {
+        "tap_keycode_delay": 10
+    },
+    "rgb_matrix": {
+        "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],
+        "driver": "ws2812",
+        "layout": [
+            {"matrix": [0, 1], "x": 32, "y": 45, "flags": 4},
+            {"matrix": [0, 2], "x": 57, "y": 40, "flags": 4},
+            {"matrix": [0, 3], "x": 83, "y": 38, "flags": 4},
+            {"matrix": [0, 4], "x": 109, "y": 40, "flags": 4},
+            {"matrix": [0, 5], "x": 134, "y": 45, "flags": 4},
+            {"x": 136, "y": 18, "flags": 4},
+            {"matrix": [0, 0], "x": 167, "y": 11, "flags": 4},
+            {"matrix": [1, 0], "x": 170, "y": 33, "flags": 4},
+            {"matrix": [2, 0], "x": 174, "y": 54, "flags": 4},
+            {"x": 195, "y": 57, "flags": 4},
+            {"x": 211, "y": 81, "flags": 4},
+            {"x": 193, "y": 90, "flags": 4},
+            {"matrix": [0, 6], "x": 171, "y": 90, "flags": 4},
+            {"matrix": [2, 5], "x": 143, "y": 90, "flags": 4},
+            {"matrix": [1, 5], "x": 140, "y": 67, "flags": 4},
+            {"matrix": [1, 4], "x": 118, "y": 61, "flags": 4},
+            {"matrix": [2, 3], "x": 95, "y": 58, "flags": 4},
+            {"matrix": [1, 3], "x": 71, "y": 58, "flags": 4},
+            {"matrix": [1, 2], "x": 48, "y": 61, "flags": 4},
+            {"matrix": [1, 1], "x": 26, "y": 67, "flags": 4},
+            {"matrix": [3, 0], "x": 0, "y": 90, "flags": 4},
+            {"matrix": [2, 1], "x": 23, "y": 90, "flags": 4},
+            {"matrix": [2, 2], "x": 52, "y": 87, "flags": 4},
+            {"matrix": [3, 3], "x": 83, "y": 85, "flags": 4},
+            {"matrix": [2, 4], "x": 114, "y": 87, "flags": 4},
+            {"matrix": [3, 5], "x": 139, "y": 113, "flags": 4},
+            {"matrix": [1, 6], "x": 167, "y": 114, "flags": 4},
+            {"x": 207, "y": 112, "flags": 4},
+            {"matrix": [5, 6], "x": 224, "y": 146, "flags": 4},
+            {"matrix": [3, 6], "x": 184, "y": 147, "flags": 4},
+            {"matrix": [2, 6], "x": 156, "y": 147, "flags": 4},
+            {"matrix": [4, 5], "x": 127, "y": 135, "flags": 4},
+            {"matrix": [3, 4], "x": 111, "y": 112, "flags": 4},
+            {"matrix": [4, 3], "x": 83, "y": 112, "flags": 4},
+            {"matrix": [3, 2], "x": 55, "y": 112, "flags": 4},
+            {"matrix": [3, 1], "x": 20, "y": 114, "flags": 4},
+            {"matrix": [4, 1], "x": 15, "y": 138, "flags": 4},
+            {"matrix": [5, 1], "x": 14, "y": 162, "flags": 4},
+            {"matrix": [4, 2], "x": 52, "y": 137, "flags": 4},
+            {"matrix": [5, 3], "x": 83, "y": 139, "flags": 4},
+            {"x": 83, "y": 164, "flags": 4},
+            {"x": 104, "y": 144, "flags": 4},
+            {"matrix": [5, 5], "x": 121, "y": 173, "flags": 4},
+            {"matrix": [4, 6], "x": 167, "y": 173, "flags": 4}
+        ],
+        "max_brightness": 120,
+        "sat_steps": 8,
+        "speed_steps": 10,
+        "val_steps": 8
+    },
+    "url": "https://shop.custommk.com/collections/ergostrafer/products/ergostrafer",
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0xFAB9",
+        "vid": "0xF35B"
+    },
+    "ws2812": {
+        "driver": "pwm",
+        "pin": "A10"
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"label": "F9", "matrix": [0, 0], "x": 7.5, "y": 0},
+                {"label": "7", "matrix": [0, 1], "x": 1.5, "y": 1.25},
+                {"label": "8", "matrix": [0, 2], "x": 2.5, "y": 1.25},
+                {"label": "9", "matrix": [0, 3], "x": 3.5, "y": 1.25},
+                {"label": "0", "matrix": [0, 4], "x": 4.5, "y": 1.25},
+                {"label": "-", "matrix": [0, 5], "x": 5.5, "y": 1.25},
+                {"label": "T", "matrix": [0, 6], "x": 7.25, "y": 3.25, "w": 1.5},
+                {"label": "PrtScr", "matrix": [1, 0], "x": 7.5, "y": 1},
+                {"label": "1", "matrix": [1, 1], "x": 1, "y": 2.25},
+                {"label": "2", "matrix": [1, 2], "x": 2, "y": 2.25},
+                {"label": "3", "matrix": [1, 3], "x": 3, "y": 2.25},
+                {"label": "5", "matrix": [1, 4], "x": 5, "y": 2.25},
+                {"label": "6", "matrix": [1, 5], "x": 6, "y": 2.25},
+                {"label": "G", "matrix": [1, 6], "x": 7.25, "y": 4.25, "w": 1.5},
+                {"label": "F5", "matrix": [2, 0], "x": 7.5, "y": 2},
+                {"label": "Tab", "matrix": [2, 1], "x": 1, "y": 3.5},
+                {"label": "Q", "matrix": [2, 2], "x": 2.5, "y": 3.4},
+                {"label": "4", "matrix": [2, 3], "x": 4, "y": 2.25},
+                {"label": "E", "matrix": [2, 4], "x": 4.5, "y": 3.4},
+                {"label": "R", "matrix": [2, 5], "x": 6, "y": 3.3},
+                {"label": "B", "matrix": [2, 6], "x": 6.5, "y": 5.75, "w": 1.5},
+                {"label": "Caps Lock", "matrix": [3, 0], "x": 0, "y": 3.5},
+                {"label": "L Alt", "matrix": [3, 1], "x": 0.25, "y": 4.75, "w": 1.5},
+                {"label": "A", "matrix": [3, 2], "x": 2.5, "y": 4.5},
+                {"label": "W", "matrix": [3, 3], "x": 3.5, "y": 3.4},
+                {"label": "D", "matrix": [3, 4], "x": 4.5, "y": 4.5},
+                {"label": "F", "matrix": [3, 5], "x": 6, "y": 4.3},
+                {"label": "P", "matrix": [3, 6], "x": 8, "y": 5.75},
+                {"label": "L Shift", "matrix": [4, 1], "x": 0.25, "y": 5.75, "w": 1.5},
+                {"label": "Z", "matrix": [4, 2], "x": 2.5, "y": 5.6},
+                {"label": "S", "matrix": [4, 3], "x": 3.5, "y": 4.5},
+                {"label": "V", "matrix": [4, 5], "x": 5, "y": 5.75, "w": 1.5},
+                {"label": "Space", "matrix": [4, 6], "x": 6.5, "y": 6.85, "w": 1.75},
+                {"label": "L Ctrl Duck", "matrix": [5, 1], "x": 0.25, "y": 6.75, "w": 1.5},
+                {"label": "X", "matrix": [5, 3], "x": 3.5, "y": 5.6},
+                {"label": "C", "matrix": [5, 5], "x": 4.75, "y": 6.85, "w": 1.75},
+                {"label": "L Ctrl", "matrix": [5, 6], "x": 9.5, "y": 5.75}
+            ]
+        }
+    }
+}
diff --git a/keyboards/custommk/ergostrafer_rgb/keymaps/default/keymap.c b/keyboards/custommk/ergostrafer_rgb/keymaps/default/keymap.c
@@ -0,0 +1,21 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        KC_F9,   KC_7,    KC_8, KC_9,   KC_0,   KC_MINUS, KC_T,
+        KC_PSCR, KC_1,    KC_2, KC_3,   KC_5,   KC_6,     KC_G,
+        KC_F5,   KC_TAB,  KC_Q, KC_4,   KC_E,   KC_R,     KC_B,
+        KC_CAPS, KC_LALT, KC_A, KC_W,   KC_D,   KC_F,     KC_P,
+        KC_LSFT, KC_Z,    KC_S, KC_V,   KC_SPC,
+        KC_LCTL, KC_X,    KC_C, KC_LCTL
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [0] =   { ENCODER_CCW_CW(KC_VOLD, KC_VOLU), ENCODER_CCW_CW(KC_VOLD, KC_VOLU), ENCODER_CCW_CW(KC_VOLD, KC_VOLU) }
+};
+#endif
diff --git a/keyboards/custommk/ergostrafer_rgb/keymaps/default/rules.mk b/keyboards/custommk/ergostrafer_rgb/keymaps/default/rules.mk
@@ -0,0 +1 @@
+ENCODER_MAP_ENABLE = yes
diff --git a/keyboards/custommk/ergostrafer_rgb/keymaps/via/config.h b/keyboards/custommk/ergostrafer_rgb/keymaps/via/config.h
@@ -0,0 +1,6 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define DYNAMIC_KEYMAP_MACRO_COUNT 128
diff --git a/keyboards/custommk/ergostrafer_rgb/keymaps/via/keymap.c b/keyboards/custommk/ergostrafer_rgb/keymaps/via/keymap.c
@@ -0,0 +1,19 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        KC_F9,   KC_7,    KC_8, KC_9,   KC_0,   KC_MINUS, KC_T,
+        KC_PSCR, KC_1,    KC_2, KC_3,   KC_5,   KC_6,     KC_G,
+        KC_F5,   KC_TAB,  KC_Q, KC_4,   KC_E,   KC_R,     KC_B,
+        KC_CAPS, KC_LALT, KC_A, KC_W,   KC_D,   KC_F,     KC_P,
+        KC_LSFT, KC_Z,    KC_S, KC_V,   KC_SPC,
+        KC_LCTL, KC_X,    KC_C, KC_LCTL
+    )
+};
+
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [0] =   { ENCODER_CCW_CW(KC_VOLD, KC_VOLU), ENCODER_CCW_CW(KC_VOLD, KC_VOLU), ENCODER_CCW_CW(KC_VOLD, KC_VOLU) }
+};
diff --git a/keyboards/custommk/ergostrafer_rgb/keymaps/via/rules.mk b/keyboards/custommk/ergostrafer_rgb/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+ENCODER_MAP_ENABLE = yes
diff --git a/keyboards/custommk/ergostrafer_rgb/mcuconf.h b/keyboards/custommk/ergostrafer_rgb/mcuconf.h
@@ -0,0 +1,31 @@
+/* Copyright 2024 customMK
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include_next <mcuconf.h>
+
+// Used for audio
+#undef STM32_PWM_USE_TIM4
+#define STM32_PWM_USE_TIM4 TRUE
+
+// Used for FRAM
+#undef STM32_SPI_USE_SPI1
+#define STM32_SPI_USE_SPI1 TRUE
+
+// Used for RGB matrix
+#undef STM32_PWM_USE_TIM1
+#define STM32_PWM_USE_TIM1 TRUE
diff --git a/keyboards/custommk/ergostrafer_rgb/readme.md b/keyboards/custommk/ergostrafer_rgb/readme.md
@@ -0,0 +1,27 @@
+# ergostrafer rgb
+
+![ergostrafer rgb](https://i.imgur.com/3LZImFwh.jpeg)
+
+ErgoStrafer RGB is a gaming mechanical keyboard with per-key RGB LEDs that reproduces the layout of the discontinued SteelSeries Merc Stealth a.k.a. Zboard.
+
+* Keyboard Maintainer: [customMK](https://github.com/customMK)
+* Hardware Supported: ErgoStrafer RGB
+* Hardware Availability: [customMK](https://shop.custommk.com/collections/ergostrafer/products/ergostrafer)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make custommk/ergostrafer_rgb:default
+
+Flashing example for this keyboard:
+
+    make custommk/ergostrafer_rgb: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 (the "Load" key in the top right corner) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
diff --git a/keyboards/custommk/ergostrafer_rgb/rules.mk b/keyboards/custommk/ergostrafer_rgb/rules.mk
@@ -0,0 +1 @@
+AUDIO_DRIVER = pwm_hardware