Add Nines by Ungodly Design (#10931)

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Co-authored-by: Joel Challis <git@zvecr.com>

9 files changed, 262 insertions, 0 deletions

diff --git a/keyboards/ungodly/nines/config.h b/keyboards/ungodly/nines/config.h
new file mode 100644
index 0000000000..a2f874bda9
--- /dev/null
+++ b/keyboards/ungodly/nines/config.h
@@ -0,0 +1,51 @@
+/* Copyright 2020 Ungodly Design <hello@ungodly.design>
+ *
+ * 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       0x5544 // "UD" = Ungodly Design
+#define PRODUCT_ID      0x544E // "TN" = The Nines
+#define DEVICE_VER      0x9999
+#define MANUFACTURER    Ungodly Design
+#define PRODUCT         The Nines
+
+/* key matrix size */
+#define MATRIX_ROWS 3
+#define MATRIX_COLS 3
+
+/* Keyboard Matrix Assignments */
+#define DIRECT_PINS { \
+    { F4, F5, F6 }, \
+    { F7, B1, B3 }, \
+    { B2, B6, B5 }  \
+}
+#define UNUSED_PINS
+
+/* Rotary Encoder Assignments */
+#define ENCODERS_PAD_A { C6, E6 }
+#define ENCODERS_PAD_B { D7, B4 }
+
+#define ENCODER_RESOLUTION 2
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* 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
diff --git a/keyboards/ungodly/nines/info.json b/keyboards/ungodly/nines/info.json
new file mode 100644
index 0000000000..4a3c542441
--- /dev/null
+++ b/keyboards/ungodly/nines/info.json
@@ -0,0 +1,22 @@
+{
+  "keyboard_name": "The Nines",
+  "url": "https://www.qlavier.com/",
+  "maintainer": "Ungodly Design",
+  "width": 3,
+  "height": 3,
+  "layouts": {
+    "LAYOUT_ortho_3x3": {
+      "layout": [
+        {"x":0, "y":0},
+        {"x":1, "y":0},
+        {"x":2, "y":0},
+        {"x":0, "y":1},
+        {"x":1, "y":1},
+        {"x":2, "y":1},
+        {"x":0, "y":2},
+        {"x":1, "y":2},
+        {"x":2, "y":2}
+      ]
+    }
+  }
+}
diff --git a/keyboards/ungodly/nines/keymaps/default/keymap.c b/keyboards/ungodly/nines/keymaps/default/keymap.c
new file mode 100644
index 0000000000..2100f4b801
--- /dev/null
+++ b/keyboards/ungodly/nines/keymaps/default/keymap.c
@@ -0,0 +1,32 @@
+/* Copyright 2020 Ungodly Design <hello@ungodly.design>
+ *
+ * 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_ortho_3x3(
+    KC_MPLY, KC_HOME, KC_MUTE,
+    MO(1),   KC_UP,   KC_END,
+    KC_LEFT, KC_DOWN, KC_RGHT
+),
+
+[1] = LAYOUT_ortho_3x3(
+    RESET,   _______, KC_STOP,
+    _______, KC_HOME, _______,
+    KC_MPRV, KC_END , KC_MNXT
+)
+
+};
diff --git a/keyboards/ungodly/nines/keymaps/via/keymap.c b/keyboards/ungodly/nines/keymaps/via/keymap.c
new file mode 100644
index 0000000000..e0567ff0f1
--- /dev/null
+++ b/keyboards/ungodly/nines/keymaps/via/keymap.c
@@ -0,0 +1,44 @@
+/* Copyright 2020 Ungodly Design <hello@ungodly.design>
+ *
+ * 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_ortho_3x3(
+    KC_MPLY, KC_HOME, KC_MUTE,
+    MO(1),   KC_UP,   KC_END,
+    KC_LEFT, KC_DOWN, KC_RGHT
+),
+
+[1] = LAYOUT_ortho_3x3(
+    RESET,   _______, KC_STOP,
+    _______, KC_HOME, _______,
+    KC_MPRV, KC_END , KC_MNXT
+),
+
+[2] = LAYOUT_ortho_3x3(
+    _______, _______, _______,
+    _______, _______, _______,
+    _______, _______, _______
+),
+
+[3] = LAYOUT_ortho_3x3(
+    _______, _______, _______,
+    _______, _______, _______,
+    _______, _______, _______
+)
+
+};
diff --git a/keyboards/ungodly/nines/keymaps/via/rules.mk b/keyboards/ungodly/nines/keymaps/via/rules.mk
new file mode 100644
index 0000000000..1e5b99807c
--- /dev/null
+++ b/keyboards/ungodly/nines/keymaps/via/rules.mk
@@ -0,0 +1 @@
+VIA_ENABLE = yes
diff --git a/keyboards/ungodly/nines/nines.c b/keyboards/ungodly/nines/nines.c
new file mode 100644
index 0000000000..3b29b268d7
--- /dev/null
+++ b/keyboards/ungodly/nines/nines.c
@@ -0,0 +1,32 @@
+/* Copyright 2020 Ungodly Design <hello@ungodly.design>
+ *
+ * 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 "nines.h"
+
+__attribute__((weak)) void encoder_update_user(uint8_t index, bool clockwise) {
+    if (index == 0) { /* Left encoder */
+        if (clockwise) {
+            tap_code(KC_VOLU);
+        } else {
+            tap_code(KC_VOLD);
+        }
+    } else if (index == 1) { /* Right encoder */
+        if (clockwise) {
+            tap_code(KC_VOLU);
+        } else {
+            tap_code(KC_VOLD);
+        }
+    }
+}
diff --git a/keyboards/ungodly/nines/nines.h b/keyboards/ungodly/nines/nines.h
new file mode 100644
index 0000000000..f67615ecf9
--- /dev/null
+++ b/keyboards/ungodly/nines/nines.h
@@ -0,0 +1,37 @@
+/* Copyright 2020 Ungodly Design <hello@ungodly.design>
+ *
+ * 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_ortho_3x3( \
+    k00, k01, k02, \
+    k10, k11, k12, \
+    k20, k21, k22  \
+) \
+{ \
+    { k00, k01, k02 }, \
+    { k10, k11, k12 }, \
+    { k20, k21, k22 }  \
+}
diff --git a/keyboards/ungodly/nines/readme.md b/keyboards/ungodly/nines/readme.md
new file mode 100644
index 0000000000..21b2628bec
--- /dev/null
+++ b/keyboards/ungodly/nines/readme.md
@@ -0,0 +1,20 @@
+# Nines
+
+A 9 key (3x3) macropad with rotary encoder support.
+Made by Ungodly Design for Qlavier.
+
+![Nines](https://i.imgur.com/zNnmPV9.jpg)
+
+|Reset Bootloader|   |
+|---|---|
+|Use tweezers to short the two pins to the left of the pro-micro.|![Nines](https://i.imgur.com/ifTZ6Xw.pngl)|
+
+* Keyboard Maintainer: [Luis Godinez](https://github.com/luis-Godinez)
+* Hardware Supported: The Nines PCB
+* Hardware Availability: [Qlavier](https://www.qlavier.com/shop/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make ungodly/nines: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/ungodly/nines/rules.mk b/keyboards/ungodly/nines/rules.mk
new file mode 100644
index 0000000000..c8cbaf06bf
--- /dev/null
+++ b/keyboards/ungodly/nines/rules.mk
@@ -0,0 +1,23 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# 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 = 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
+ENCODER_ENABLE = yes        # Rotary encoder support