[Keyboard] Add Sodium keyboards (#17078)

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: nacly <nacly@pop-os.localdomain>

7 files changed, 346 insertions, 0 deletions

diff --git a/keyboards/nacly/sodium62/config.h b/keyboards/nacly/sodium62/config.h
new file mode 100644
index 0000000000..b6140db5f6
--- /dev/null
+++ b/keyboards/nacly/sodium62/config.h
@@ -0,0 +1,74 @@
+/* Copyright 2022 NaCly
+ *
+ * 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       0xBEEF
+#define PRODUCT_ID      0xFED0
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    nacly
+#define PRODUCT         sodium62
+
+/* key matrix size */
+// Rows are doubled-up
+#define MATRIX_ROWS 10
+#define MATRIX_COLS 7
+
+// wiring of each half
+#define MATRIX_ROW_PINS { F7, D4, D7, B4, B6 }
+#define MATRIX_COL_PINS { D2, C6, E6, B5, B2, B3, B1 }
+
+#define DIODE_DIRECTION COL2ROW
+
+#define SPLIT_HAND_PIN F4
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/* serial.c configuration for split keyboard */
+#define SOFT_SERIAL_PIN D3
+
+/* 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
+#define OLED_BRIGHTNESS 128
+
+/* ws2812 RGB LED */
+//#define RGB_DI_PIN B1
+/*
+#define RGBLED_NUM 12    // Number of LEDs
+
+#define RGBLED_SPLIT { 6, 6 }
+*/
+/*
+ * 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
diff --git a/keyboards/nacly/sodium62/info.json b/keyboards/nacly/sodium62/info.json
new file mode 100644
index 0000000000..f1dc474dcc
--- /dev/null
+++ b/keyboards/nacly/sodium62/info.json
@@ -0,0 +1,82 @@
+{
+    "keyboard_name": "sodium62",
+    "url": "https://nacly.net",
+    "maintainer": "nacly",
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"x": 0, "y": 0.75},
+                {"x": 1, "y": 0.75},
+                {"x": 2, "y": 0.5},
+                {"x": 3, "y": 0},
+                {"x": 4, "y": 0.25},
+                {"x": 5, "y": 1},
+
+                {"x": 9.75, "y": 1},
+                {"x": 10.75, "y": 0.5},
+                {"x": 11.75, "y": 0},
+                {"x": 12.75, "y": 0.5},
+                {"x": 13.75, "y": 0.75},
+                {"x": 14.75, "y": 0.75},
+
+                {"x": 0, "y": 1.75},
+                {"x": 1, "y": 1.75},
+                {"x": 2, "y": 1.5},
+                {"x": 3, "y": 1},
+                {"x": 4, "y": 1.25},
+                {"x": 5, "y": 2},
+
+                {"x": 9.75, "y": 2},
+                {"x": 10.75, "y": 1.5},
+                {"x": 11.75, "y": 1},
+                {"x": 12.75, "y": 1.5},
+                {"x": 13.75, "y": 1.75},
+                {"x": 14.75, "y": 1.75},
+
+                {"x": 0, "y": 2.75},
+                {"x": 1, "y": 2.75},
+                {"x": 2, "y": 2.5},
+                {"x": 3, "y": 2},
+                {"x": 4, "y": 2.25},
+                {"x": 5, "y": 3},
+
+                {"x": 9.75, "y": 3},
+                {"x": 10.75, "y": 2.5},
+                {"x": 11.75, "y": 2},
+                {"x": 12.75, "y": 2.5},
+                {"x": 13.75, "y": 2.75},
+                {"x": 14.75, "y": 2.75},
+
+                {"x": 0, "y": 3.75},
+                {"x": 1, "y": 3.75},
+                {"x": 2, "y": 3.5},
+                {"x": 3, "y": 3},
+                {"x": 4, "y": 3.25},
+                {"x": 5, "y": 4},
+
+                {"x": 9.75, "y": 4},
+                {"x": 10.75, "y": 3.5},
+                {"x": 11.75, "y": 3},
+                {"x": 12.75, "y": 3.5},
+                {"x": 13.75, "y": 3.75},
+                {"x": 14.75, "y": 3.75},
+
+                {"x": 0, "y": 4.75},
+                {"x": 1, "y": 4.75},
+                {"x": 2, "y": 4.5},
+                {"x": 3, "y": 4},
+                {"x": 4, "y": 4.25},
+                {"x": 5, "y": 5},
+                {"x": 6, "y": 5.5},
+
+                {"x": 8.75, "y": 5.5},
+                {"x": 9.75, "y": 5},
+                {"x": 10.75, "y": 4.5},
+                {"x": 11.75, "y": 4},
+                {"x": 12.75, "y": 4.5},
+                {"x": 13.75, "y": 4.75},
+                {"x": 14.75, "y": 4.75}
+            ]
+        }
+    }
+}
\ No newline at end of file
diff --git a/keyboards/nacly/sodium62/keymaps/default/keymap.c b/keyboards/nacly/sodium62/keymaps/default/keymap.c
new file mode 100644
index 0000000000..f655241876
--- /dev/null
+++ b/keyboards/nacly/sodium62/keymaps/default/keymap.c
@@ -0,0 +1,57 @@
+/* Copyright 2022 NaCly
+ *
+ * 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 custom_layers {
+    _BASE,
+    _L1,
+    _L2,
+    _L3,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = 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_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,       KC_T,                      KC_Y,    KC_U,       KC_I,    KC_O,    KC_P,    KC_BSLS,
+        KC_LGUI, KC_A,    KC_S,    KC_D,    LT(1,KC_F), KC_G,                      KC_H,    LT(2,KC_J), KC_K,    KC_L,    KC_SCLN, KC_QUOT,
+        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_LCTL, KC_LGUI, KC_LALT, KC_GRV,  KC_EQL,     KC_BSPC, KC_DEL,  KC_ENT,  KC_SPC,  KC_LBRC,    KC_RBRC, KC_HOME, KC_END,  KC_ESC
+    ),
+    //Holding F
+    [1] = LAYOUT(
+        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_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,                     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
+        KC_LGUI, KC_NO,   KC_NO,   KC_NO,   _______, KC_NO,                     KC_NO,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_NO,
+        KC_LSFT, KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,                     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_RSFT,
+        KC_LCTL, KC_LGUI, KC_LALT, KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_HOME, KC_END,  KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO
+    ),
+    //Holding J
+    [2] = LAYOUT(
+        KC_MUTE, KC_VOLD, KC_VOLU, KC_NO,   KC_NO,   KC_NO,                     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
+        KC_NO,   KC_MPRV, KC_MPLY, KC_MNXT, KC_NO,   KC_NO,                     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
+        KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,                     KC_NO,   _______, KC_NO,   KC_NO,   KC_NO,   KC_NO,
+        KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,                     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
+        KC_LCTL, KC_LGUI, KC_LALT, KC_NO,   KC_NO,   KC_F14,   KC_F15,   KC_ENT,  KC_SPC,  KC_NO,   KC_NO,   KC_NO,   KC_NO,   TG(3)
+    ),
+    //game layer
+    [3] = 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_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,                      KC_Y,    KC_U,       KC_I,    KC_O,    KC_P,    KC_BSLS,
+        KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,                      KC_H,    LT(2,KC_J), KC_K,    KC_L,    KC_SCLN, KC_QUOT,
+        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_LCTL, KC_NO,   KC_M, KC_GRV,  KC_SPC,  KC_BSPC, KC_DEL,  KC_ENT,  KC_SPC,  KC_LBRC,    KC_RBRC, KC_HOME, KC_END,  TO(0)
+    )
+};
diff --git a/keyboards/nacly/sodium62/readme.md b/keyboards/nacly/sodium62/readme.md
new file mode 100644
index 0000000000..315f6cd987
--- /dev/null
+++ b/keyboards/nacly/sodium62/readme.md
@@ -0,0 +1,21 @@
+# sodium keyboard
+
+## Your new favorite split columnar stagger
+
+* Keyboard Maintainer: [NaCly](https://github.com/Na-Cly)
+* Hardware Supported: sodium62 PCBs, Pro Micro
+* Hardware Availability: https://nacly.net
+
+Make example for this keyboard (after setting up your build environment):
+
+    make nacly/sodium62:default
+
+## Bootloader
+
+Enter the bootloader in 2 ways:
+
+* **Physical reset button**: Press the reset button twice
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+
+
+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/nacly/sodium62/rules.mk b/keyboards/nacly/sodium62/rules.mk
new file mode 100644
index 0000000000..f7e87175ac
--- /dev/null
+++ b/keyboards/nacly/sodium62/rules.mk
@@ -0,0 +1,21 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+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
+NKRO_ENABLE = yes           # Enable N-Key Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no       # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output
+
+SPLIT_KEYBOARD = yes
+OLED_ENABLE = yes
diff --git a/keyboards/nacly/sodium62/sodium62.c b/keyboards/nacly/sodium62/sodium62.c
new file mode 100644
index 0000000000..d165bc1f2f
--- /dev/null
+++ b/keyboards/nacly/sodium62/sodium62.c
@@ -0,0 +1,52 @@
+/* Copyright 2022 NaCly
+ *
+ * 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 "sodium62.h"
+
+#ifdef OLED_ENABLE
+bool oled_task_kb(void) {
+    if (!oled_task_user()) {
+        return false;
+    }
+    // Host Keyboard Layer Status
+    oled_write_P(PSTR("Layer: "), false);
+
+    switch (get_highest_layer(layer_state)) {
+        case _BASE:
+            oled_write_P(PSTR("Base\n"), false);
+            break;
+        case _L1:
+            oled_write_P(PSTR("ONE\n"), false);
+            break;
+        case _L2:
+            oled_write_P(PSTR("TWO\n"), false);
+            break;
+        case _L3:
+            oled_write_P(PSTR("Three\n"), false);
+            break;
+        default:
+            // Or use the write_ln shortcut over adding '\n' to the end of your string
+            oled_write_ln_P(PSTR("Undefined"), false);
+    }
+
+    // Host Keyboard LED Status
+    led_t led_state = host_keyboard_led_state();
+    oled_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR("    "), false);
+    oled_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR("    "), false);
+    oled_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR("    "), false);
+    
+    return true;
+}
+#endif
diff --git a/keyboards/nacly/sodium62/sodium62.h b/keyboards/nacly/sodium62/sodium62.h
new file mode 100644
index 0000000000..7db1002333
--- /dev/null
+++ b/keyboards/nacly/sodium62/sodium62.h
@@ -0,0 +1,39 @@
+/* Copyright 2022 NaCly
+ *
+ * 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 LAYOUT(\
+    L00, L01, L02, L03, L04, L05,                       R05, R04, R03, R02, R01, R00, \
+    L10, L11, L12, L13, L14, L15,                       R15, R14, R13, R12, R11, R10, \
+    L20, L21, L22, L23, L24, L25,                       R25, R24, R23, R22, R21, R20, \
+    L30, L31, L32, L33, L34, L35,                       R35, R34, R33, R32, R31, R30, \
+    L40, L41, L42, L43, L44, L45, L46,             R46, R45, R44, R43, R42, R41, R40  \
+)\
+    {\
+        { L00, L01, L02, L03, L04, L05, KC_NO }, \
+        { L10, L11, L12, L13, L14, L15, KC_NO }, \
+        { L20, L21, L22, L23, L24, L25, KC_NO }, \
+        { L30, L31, L32, L33, L34, L35, KC_NO }, \
+        { L40, L41, L42, L43, L44, L45, L46       }, \
+\
+        { R00, R01, R02, R03, R04, R05, KC_NO }, \
+        { R10, R11, R12, R13, R14, R15, KC_NO }, \
+        { R20, R21, R22, R23, R24, R25, KC_NO }, \
+        { R30, R31, R32, R33, R34, R35, KC_NO }, \
+        { R40, R41, R42, R43, R44, R45, R46      }  \
+}