[Keyboard] Add Spacey keyboard firmware (#12599)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: tfjones24 <tannerfj24@gmail.com>

8 files changed, 357 insertions, 0 deletions

diff --git a/keyboards/spacey/config.h b/keyboards/spacey/config.h
new file mode 100644
index 0000000000..58249d4f19
--- /dev/null
+++ b/keyboards/spacey/config.h
@@ -0,0 +1,110 @@
+/*
+Copyright 2021 vanilla
+
+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 vanilla
+#define PRODUCT      spacey
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 14
+
+
+#define ENCODERS_PAD_A { D0 }
+#define ENCODERS_PAD_B { D1 }
+#define ENCODER_RESOLUTION 4
+
+/*
+ * 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 { D4, C6, F6, F5, F4 }
+#define MATRIX_COL_PINS { D5, B7, B5, B4, E6, D7, C7, B3, B2, B6, F0, F1, B1, F7 }
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+#define SOFT_SERIAL_PIN D0  // or D1, D2, D3, E6
+
+//#define LED_NUM_LOCK_PIN B0
+//#define LED_CAPS_LOCK_PIN B1
+//#define LED_SCROLL_LOCK_PIN B2
+//#define LED_COMPOSE_PIN B3
+//#define LED_KANA_PIN B4
+
+//#define BACKLIGHT_PIN B7
+//#define BACKLIGHT_LEVELS 3
+//#define BACKLIGHT_BREATHING
+
+//#define RGB_DI_PIN E2
+//#ifdef RGB_DI_PIN
+//#    define RGBLED_NUM 16
+//#    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
+/*== customize breathing effect ==*/
+/*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//#    define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+/*==== use exp() and sin() ====*/
+//#    define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+//#    define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+//#endif
+
+/* 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
+
+
+/* disable these deprecated features by default */
+#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/spacey/info.json b/keyboards/spacey/info.json
new file mode 100644
index 0000000000..39a4e46b54
--- /dev/null
+++ b/keyboards/spacey/info.json
@@ -0,0 +1,87 @@
+{
+    "keyboard_name": "spacey",
+    "url": "",
+    "maintainer": "vanilla",
+    "width": 14,
+    "height": 5,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"label":"k00", "x":0, "y":0},
+                {"label":"k01", "x":1, "y":0},
+                {"label":"k02", "x":2, "y":0},
+                {"label":"k03", "x":3, "y":0},
+                {"label":"k04", "x":4, "y":0},
+                {"label":"k05", "x":5, "y":0},
+                {"label":"k06", "x":6, "y":0},
+                {"label":"k07", "x":7, "y":0},
+                {"label":"k08", "x":8, "y":0},
+                {"label":"k09", "x":9, "y":0},
+                {"label":"k0A", "x":10, "y":0},
+                {"label":"k0B", "x":11, "y":0},
+                {"label":"k0C", "x":12, "y":0},
+                {"label":"k0D", "x":13, "y":0},
+
+                {"label":"k10", "x":0, "y":1},
+                {"label":"k11", "x":1, "y":1},
+                {"label":"k12", "x":2, "y":1},
+                {"label":"k13", "x":3, "y":1},
+                {"label":"k14", "x":4, "y":1},
+                {"label":"k15", "x":5, "y":1},
+                {"label":"k16", "x":6, "y":1},
+                {"label":"k17", "x":7, "y":1},
+                {"label":"k18", "x":8, "y":1},
+                {"label":"k19", "x":9, "y":1},
+                {"label":"k1A", "x":10, "y":1},
+                {"label":"k1B", "x":11, "y":1},
+                {"label":"k1C", "x":12, "y":1},
+                {"label":"k1D", "x":13, "y":1},
+
+                {"label":"k20", "x":0, "y":2},
+                {"label":"k21", "x":1, "y":2},
+                {"label":"k22", "x":2, "y":2},
+                {"label":"k23", "x":3, "y":2},
+                {"label":"k24", "x":4, "y":2},
+                {"label":"k25", "x":5, "y":2},
+                {"label":"k26", "x":6, "y":2},
+                {"label":"k27", "x":7, "y":2},
+                {"label":"k28", "x":8, "y":2},
+                {"label":"k29", "x":9, "y":2},
+                {"label":"k2A", "x":10, "y":2},
+                {"label":"k2B", "x":11, "y":2},
+                {"label":"k2C", "x":12, "y":2},
+                {"label":"k2D", "x":13, "y":2},
+
+                {"label":"k30", "x":0, "y":3},
+                {"label":"k31", "x":1, "y":3},
+                {"label":"k32", "x":2, "y":3},
+                {"label":"k33", "x":3, "y":3},
+                {"label":"k34", "x":4, "y":3},
+                {"label":"k35", "x":5, "y":3},
+                {"label":"k36", "x":6, "y":3},
+                {"label":"k37", "x":7, "y":3},
+                {"label":"k38", "x":8, "y":3},
+                {"label":"k39", "x":9, "y":3},
+                {"label":"k3A", "x":10, "y":3},
+                {"label":"k3B", "x":11, "y":3},
+                {"label":"k3C", "x":12, "y":3},
+                {"label":"k3D", "x":13, "y":3},
+
+                {"label":"k40", "x":0, "y":4},
+                {"label":"k41", "x":1, "y":4},
+                {"label":"k42", "x":2, "y":4},
+                {"label":"k43", "x":3, "y":4},
+                {"label":"k44", "x":4, "y":4},
+                {"label":"k45", "x":5, "y":4},
+               
+                {"label":"k47", "x":7, "y":4},
+                {"label":"k48", "x":8, "y":4},
+                
+                {"label":"k4A", "x":10, "y":4},
+                {"label":"k4B", "x":11, "y":4},
+                {"label":"k4C", "x":12, "y":4},
+                {"label":"k4D", "x":13, "y":4}
+            ]
+        }
+    }
+}
diff --git a/keyboards/spacey/keymaps/default/keymap.c b/keyboards/spacey/keymaps/default/keymap.c
new file mode 100644
index 0000000000..4d08a279e0
--- /dev/null
+++ b/keyboards/spacey/keymaps/default/keymap.c
@@ -0,0 +1,47 @@
+/* Copyright 2021 vanilla
+ *
+ * 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
+#define FN MO(_FN)
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE = 0,
+    _FN
+};
+
+// Defines the keycodes used by our macros in process_record_user
+enum custom_keycodes {
+    QMKBEST = SAFE_RANGE,
+    QMKURL
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Base */
+    [_BASE] = LAYOUT(
+        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_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_CLCK,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_UP,
+        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_LEFT, KC_DOWN,
+        KC_LCTL, KC_LGUI, FN, KC_MUTE, KC_LALT, KC_SPC,  KC_NO, KC_BSPC, KC_DEL, KC_NO,  KC_RALT, KC_RGUI, KC_RCTL, KC_RGHT
+    ),
+    [_FN] = LAYOUT(
+        KC_GRV, 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_BSPC,
+        KC_TAB, 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_DEL,
+        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_ENT, KC_MS_U,
+        KC_LSFT,KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_COMM,KC_DOT,KC_SLSH,KC_RSFT, KC_MS_L, KC_MS_D,
+        KC_LCTL, KC_LGUI, KC_NO, KC_ESC, KC_LALT, KC_SPC,  KC_NO,  KC_BSPC,   KC_RALT, KC_NO,     KC_APP, KC_RGUI, KC_RCTL, KC_MS_R
+    )
+};
diff --git a/keyboards/spacey/keymaps/default/readme.md b/keyboards/spacey/keymaps/default/readme.md
new file mode 100644
index 0000000000..808ab68264
--- /dev/null
+++ b/keyboards/spacey/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for spacey
diff --git a/keyboards/spacey/readme.md b/keyboards/spacey/readme.md
new file mode 100644
index 0000000000..e615852693
--- /dev/null
+++ b/keyboards/spacey/readme.md
@@ -0,0 +1,19 @@
+# spacey
+
+![spacey](https://i.imgur.com/Dzon2hbh.jpeg)
+
+Spacey, designed by Vanilla Keyboards is a 45/65% keyboard with a little personality. Hosting ortholinear alphas with traditional modifiers, diamond shaped arrows, rotary encoder, and a couple optional spacebars at the top of the board, it's a balance between functional and unique.
+
+* Keyboard Maintainer: [vanilla](https://github.com/vanillakeyboards)
+* Hardware Supported: Elite C, Spacey PCB plates and acrylic drop_in case
+* Hardware Availability: https://p3dstore.com/collections/ended-group-buys/products/spacey?variant=37742593147064 and https://keeb.io/products/elite-c-low-profile-version-usb-c-pro-micro-replacement-atmega32u4
+
+Make example for this keyboard (after setting up your build environment):
+
+    make spacey:default
+
+Flashing example for this keyboard:
+
+    make spacey: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).
diff --git a/keyboards/spacey/rules.mk b/keyboards/spacey/rules.mk
new file mode 100644
index 0000000000..fb12719ce8
--- /dev/null
+++ b/keyboards/spacey/rules.mk
@@ -0,0 +1,23 @@
+# 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 = 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
diff --git a/keyboards/spacey/spacey.c b/keyboards/spacey/spacey.c
new file mode 100644
index 0000000000..32f1e4dd9c
--- /dev/null
+++ b/keyboards/spacey/spacey.c
@@ -0,0 +1,29 @@
+/* Copyright 2021 vanilla
+ *
+ * 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 "spacey.h"
+
+bool encoder_update_kb(uint8_t index, bool clockwise){
+    if (!encoder_update_user(index, clockwise)) { return false; }
+    if (index == 0) {
+        if(clockwise) {
+            tap_code(KC_VOLD);
+        } else {
+            tap_code(KC_VOLU);
+        }
+    }
+    return true;
+} 
diff --git a/keyboards/spacey/spacey.h b/keyboards/spacey/spacey.h
new file mode 100644
index 0000000000..5a288fae83
--- /dev/null
+++ b/keyboards/spacey/spacey.h
@@ -0,0 +1,41 @@
+/* Copyright 2021 vanilla
+ *
+ * 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 is 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( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C, k3D, \
+    k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4A, k4B, k4C, k4D \
+) { \
+    {     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D }, \
+    {     k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D }, \
+    {     k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D }, \
+    {     k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C, k3D }, \
+    {     k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4A, k4B, k4C, k4D } \
+}