[Keyboard] KeebMonkey KBMG68 (#15909)

* added KeebMonkey KBMG68. * Update keyboards/keebmonkey/kbmg68/config.h * changes requested by fauxpark . * Apply suggestions from code review changes suggested by fauxpark * Update readme.md changes requested by fauxpark * Apply suggestions from code review changes requested by noroadsleft. * Apply suggestions from code review per fauxpark
2022-07-16 14:03:39 -05:00 · 2022-07-16 14:03:39 -05:00 · 4d443d921b
commit 4d443d921b
parent 847cca541c
7 changed files with 298 additions and 0 deletions
--- a/keyboards/keebmonkey/kbmg68/config.h
+++ b/keyboards/keebmonkey/kbmg68/config.h
@ -0,0 +1,68 @@
+/* Copyright 2022 Your Mom Loves My Keyboard
+ *
+ * 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 "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x0000
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    KeebMonkey
+#define PRODUCT         kbmg68
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 16
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+ */
+#define MATRIX_ROW_PINS { B1, B2, B3, B4, B5 }
+#define MATRIX_COL_PINS { B6, B7, D0, D1, D2, D3, D4, D5, D6, D7, C6, C7, F7, F6, F5, F4 }
+
+#define DIODE_DIRECTION COL2ROW
+
+#define RGB_DI_PIN B0
+#ifdef RGB_DI_PIN
+    #define RGBLED_NUM 68
+    #define RGBLIGHT_HUE_STEP 8
+    #define RGBLIGHT_SAT_STEP 8
+    #define RGBLIGHT_VAL_STEP 8
+    #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
+    #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+#define RGBLIGHT_EFFECT_BREATHING
+#define RGBLIGHT_EFFECT_RAINBOW_MOOD
+#define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+#define RGBLIGHT_EFFECT_SNAKE
+#define RGBLIGHT_EFFECT_KNIGHT
+#define RGBLIGHT_EFFECT_CHRISTMAS
+#define RGBLIGHT_EFFECT_STATIC_GRADIENT
+#define RGBLIGHT_EFFECT_RGB_TEST
+#define RGBLIGHT_EFFECT_ALTERNATING
+#define RGBLIGHT_EFFECT_TWINKLE
+#endif
+
+// generated by KBFirmware JSON to QMK Parser
+// https://noroadsleft.github.io/kbf_qmk_converter/
--- a/keyboards/keebmonkey/kbmg68/info.json
+++ b/keyboards/keebmonkey/kbmg68/info.json
@ -0,0 +1,80 @@
+{
+    "keyboard_name": "kbmg68",
+    "url": "",
+    "maintainer": "qmk",
+    "layouts": {
+        "LAYOUT_65_ansi": {
+            "layout": [
+                { "label": "K00 (B1,B6)", "x": 0, "y": 0 },
+                { "label": "K01 (B1,B7)", "x": 1, "y": 0 },
+                { "label": "K02 (B1,D0)", "x": 2, "y": 0 },
+                { "label": "K03 (B1,D1)", "x": 3, "y": 0 },
+                { "label": "K04 (B1,D2)", "x": 4, "y": 0 },
+                { "label": "K05 (B1,D3)", "x": 5, "y": 0 },
+                { "label": "K06 (B1,D4)", "x": 6, "y": 0 },
+                { "label": "K07 (B1,D5)", "x": 7, "y": 0 },
+                { "label": "K08 (B1,D6)", "x": 8, "y": 0 },
+                { "label": "K09 (B1,D7)", "x": 9, "y": 0 },
+                { "label": "K0A (B1,C6)", "x": 10, "y": 0 },
+                { "label": "K0B (B1,C7)", "x": 11, "y": 0 },
+                { "label": "K0C (B1,F7)", "x": 12, "y": 0 },
+                { "label": "K0E (B1,F5)", "x": 13, "y": 0, "w": 2 },
+                { "label": "K0F (B1,F4)", "x": 15, "y": 0 },
+                { "label": "K10 (B2,B6)", "x": 0, "y": 1, "w": 1.5 },
+                { "label": "K12 (B2,D0)", "x": 1.5, "y": 1 },
+                { "label": "K13 (B2,D1)", "x": 2.5, "y": 1 },
+                { "label": "K14 (B2,D2)", "x": 3.5, "y": 1 },
+                { "label": "K15 (B2,D3)", "x": 4.5, "y": 1 },
+                { "label": "K16 (B2,D4)", "x": 5.5, "y": 1 },
+                { "label": "K17 (B2,D5)", "x": 6.5, "y": 1 },
+                { "label": "K18 (B2,D6)", "x": 7.5, "y": 1 },
+                { "label": "K19 (B2,D7)", "x": 8.5, "y": 1 },
+                { "label": "K1A (B2,C6)", "x": 9.5, "y": 1 },
+                { "label": "K1B (B2,C7)", "x": 10.5, "y": 1 },
+                { "label": "K1C (B2,F7)", "x": 11.5, "y": 1 },
+                { "label": "K1D (B2,F6)", "x": 12.5, "y": 1 },
+                { "label": "K1E (B2,F5)", "x": 13.5, "y": 1, "w": 1.5 },
+                { "label": "K1F (B2,F4)", "x": 15, "y": 1 },
+                { "label": "K20 (B3,B6)", "x": 0, "y": 2, "w": 1.75 },
+                { "label": "K22 (B3,D0)", "x": 1.75, "y": 2 },
+                { "label": "K23 (B3,D1)", "x": 2.75, "y": 2 },
+                { "label": "K24 (B3,D2)", "x": 3.75, "y": 2 },
+                { "label": "K25 (B3,D3)", "x": 4.75, "y": 2 },
+                { "label": "K26 (B3,D4)", "x": 5.75, "y": 2 },
+                { "label": "K27 (B3,D5)", "x": 6.75, "y": 2 },
+                { "label": "K28 (B3,D6)", "x": 7.75, "y": 2 },
+                { "label": "K29 (B3,D7)", "x": 8.75, "y": 2 },
+                { "label": "K2A (B3,C6)", "x": 9.75, "y": 2 },
+                { "label": "K2B (B3,C7)", "x": 10.75, "y": 2 },
+                { "label": "K2C (B3,F7)", "x": 11.75, "y": 2 },
+                { "label": "K2D (B3,F6)", "x": 12.75, "y": 2, "w": 2.25 },
+                { "label": "K2F (B3,F4)", "x": 15, "y": 2 },
+                { "label": "K31 (B4,B7)", "x": 0, "y": 3, "w": 2.25 },
+                { "label": "K32 (B4,D0)", "x": 2.25, "y": 3 },
+                { "label": "K33 (B4,D1)", "x": 3.25, "y": 3 },
+                { "label": "K34 (B4,D2)", "x": 4.25, "y": 3 },
+                { "label": "K35 (B4,D3)", "x": 5.25, "y": 3 },
+                { "label": "K36 (B4,D4)", "x": 6.25, "y": 3 },
+                { "label": "K37 (B4,D5)", "x": 7.25, "y": 3 },
+                { "label": "K38 (B4,D6)", "x": 8.25, "y": 3 },
+                { "label": "K39 (B4,D7)", "x": 9.25, "y": 3 },
+                { "label": "K3A (B4,C6)", "x": 10.25, "y": 3 },
+                { "label": "K3B (B4,C7)", "x": 11.25, "y": 3 },
+                { "label": "K3D (B4,F6)", "x": 12.25, "y": 3, "w": 1.75 },
+                { "label": "K3E (B4,F5)", "x": 14, "y": 3 },
+                { "label": "K3F (B4,F4)", "x": 15, "y": 3 },
+                { "label": "K40 (B5,B6)", "x": 0, "y": 4, "w": 1.25 },
+                { "label": "K41 (B5,B7)", "x": 1.25, "y": 4, "w": 1.25 },
+                { "label": "K43 (B5,D1)", "x": 2.5, "y": 4, "w": 1.25 },
+                { "label": "K46 (B5,D4)", "x": 3.75, "y": 4, "w": 6.25 },
+                { "label": "K4A (B5,C6)", "x": 10, "y": 4 },
+                { "label": "K4B (B5,C7)", "x": 11, "y": 4 },
+                { "label": "K4C (B5,F7)", "x": 12, "y": 4 },
+                { "label": "K4D (B5,F6)", "x": 13, "y": 4 },
+                { "label": "K4E (B5,F5)", "x": 14, "y": 4 },
+                { "label": "K4F (B5,F4)", "x": 15, "y": 4 }
+            ]
+        }
+    }
+    ,"meta": "https://noroadsleft.github.io/kbf_qmk_converter/"
+}
--- a/keyboards/keebmonkey/kbmg68/kbmg68.c
+++ b/keyboards/keebmonkey/kbmg68/kbmg68.c
@ -0,0 +1,20 @@
+/* Copyright 2022 Your Mom Loves My Keyboard
+ *
+ * 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/>.
+ */
+
+#include "kbmg68.h"
+
+// generated by KBFirmware JSON to QMK Parser
+// https://noroadsleft.github.io/kbf_qmk_converter/
--- a/keyboards/keebmonkey/kbmg68/kbmg68.h
+++ b/keyboards/keebmonkey/kbmg68/kbmg68.h
@ -0,0 +1,38 @@
+/* Copyright 2022 Your Mom Loves My Keyboard
+ *
+ * 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 "quantum.h"
+
+#define XXX KC_NO
+
+#define LAYOUT_65_ansi( \
+    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0E, K0F, \
+    K10, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, K1E, K1F, \
+    K20, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C,      K2D, K2F, \
+    K31,      K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3D, K3E, K3F, \
+    K40, K41, K43,                K46,                K4A, K4B, K4C, K4D, K4E, K4F  \
+) { \
+    { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, XXX, K0E, K0F }, \
+    { K10, XXX, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, K1E, K1F }, \
+    { K20, XXX, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D, XXX, K2F }, \
+    { XXX, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, XXX, K3D, K3E, K3F }, \
+    { K40, K41, XXX, K43, XXX, XXX, K46, XXX, XXX, XXX, K4A, K4B, K4C, K4D, K4E, K4F }, \
+}
+
+// generated by KBFirmware JSON to QMK Parser
+// https://noroadsleft.github.io/kbf_qmk_converter/
--- a/keyboards/keebmonkey/kbmg68/keymaps/default/keymap.c
+++ b/keyboards/keebmonkey/kbmg68/keymaps/default/keymap.c
@ -0,0 +1,45 @@
+/* Copyright 2022 Your Mom Loves My Keyboard
+ *
+ * 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/>.
+ */
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    [0] = LAYOUT_65_ansi(
+        KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC, KC_GRV,  
+        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL,  
+        KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT,  KC_PGUP, 
+        KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_UP,   KC_PGDN, 
+        KC_LCTL, KC_LGUI, KC_LALT, KC_SPC,  KC_RALT, MO(1),   KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT  
+    ),
+
+    [1] = LAYOUT_65_ansi(
+        RGB_TOG, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, RGB_MOD, 
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RGB_VAI, _______, 
+        MO(2),   _______, _______, _______, _______, _______, _______, _______, RGB_VAD, _______  
+    ),
+
+    [2] = LAYOUT_65_ansi(
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET    
+    ),
+
+};
--- a/keyboards/keebmonkey/kbmg68/readme.md
+++ b/keyboards/keebmonkey/kbmg68/readme.md
@ -0,0 +1,27 @@
+# KBMG68
+
+![KBMG68](https://cdn.shopify.com/s/files/1/0463/5980/6101/products/IMG_2062_600x.jpg?v=1636042030)
+
+The Keebmonkey KBMG68 should be the cheapest gasket keyboard you can ever have. Both the plate and the PCB are gasket mounted, resulting in a deep thocky sound. The shell of the kit is made of 6-layers of acrylic boards, leaving huge space for modding and continuous improvements (even though this kit already sounds perfect when it's out of the box).
+
+* Keyboard Maintainer: Unknown
+* Hardware Supported: Unknown
+* Hardware Availability: [Keebmonkey KBMG68 Double Mounted Gasket Keyboard Kit](https://www.keebmonkey.com/products/kbmg68)
+
+## Instructions
+
+### Build
+
+Make example for this keyboard (after setting up your build environment):
+
+    make keebmonkey/kbmg68:default
+
+Flashing example for this keyboard:
+
+    make keebmonkey/kbmg68: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).
+
+### Reset to Bootloader
+
+Hold the Escape key while plugging the board in.
--- a/keyboards/keebmonkey/kbmg68/rules.mk
+++ b/keyboards/keebmonkey/kbmg68/rules.mk
@ -0,0 +1,20 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no       # Mouse keys
+EXTRAKEY_ENABLE = no       # Audio control and System control
+CONSOLE_ENABLE = no        # Console for debug
+COMMAND_ENABLE = no        # Commands for debug and configuration
+NKRO_ENABLE = no            # Enable N-Key Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output
+
+LAYOUTS = 65_ansi