Add ProtoKeeb keyboard request

keyboards/protokeeb/info.json

@@ -0,0 +1,11 @@
+{
+    "keyboard_name": "Protokeeb",
+    "manufacturer": "A-Tech Officials",
+    "maintainer": "atechofficials",
+    "url": "https://github.com/atechofficials/protokeeb",
+    "bootloader_instructions": "Press and hold the FN Key (row-4, column-1) then press the key mapped to `QK_BOOT` i.e ENTER Key (row-4, column-4) to enter the bootloader mode.",
+    "tags": ["rgb", "4x4"],
+    "usb": {
+        "vid": "0x419A"
+    }
+}

keyboards/protokeeb/keymaps/default/keymap.c

@@ -0,0 +1,51 @@
+/* Protokeeb Copyright 2024 A-Tech Officials (@atechofficials)
+ * 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 3 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 <https://www.gnu.org/licenses/gpl-3.0.html>.
+ */
+
+/* Protokeeb v1.0
+ * Keymap: Default
+ */
+
+#include QMK_KEYBOARD_H
+
+enum protokeeb_keymap_layers {
+    LAYER_BASE,
+    LAYER_LOWER,
+};
+
+#define LOWER LT(LAYER_LOWER, KC_KP_0)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+	[LAYER_BASE] = LAYOUT_custom_matrix( /* Base */
+	KC_KP_7, KC_KP_8, KC_KP_9, KC_KP_SLASH, KC_MUTE,
+	KC_KP_4, KC_KP_5, KC_KP_6, KC_KP_ASTERISK,
+	KC_KP_1, KC_KP_2, KC_KP_3, KC_KP_MINUS,
+	LOWER, KC_KP_DOT, KC_KP_ENTER, KC_KP_PLUS
+	),
+
+	[LAYER_LOWER] = LAYOUT_custom_matrix( /* RGB Control */
+	RGB_MODE_PLAIN, RGB_MODE_FORWARD, RGB_MODE_REVERSE, RGB_TOG, KC_MUTE,
+	RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD,
+	RGB_VAI, RGB_VAD, RGB_SPI, RGB_SPD,
+	KC_TRNS, RGB_MODE_SWIRL, QK_DEBUG_TOGGLE, QK_BOOT
+	),
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [LAYER_BASE] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [LAYER_LOWER] = { ENCODER_CCW_CW(KC_BRIGHTNESS_DOWN, KC_BRIGHTNESS_UP) },
+};
+#endif

keyboards/protokeeb/keymaps/default/rules.mk

@@ -0,0 +1,8 @@
+# Build Options Protokeeb rev1
+# Change yes to no to disable features
+
+# Rotary Encoder Keymap support
+ENCODER_MAP_ENABLE = yes
+
+# DIP Switch Keymap support
+DIP_SWITCH_MAP_ENABLE = no

keyboards/protokeeb/keymaps/midi/config.h

@@ -0,0 +1,19 @@
+/* Protokeeb Copyright 2024 A-Tech Officials (@atechofficials)
+ * 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 3 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 <https://www.gnu.org/licenses/gpl-3.0.html>.
+ */
+
+#pragma once
+
+#define MIDI_BASIC

keyboards/protokeeb/keymaps/midi/keymap.c

@@ -0,0 +1,72 @@
+/* Protokeeb Copyright 2024 A-Tech Officials (@atechofficials)
+ * 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 3 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 <https://www.gnu.org/licenses/gpl-3.0.html>.
+ */
+
+/* Protokeeb v1.0
+ * Keymap: MIDI
+ */
+
+#include QMK_KEYBOARD_H
+
+enum protokeeb_keymap_layers {
+    LAYER_NOTES_SET_1,
+    LAYER_NOTES_SET_2,
+    LAYER_NOTES_SET_3,
+    LAYER_RGB_CONTROL,
+};
+
+#define NOTES_SET_1 TG(LAYER_NOTES_SET_1)
+#define NOTES_SET_2 TG(LAYER_NOTES_SET_2)
+#define NOTES_SET_3 TG(LAYER_NOTES_SET_3)
+#define RGB_CTRL MO(LAYER_RGB_CONTROL)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+	[LAYER_NOTES_SET_1] = LAYOUT_custom_matrix( /* Notes Set-1 */
+	MI_C, MI_Cs, MI_D, MI_Ds, KC_MUTE,
+	MI_E, MI_F, MI_Fs, MI_G,
+	MI_Gs, MI_A, MI_As, MI_B,
+	RGB_CTRL, NOTES_SET_2, NOTES_SET_3, MI_TOGG
+	),
+
+  [LAYER_NOTES_SET_2] = LAYOUT_custom_matrix( /* Notes Set-2 */
+	MI_C1, MI_Cs1, MI_D1, MI_Ds1, KC_MUTE,
+	MI_E1, MI_F1, MI_Fs1, MI_G1,
+	MI_Gs1, MI_A1, MI_As1, MI_B1,
+	NOTES_SET_1, KC_TRNS, NOTES_SET_3, KC_TRNS
+	),
+
+	[LAYER_NOTES_SET_3] = LAYOUT_custom_matrix( /* Notes Set-3 */
+	MI_C2, MI_Cs2, MI_D2, MI_Ds2, KC_MUTE,
+	MI_E2, MI_F2, MI_Fs2, MI_G2,
+	MI_Gs2, MI_A2, MI_As2, MI_B2,
+	NOTES_SET_1, NOTES_SET_2, KC_TRNS, KC_TRNS
+	),
+
+	[LAYER_RGB_CONTROL] = LAYOUT_custom_matrix( /* RGB Control */
+	RGB_MODE_PLAIN, RGB_MODE_FORWARD, RGB_MODE_REVERSE, RGB_TOG, KC_MUTE,
+	RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD,
+	RGB_VAI, RGB_VAD, RGB_SPI, RGB_SPD,
+	KC_TRNS, KC_TRNS, KC_TRNS, QK_BOOT
+	),
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [LAYER_NOTES_SET_1] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [LAYER_NOTES_SET_2] = { ENCODER_CCW_CW(MI_OCTD, MI_OCTU) },
+		[LAYER_NOTES_SET_3] = { ENCODER_CCW_CW(MI_TRSD, MI_TRSU) },
+		[LAYER_RGB_CONTROL] = { ENCODER_CCW_CW(RGB_HUD, RGB_HUI) },
+};
+#endif

keyboards/protokeeb/keymaps/midi/rules.mk

@@ -0,0 +1,11 @@
+# Build Options
+# Change yes to no to disable feature
+
+# Enable MIDI support
+MIDI_ENABLE = yes
+
+# Rotary Encoder Keymap support
+ENCODER_MAP_ENABLE = yes
+
+# DIP Switch Keymap support
+DIP_SWITCH_MAP_ENABLE = no

keyboards/protokeeb/keymaps/via/keymap.c

@@ -0,0 +1,51 @@
+/* Protokeeb Copyright 2024 A-Tech Officials (@atechofficials)
+ * 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 3 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 <https://www.gnu.org/licenses/gpl-3.0.html>.
+ */
+
+/* Protokeeb v1.0
+ * Keymap: Via
+ */
+
+#include QMK_KEYBOARD_H
+
+enum protokeeb_keymap_layers {
+    LAYER_BASE,
+    LAYER_LOWER,
+};
+
+#define LOWER LT(LAYER_LOWER, KC_KP_0)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+	[LAYER_BASE] = LAYOUT_custom_matrix( /* Base */
+	  KC_KP_7, KC_KP_8, KC_KP_9, KC_KP_SLASH, KC_MUTE,
+	  KC_KP_4, KC_KP_5, KC_KP_6, KC_KP_ASTERISK,
+	  KC_KP_1, KC_KP_2, KC_KP_3, KC_KP_MINUS,
+	  LOWER, KC_KP_DOT, KC_KP_ENTER, KC_KP_PLUS
+	),
+
+	[LAYER_LOWER] = LAYOUT_custom_matrix( /* RGB Control */
+	  RGB_MODE_PLAIN, RGB_MODE_FORWARD, RGB_MODE_REVERSE, RGB_TOG, KC_MUTE,
+	  RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD,
+	  RGB_VAI, RGB_VAD, RGB_SPI, RGB_SPD,
+	  KC_TRNS, RGB_MODE_SWIRL, QK_DEBUG_TOGGLE, QK_BOOT
+	),
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [LAYER_BASE] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [LAYER_LOWER] = { ENCODER_CCW_CW(KC_BRIGHTNESS_DOWN, KC_BRIGHTNESS_UP) }
+};
+#endif

keyboards/protokeeb/keymaps/via/rules.mk

@@ -0,0 +1,11 @@
+# Build Options Protokeeb rev1
+# Change yes to no to disable features
+
+# Enable Via support
+VIA_ENABLE = yes
+
+# Rotary Encoder Keymap support
+ENCODER_MAP_ENABLE = yes
+
+# DIP Switch Keymap support
+DIP_SWITCH_MAP_ENABLE = no

keyboards/protokeeb/rev1/config.h

@@ -0,0 +1,55 @@
+/* Protokeeb Copyright 2024 A-Tech Officials (@atechofficials)
+ * 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 3 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 <https://www.gnu.org/licenses/gpl-3.0.html>.
+ */
+
+#pragma once
+
+// Define the pin connected to the encoder push button
+#define ENCODER_BUTTON_PIN GP14
+
+// Define the row and column for the encoder button
+#define ENCODER_BUTTON_ROW 0
+#define ENCODER_BUTTON_COL 4
+
+/* ARGB LED Byte order */
+#define WS2812_BYTE_ORDER WS2812_BYTE_ORDER_RGB
+
+/* Peripheral used */
+#define WS2812_PIO_USE_PIO1
+
+/* RGB lighting effects and animations settings */
+#define RGBLIGHT_EFFECT_BREATHE_MAX 127
+#define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 40
+#define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
+#define RGBLIGHT_EFFECT_KNIGHT_LED_NUM 4
+#define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3
+#define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0
+#define RGBLIGHT_EFFECT_SWIRL_RANGE 255
+#define RGBLIGHT_EFFECT_SNAKE_LENGTH 4
+#define RGBLIGHT_EFFECT_TWINKLE_LIFE 200
+#define RGBLIGHT_EFFECT_TWINKLE_PROBABILITY 1/127
+
+/* Double tap reset bootloader entry */
+#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET
+
+/* Bootloader timeout window in milli-seconds */
+#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET_TIMEOUT 200U
+
+/* LED to blink when entering bootloader mode */
+#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET_LED GP25
+
+#if defined (ENCODER_ENABLE)
+#define ENCODER_MAP_KEY_DELAY 10
+#endif

keyboards/protokeeb/rev1/keyboard.json

@@ -0,0 +1,88 @@
+{
+    "audio": {
+        "default": {
+            "on": false
+        },
+        "pins": ["GP22"]
+    },
+    "board": "GENERIC_RP_RP2040",
+    "bootloader": "rp2040",
+    "debounce": 20,
+    "diode_direction": "COL2ROW",
+    "encoder": {
+        "rotary": [{ "pin_a": "GP12", "pin_b": "GP13", "resolution": 2 }]
+    },
+    "features": {
+        "bootmagic": true,
+        "encoder": true,
+        "extrakey": true,
+        "nkro": true,
+        "rgblight": true
+    },
+    "matrix_pins": {
+        "cols": ["GP6", "GP7", "GP8", "GP9", "GP14"],
+        "rows": ["GP2", "GP3", "GP4", "GP5"]
+    },
+    "processor": "RP2040",
+    "rgblight": {
+        "animations": {
+            "alternating": true,
+            "breathing": true,
+            "christmas": true,
+            "knight": true,
+            "rainbow_mood": true,
+            "rainbow_swirl": true,
+            "rgb_test": true,
+            "snake": true,
+            "static_gradient": true,
+            "twinkle": true
+        },
+        "brightness_steps": 15,
+        "default": {
+            "animation": "static_light",
+            "hue": 0,
+            "on": true,
+            "sat": 255,
+            "speed": 0,
+            "val": 50
+        },
+        "driver": "ws2812",
+        "hue_steps": 15,
+        "led_count": 4,
+        "led_map": [3, 2, 1, 0],
+        "max_brightness": 127,
+        "saturation_steps": 15,
+        "sleep": true
+    },
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0x1717"
+    },
+    "ws2812": {
+        "driver": "vendor",
+        "pin": "GP10"
+    },
+    "layouts": {
+        "LAYOUT_custom_matrix": {
+            "layout": [
+                { "label": "7", "matrix": [0, 0], "x": 0, "y": 0 },
+                { "label": "8", "matrix": [0, 1], "x": 1, "y": 0 },
+                { "label": "9", "matrix": [0, 2], "x": 2, "y": 0 },
+                { "label": "/", "matrix": [0, 3], "x": 3, "y": 0 },
+                { "label": "MUTE", "matrix": [0, 4], "x": 4, "y": 0 },
+                { "label": "4", "matrix": [1, 0], "x": 0, "y": 1 },
+                { "label": "5", "matrix": [1, 1], "x": 1, "y": 1 },
+                { "label": "6", "matrix": [1, 2], "x": 2, "y": 1 },
+                { "label": "*", "matrix": [1, 3], "x": 3, "y": 1 },
+                { "label": "1", "matrix": [2, 0], "x": 0, "y": 2 },
+                { "label": "2", "matrix": [2, 1], "x": 1, "y": 2 },
+                { "label": "3", "matrix": [2, 2], "x": 2, "y": 2 },
+                { "label": "-", "matrix": [2, 3], "x": 3, "y": 2 },
+                { "label": "0", "matrix": [3, 0], "x": 0, "y": 3 },
+                { "label": ".", "matrix": [3, 1], "x": 1, "y": 3 },
+                { "label": "ENTER", "matrix": [3, 2], "x": 2, "y": 3 },
+                { "label": "+", "matrix": [3, 3], "x": 3, "y": 3 }
+            ]
+        }
+    }
+}