Add support for Noxary Vulcan (#10822)

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: ai03 <sarcaphx510@gmail.com>

11 files changed, 390 insertions, 0 deletions

diff --git a/keyboards/noxary/vulcan/config.h b/keyboards/noxary/vulcan/config.h
new file mode 100644
index 0000000000..6281cb07d1
--- /dev/null
+++ b/keyboards/noxary/vulcan/config.h
@@ -0,0 +1,107 @@
+/*
+Copyright 2019 Ryota Goto
+
+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       0xA103
+#define PRODUCT_ID      0x0011
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Noxary
+#define PRODUCT         Vulcan
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 14
+
+/*
+ * 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 { D1, D0, D2, F0, F1 }
+#define MATRIX_COL_PINS { F4, F5, F6, F7, C7, C6, B6, B5, B4, D7, D6, D4, D5, D3 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+// #define GRAVE_ESC_CTRL_OVERRIDE
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
+
+/* Bootmagic Lite key configuration */
+// #define BOOTMAGIC_LITE_ROW 0
+// #define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/noxary/vulcan/info.json b/keyboards/noxary/vulcan/info.json
new file mode 100644
index 0000000000..6e54519fb1
--- /dev/null
+++ b/keyboards/noxary/vulcan/info.json
@@ -0,0 +1,75 @@
+{
+    "keyboard_name": "vulcan", 
+    "url": "https://noxary.co/products/vulcan-pro-base", 
+    "maintainer": "ai03", 
+    "width": 15, 
+    "height": 5, 
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"label":"Esc", "x":0, "y":0}, 
+                {"label":"!", "x":1, "y":0}, 
+                {"label":"@", "x":2, "y":0}, 
+                {"label":"#", "x":3, "y":0}, 
+                {"label":"$", "x":4, "y":0}, 
+                {"label":"%", "x":5, "y":0}, 
+                {"label":"^", "x":6, "y":0}, 
+                {"label":"&", "x":7, "y":0}, 
+                {"label":"*", "x":8, "y":0}, 
+                {"label":"(", "x":9, "y":0}, 
+                {"label":")", "x":10, "y":0}, 
+                {"label":"_", "x":11, "y":0}, 
+                {"label":"+", "x":12, "y":0}, 
+                {"label":"Back Space", "x":13, "y":0}, 
+                {"label":"Delete", "x":14, "y":0}, 
+                {"label":"Tab", "x":0, "y":1, "w":1.5}, 
+                {"label":"Q", "x":1.5, "y":1}, 
+                {"label":"W", "x":2.5, "y":1}, 
+                {"label":"E", "x":3.5, "y":1}, 
+                {"label":"R", "x":4.5, "y":1}, 
+                {"label":"T", "x":5.5, "y":1}, 
+                {"label":"Y", "x":6.5, "y":1}, 
+                {"label":"U", "x":7.5, "y":1}, 
+                {"label":"I", "x":8.5, "y":1}, 
+                {"label":"O", "x":9.5, "y":1}, 
+                {"label":"P", "x":10.5, "y":1}, 
+                {"label":"{", "x":11.5, "y":1}, 
+                {"label":"}", "x":12.5, "y":1}, 
+                {"label":"|", "x":13.5, "y":1, "w":1.5}, 
+                {"label":"Caps Lock", "x":0, "y":2, "w":1.25}, 
+                {"label":"A", "x":1.75, "y":2}, 
+                {"label":"S", "x":2.75, "y":2}, 
+                {"label":"D", "x":3.75, "y":2}, 
+                {"label":"F", "x":4.75, "y":2}, 
+                {"label":"G", "x":5.75, "y":2}, 
+                {"label":"H", "x":6.75, "y":2}, 
+                {"label":"J", "x":7.75, "y":2}, 
+                {"label":"K", "x":8.75, "y":2}, 
+                {"label":"L", "x":9.75, "y":2}, 
+                {"label":":", "x":10.75, "y":2}, 
+                {"label":"\"", "x":11.75, "y":2}, 
+                {"label":"Enter", "x":12.75, "y":2, "w":2.25}, 
+                {"label":"Shift", "x":0, "y":3, "w":2.25}, 
+                {"label":"Z", "x":2.25, "y":3}, 
+                {"label":"X", "x":3.25, "y":3}, 
+                {"label":"C", "x":4.25, "y":3}, 
+                {"label":"V", "x":5.25, "y":3}, 
+                {"label":"B", "x":6.25, "y":3}, 
+                {"label":"N", "x":7.25, "y":3}, 
+                {"label":"M", "x":8.25, "y":3}, 
+                {"label":"<", "x":9.25, "y":3}, 
+                {"label":">", "x":10.25, "y":3}, 
+                {"label":"?", "x":11.25, "y":3}, 
+                {"label":"Shift", "x":12.25, "y":3, "w":1.75}, 
+                {"label":"Fn", "x":14, "y":3}, 
+                {"label":"Ctrl", "x":0, "y":4, "w":1.5}, 
+                {"label":"Win", "x":1.5, "y":4}, 
+                {"label":"Alt", "x":2.5, "y":4, "w":1.5}, 
+                {"x":4, "y":4, "w":7}, 
+                {"label":"Alt", "x":11, "y":4, "w":1.5}, 
+                {"label":"Win", "x":12.5, "y":4}, 
+                {"label":"Ctrl", "x":13.5, "y":4, "w":1.5}
+            ]
+        }
+    }
+}
\ No newline at end of file
diff --git a/keyboards/noxary/vulcan/keymaps/default/keymap.c b/keyboards/noxary/vulcan/keymaps/default/keymap.c
new file mode 100644
index 0000000000..d80a451ff4
--- /dev/null
+++ b/keyboards/noxary/vulcan/keymaps/default/keymap.c
@@ -0,0 +1,45 @@
+/* Copyright 2019 Ryota Goto
+ *
+ * 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
+
+enum layer_names {
+    _BASE,
+    _FN
+};
+
+/*    K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K212,
+ *    K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112,       K113,
+ *    K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211,             K213,
+ *    K300,       K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K312, K313,
+ *    K400, K401, K402,                         K410,                         K411, K412, K413 
+ */
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT( /* Base */
+    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_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_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_LSFT,          KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT, MO(1), 
+    KC_LCTL, KC_LGUI, KC_LALT,                                     KC_SPC,                                      KC_RALT, KC_RGUI, KC_RCTL
+  ),
+  [_FN] = LAYOUT( /* Fn */
+    RESET,   KC_GRV,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, 
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                   _______, 
+    _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, _______, 
+    _______, _______, _______,                                     _______,                                     _______, _______, _______ 
+  )
+};
diff --git a/keyboards/noxary/vulcan/keymaps/default/readme.md b/keyboards/noxary/vulcan/keymaps/default/readme.md
new file mode 100644
index 0000000000..64ee9c8a3c
--- /dev/null
+++ b/keyboards/noxary/vulcan/keymaps/default/readme.md
@@ -0,0 +1,2 @@
+# The default keymap for Vulcan
+Nothing special
\ No newline at end of file
diff --git a/keyboards/noxary/vulcan/keymaps/via/keymap.c b/keyboards/noxary/vulcan/keymaps/via/keymap.c
new file mode 100644
index 0000000000..155d9c8f49
--- /dev/null
+++ b/keyboards/noxary/vulcan/keymaps/via/keymap.c
@@ -0,0 +1,63 @@
+/* Copyright 2019 Ryota Goto
+ *
+ * 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
+
+enum layer_names {
+    _BASE,
+    _FN,
+    _EXTRA_ONE,
+    _EXTRA_TWO
+};
+
+/*    K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K212,
+ *    K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112,       K113,
+ *    K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211,             K213,
+ *    K300,       K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K312, K313,
+ *    K400, K401, K402,                         K410,                         K411, K412, K413 
+ */
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT( /* Base */
+    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_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_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_LSFT,          KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT, MO(1), 
+    KC_LCTL, KC_LGUI, KC_LALT,                                     KC_SPC,                                      KC_RALT, KC_RGUI, KC_RCTL
+  ),
+  [_FN] = LAYOUT( /* Fn */
+    _______, KC_GRV,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, 
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                   _______, 
+    _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, _______, 
+    _______, _______, _______,                                     _______,                                     _______, _______, _______ 
+  ),
+  [_EXTRA_ONE] = LAYOUT( /* Extra layer for via */
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, 
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                   _______, 
+    _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, _______, 
+    _______, _______, _______,                                     _______,                                     _______, _______, _______ 
+  ),
+  [_EXTRA_TWO] = LAYOUT( /* Extra layer for via */
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, 
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                   _______, 
+    _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, _______, 
+    _______, _______, _______,                                     _______,                                     _______, _______, _______ 
+  )
+};
+
+
diff --git a/keyboards/noxary/vulcan/keymaps/via/readme.md b/keyboards/noxary/vulcan/keymaps/via/readme.md
new file mode 100644
index 0000000000..e4393e3fe1
--- /dev/null
+++ b/keyboards/noxary/vulcan/keymaps/via/readme.md
@@ -0,0 +1,2 @@
+# The via keymap for Vulcan
+For use with VIA configurator
\ No newline at end of file
diff --git a/keyboards/noxary/vulcan/keymaps/via/rules.mk b/keyboards/noxary/vulcan/keymaps/via/rules.mk
new file mode 100644
index 0000000000..036bd6d1c3
--- /dev/null
+++ b/keyboards/noxary/vulcan/keymaps/via/rules.mk
@@ -0,0 +1 @@
+VIA_ENABLE = yes
\ No newline at end of file
diff --git a/keyboards/noxary/vulcan/readme.md b/keyboards/noxary/vulcan/readme.md
new file mode 100644
index 0000000000..7aacb4ecdf
--- /dev/null
+++ b/keyboards/noxary/vulcan/readme.md
@@ -0,0 +1,15 @@
+# Vulcan
+
+![Vulcan](https://i.imgur.com/ZwlJ0sxl.png)
+
+High-end 60% keyboard
+
+* Keyboard Maintainer: [ai03](https://github.com/ai03-2725)/Noxary Keyboards
+* Hardware Supported: The Vulcan PCB
+* Hardware Availability: [Noxary Webstore](https://noxary.co/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make noxary/vulcan:default
+
+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/noxary/vulcan/rules.mk b/keyboards/noxary/vulcan/rules.mk
new file mode 100644
index 0000000000..5f1b6954ee
--- /dev/null
+++ b/keyboards/noxary/vulcan/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 = yes        # 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 = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
diff --git a/keyboards/noxary/vulcan/vulcan.c b/keyboards/noxary/vulcan/vulcan.c
new file mode 100644
index 0000000000..a36569ecbd
--- /dev/null
+++ b/keyboards/noxary/vulcan/vulcan.c
@@ -0,0 +1,17 @@
+/* Copyright 2019 Ryota Goto
+ *
+ * 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 "vulcan.h"
+
diff --git a/keyboards/noxary/vulcan/vulcan.h b/keyboards/noxary/vulcan/vulcan.h
new file mode 100644
index 0000000000..97ac40ff3b
--- /dev/null
+++ b/keyboards/noxary/vulcan/vulcan.h
@@ -0,0 +1,41 @@
+/* Copyright 2019 Ryota Goto
+ *
+ * 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"
+
+/* This a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT( \
+    K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K212, \
+    K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112,       K113, \
+    K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211,             K213, \
+    K300,       K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K312, K313, \
+    K400, K401, K402,                         K410,                         K411, K412, K413  \
+) \
+{ \
+    { K000,  K001,  K002,  K003,  K004,  K005,  K006,  K007,  K008,  K009,  K010,  K011,  K012,  K013 }, \
+    { K100,  K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110,  K111,  K112,  K113 }, \
+    { K200,  K201,  K202,  K203,  K204,  K205,  K206,  K207,  K208,  K209,  K210,  K211,  K212,  K213 }, \
+    { K300,  KC_NO, K302,  K303,  K304,  K305,  K306,  K307,  K308,  K309,  K310,  K311,  K312,  K313 }, \
+    { K400,  K401,  K402,  KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K410,  K411,  K412,  K413 }  \
+}