From 6edcbdca19aa75051392998c06464a97b0899bbe Mon Sep 17 00:00:00 2001
From: James Young <18669334+noroadsleft@users.noreply.github.com>
Date: Wed, 24 Mar 2021 02:07:12 -0700
Subject: [PATCH] [Keyboard] YMDK YM68 (#12352)
* [Keyboard] YMDK YM68
Converted from a KBFirmware JSON file provided via the vendor's product listing.
PCB supports Backlight on B6 and RGB Underglow on E2, but the LEDs are not pre-soldered according to the PCB photos.
* update VENDOR_ID and PRODUCT_ID
---
keyboards/ymdk/ym68/config.h | 71 +++++++++++++++++
keyboards/ymdk/ym68/info.json | 83 ++++++++++++++++++++
keyboards/ymdk/ym68/keymaps/default/keymap.c | 34 ++++++++
keyboards/ymdk/ym68/readme.md | 24 ++++++
keyboards/ymdk/ym68/rules.mk | 22 ++++++
keyboards/ymdk/ym68/ym68.c | 17 ++++
keyboards/ymdk/ym68/ym68.h | 35 +++++++++
7 files changed, 286 insertions(+)
create mode 100644 keyboards/ymdk/ym68/config.h
create mode 100644 keyboards/ymdk/ym68/info.json
create mode 100644 keyboards/ymdk/ym68/keymaps/default/keymap.c
create mode 100644 keyboards/ymdk/ym68/readme.md
create mode 100644 keyboards/ymdk/ym68/rules.mk
create mode 100644 keyboards/ymdk/ym68/ym68.c
create mode 100644 keyboards/ymdk/ym68/ym68.h
diff --git a/keyboards/ymdk/ym68/config.h b/keyboards/ymdk/ym68/config.h
new file mode 100644
index 000000000..30d6b4c68
--- /dev/null
+++ b/keyboards/ymdk/ym68/config.h
@@ -0,0 +1,71 @@
+/* Copyright 2021 James Young (@noroadsleft)
+ *
+ * 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 .
+ */
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0x594D // "YM"
+#define PRODUCT_ID 0xD896
+#define DEVICE_VER 0x0001
+#define MANUFACTURER YMDK
+#define PRODUCT YM68
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 15
+
+/*
+ * 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 { B0, B1, B2, B3, B7 }
+#define MATRIX_COL_PINS { D0, D1, D2, D3, D5, D4, D6, D7, B4, F7, F6, F5, F4, F1, F0 }
+
+#define DIODE_DIRECTION ROW2COL
+
+#define BACKLIGHT_PIN B6
+#define BACKLIGHT_BREATHING
+#define BACKLIGHT_LEVELS 5
+
+#define RGB_DI_PIN E2
+#if defined(RGBLIGHT_ENABLE)
+ #define RGBLED_NUM 20
+ #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 */
+/*== all animations enable ==*/
+ #define RGBLIGHT_ANIMATIONS
+// /*== or choose animations ==*/
+// #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
+#endif
diff --git a/keyboards/ymdk/ym68/info.json b/keyboards/ymdk/ym68/info.json
new file mode 100644
index 000000000..ee218f773
--- /dev/null
+++ b/keyboards/ymdk/ym68/info.json
@@ -0,0 +1,83 @@
+{
+ "keyboard_name": "YM68",
+ "url": "",
+ "maintainer": "qmk",
+ "width": 16,
+ "height": 5,
+ "layouts": {
+ "LAYOUT_all": {
+ "layout": [
+ {"label":"K00 (B0,D0)", "x":0, "y":0},
+ {"label":"K01 (B0,D1)", "x":1, "y":0},
+ {"label":"K02 (B0,D2)", "x":2, "y":0},
+ {"label":"K03 (B0,D3)", "x":3, "y":0},
+ {"label":"K04 (B0,D5)", "x":4, "y":0},
+ {"label":"K05 (B0,D4)", "x":5, "y":0},
+ {"label":"K06 (B0,D6)", "x":6, "y":0},
+ {"label":"K07 (B0,D7)", "x":7, "y":0},
+ {"label":"K08 (B0,B4)", "x":8, "y":0},
+ {"label":"K09 (B0,F7)", "x":9, "y":0},
+ {"label":"K0A (B0,F6)", "x":10, "y":0},
+ {"label":"K0B (B0,F5)", "x":11, "y":0},
+ {"label":"K0C (B0,F4)", "x":12, "y":0},
+ {"label":"K0D (B0,F1)", "x":13, "y":0},
+ {"label":"K0E (B0,F0)", "x":14, "y":0},
+ {"label":"K4E (B7,F0)", "x":15, "y":0},
+ {"label":"K10 (B1,D0)", "x":0, "y":1, "w":1.5},
+ {"label":"K11 (B1,D1)", "x":1.5, "y":1},
+ {"label":"K12 (B1,D2)", "x":2.5, "y":1},
+ {"label":"K13 (B1,D3)", "x":3.5, "y":1},
+ {"label":"K14 (B1,D5)", "x":4.5, "y":1},
+ {"label":"K15 (B1,D4)", "x":5.5, "y":1},
+ {"label":"K16 (B1,D6)", "x":6.5, "y":1},
+ {"label":"K17 (B1,D7)", "x":7.5, "y":1},
+ {"label":"K18 (B1,B4)", "x":8.5, "y":1},
+ {"label":"K19 (B1,F7)", "x":9.5, "y":1},
+ {"label":"K1A (B1,F6)", "x":10.5, "y":1},
+ {"label":"K1B (B1,F5)", "x":11.5, "y":1},
+ {"label":"K1C (B1,F4)", "x":12.5, "y":1},
+ {"label":"K2C (B2,F4)", "x":13.5, "y":1, "w":1.5},
+ {"label":"K1E (B1,F0)", "x":15, "y":1},
+ {"label":"K20 (B2,D0)", "x":0, "y":2, "w":1.75},
+ {"label":"K21 (B2,D1)", "x":1.75, "y":2},
+ {"label":"K22 (B2,D2)", "x":2.75, "y":2},
+ {"label":"K23 (B2,D3)", "x":3.75, "y":2},
+ {"label":"K24 (B2,D5)", "x":4.75, "y":2},
+ {"label":"K25 (B2,D4)", "x":5.75, "y":2},
+ {"label":"K26 (B2,D6)", "x":6.75, "y":2},
+ {"label":"K27 (B2,D7)", "x":7.75, "y":2},
+ {"label":"K28 (B2,B4)", "x":8.75, "y":2},
+ {"label":"K29 (B2,F7)", "x":9.75, "y":2},
+ {"label":"K2A (B2,F6)", "x":10.75, "y":2},
+ {"label":"K2B (B2,F5)", "x":11.75, "y":2},
+ {"label":"K1D (B1,F1)", "x":12.75, "y":2, "w":2.25},
+ {"label":"K2E (B2,F0)", "x":15, "y":2},
+ {"label":"K30 (B3,D0)", "x":0, "y":3, "w":1.25},
+ {"label":"K31 (B3,D1)", "x":1.25, "y":3},
+ {"label":"K32 (B3,D2)", "x":2.25, "y":3},
+ {"label":"K33 (B3,D3)", "x":3.25, "y":3},
+ {"label":"K34 (B3,D5)", "x":4.25, "y":3},
+ {"label":"K35 (B3,D4)", "x":5.25, "y":3},
+ {"label":"K36 (B3,D6)", "x":6.25, "y":3},
+ {"label":"K37 (B3,D7)", "x":7.25, "y":3},
+ {"label":"K38 (B3,B4)", "x":8.25, "y":3},
+ {"label":"K39 (B3,F7)", "x":9.25, "y":3},
+ {"label":"K3A (B3,F6)", "x":10.25, "y":3},
+ {"label":"K3B (B3,F5)", "x":11.25, "y":3},
+ {"label":"K3C (B3,F4)", "x":12.25, "y":3, "w":1.75},
+ {"label":"K3D (B3,F1)", "x":14, "y":3},
+ {"label":"K3E (B3,F0)", "x":15, "y":3},
+ {"label":"K40 (B7,D0)", "x":0, "y":4, "w":1.25},
+ {"label":"K41 (B7,D1)", "x":1.25, "y":4, "w":1.25},
+ {"label":"K42 (B7,D2)", "x":2.5, "y":4, "w":1.25},
+ {"label":"K46 (B7,D6)", "x":3.75, "y":4, "w":6.25},
+ {"label":"K48 (B7,B4)", "x":10, "y":4},
+ {"label":"K49 (B7,F7)", "x":11, "y":4},
+ {"label":"K4A (B7,F6)", "x":12, "y":4},
+ {"label":"K4B (B7,F5)", "x":13, "y":4},
+ {"label":"K4C (B7,F4)", "x":14, "y":4},
+ {"label":"K4D (B7,F1)", "x":15, "y":4}
+ ]
+ }
+ }
+}
diff --git a/keyboards/ymdk/ym68/keymaps/default/keymap.c b/keyboards/ymdk/ym68/keymaps/default/keymap.c
new file mode 100644
index 000000000..1293cf9f9
--- /dev/null
+++ b/keyboards/ymdk/ym68/keymaps/default/keymap.c
@@ -0,0 +1,34 @@
+/* Copyright 2021 James Young (@noroadsleft)
+ *
+ * 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 .
+ */
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [0] = LAYOUT_all(
+ 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_GRV, KC_BSPC, KC_DEL,
+ 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_PGUP,
+ 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_PGDN,
+ KC_LSFT, KC_NUBS, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, MO(1),
+ KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+ [1] = LAYOUT_all(
+ RESET, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, KC_PSCR,
+ RGB_TOG, _______, KC_UP, _______, RGB_MOD, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME,
+ BL_TOGG, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, _______, KC_END,
+ _______, _______, _______, BL_DEC, BL_TOGG, BL_INC, _______, _______, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+ ),
+};
diff --git a/keyboards/ymdk/ym68/readme.md b/keyboards/ymdk/ym68/readme.md
new file mode 100644
index 000000000..5437375df
--- /dev/null
+++ b/keyboards/ymdk/ym68/readme.md
@@ -0,0 +1,24 @@
+# YM68
+
+
+
+A 65% keyboard kit with support for in-switch LEDs and RGB Underglow.
+
+* Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
+* Hardware Supported: YMDK YM68 PCB (ATmega32U4)
+* Hardware Availability: [AliExpress](https://www.aliexpress.com/i/32999629504.html), [ymdkey.com](https://ymdkey.com/collections/68-71-keyboard-diy/products/ymdk-fully-programmable-68-cnc-aluminum-case-plate-pcb-stabilizers-mechanical-keyboard-diy-kit?variant=30994625232957)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ymdk/ym68:default
+
+Flashing example for this keyboard:
+
+ make ymdk/ym68:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Tap the Reset switch mounted on the bottom side of the PCB
+* Hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings)
+
+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).
diff --git a/keyboards/ymdk/ym68/rules.mk b/keyboards/ymdk/ym68/rules.mk
new file mode 100644
index 000000000..a48a691a9
--- /dev/null
+++ b/keyboards/ymdk/ym68/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = no # Console for debug
+COMMAND_ENABLE = no # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = no # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
diff --git a/keyboards/ymdk/ym68/ym68.c b/keyboards/ymdk/ym68/ym68.c
new file mode 100644
index 000000000..3ec4d97b2
--- /dev/null
+++ b/keyboards/ymdk/ym68/ym68.c
@@ -0,0 +1,17 @@
+/* Copyright 2021 James Young (@noroadsleft)
+ *
+ * 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 .
+ */
+
+#include "ym68.h"
diff --git a/keyboards/ymdk/ym68/ym68.h b/keyboards/ymdk/ym68/ym68.h
new file mode 100644
index 000000000..42b2a990c
--- /dev/null
+++ b/keyboards/ymdk/ym68/ym68.h
@@ -0,0 +1,35 @@
+/* Copyright 2021 James Young (@noroadsleft)
+ *
+ * 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 .
+ */
+
+#pragma once
+
+#include "quantum.h"
+
+#define ___ KC_NO
+
+#define LAYOUT_all( \
+ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K0E, K4E, \
+ K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K2C, K1E, \
+ K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K1D, K2E, \
+ K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E, \
+ K40, K41, K42, K46, K48, K49, K4A, K4B, K4C, K4D \
+) { \
+ { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K0E }, \
+ { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, K1E }, \
+ { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, ___, K2E }, \
+ { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E }, \
+ { K40, K41, K42, ___, ___, ___, K46, ___, K48, K49, K4A, K4B, K4C, K4D, K4E } \
+}