[Keyboard] Add pisces keyboard (#12287)

Co-authored-by: Nick Brassel <nick@tzarc.org>

keyboards/pisces/config.h

@@ -0,0 +1,70 @@
+/* Copyright 2021 knaruo
+ *
+ * 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    0x6B6E
+#define PRODUCT_ID   0x0000
+#define DEVICE_VER   0x0001
+#define MANUFACTURER knaruo
+#define PRODUCT      pisces
+
+#define USE_SERIAL
+
+/* serial.c configuration for split keyboard */
+#define SOFT_SERIAL_PIN D2
+
+/* Select hand configuration */
+#define SPLIT_HAND_MATRIX_GRID B0,B7
+#define MATRIX_MASKED
+#define SPLIT_USB_DETECT
+
+/* key matrix size */
+// Rows are doubled-up
+#define MATRIX_ROWS (3*2)
+#define MATRIX_COLS 7
+
+/*
+ * 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 { C4, B0, C7 }
+#define MATRIX_COL_PINS { B1, B2, B3, B4, B5, B6, B7 }
+#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
+
+/* 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
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION

keyboards/pisces/info.json

@@ -0,0 +1,16 @@
+{
+    "keyboard_name": "pisces",
+    "url": "https://github.com/knaruo/pisces",
+    "maintainer": "knaruo",
+    "width": 15,
+    "height": 3,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"x":0, "y":0}, {"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":4, "y":0}, {"x":5, "y":0},                                 {"x":9, "y":0}, {"x":10, "y":0}, {"x":11, "y":0}, {"x":12, "y":0}, {"x":13, "y":0}, {"x":14, "y":0},
+                {"x":0, "y":1}, {"x":1, "y":1}, {"x":2, "y":1}, {"x":3, "y":1}, {"x":4, "y":1}, {"x":5, "y":1},                                 {"x":9, "y":1}, {"x":10, "y":1}, {"x":11, "y":1}, {"x":12, "y":1}, {"x":13, "y":1}, {"x":14, "y":1},
+                {"x":0, "y":2}, {"x":1, "y":2}, {"x":2, "y":2}, {"x":3, "y":2}, {"x":4, "y":2}, {"x":5, "y":2}, {"x":6, "y":2}, {"x":8, "y":2}, {"x":9, "y":2}, {"x":10, "y":2}, {"x":11, "y":2}, {"x":12, "y":2}, {"x":13, "y":2}, {"x":14, "y":2}
+            ]
+        }
+    }
+}

keyboards/pisces/keymaps/default/config.h

@@ -0,0 +1,20 @@
+/* Copyright 2021 knaruo
+ *
+ * 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
+
+#define TAPPING_TERM    175 // milliseconds
+#define IGNORE_MOD_TAP_INTERRUPT

keyboards/pisces/keymaps/default/keymap.c

@@ -0,0 +1,62 @@
+/* Copyright 2021 knaruo
+ *
+ * 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
+#include "keymap_jp.h"
+
+/* keymap layers */
+enum _layers {
+  _BASE = 0,
+  _NUM,
+  _FN,
+  _RESERVED,  // reserved for VIA
+  _END,       // end of supported layers
+};
+
+/* Keycode alias */
+#define KC_CTBS     RCTL_T(KC_BSPC)     // Backspace + Ctrl
+#define KC_SPF1     LT(_NUM, KC_SPC)    // Space + NUM layer
+#define KC_DLF2     LT(_FN, KC_DEL)     // Del + FN key layer
+#define KC_SFEN     RSFT_T(KC_ENT)      // Enter + Shift
+#define KC_CAD      LALT(LCTL(KC_DEL))  // Ctrl + Alt + Del
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  /* Base QWERTY key map */
+  [_BASE] = LAYOUT_split_3x6_1(
+    KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    /*_____, _____,*/ KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_ESC,
+    KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    /*_____, _____,*/ KC_H,    KC_J,    KC_K,    KC_L,    KC_CTBS, KC_PGUP,
+    KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_SPF1, KC_LWIN, KC_LALT, KC_DLF2, KC_B,    KC_N,    KC_M,    KC_SFEN, KC_PGDN
+  ),
+
+  [_NUM] = LAYOUT_split_3x6_1(
+    _______, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    /*_____, _____,*/ KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______,
+    _______, KC_TAB,  JP_MINS, JP_CIRC, JP_YEN,  JP_AT,   /*_____, _____,*/ JP_SCLN, JP_COLN, JP_LBRC, JP_RBRC, _______, _______,
+    _______, _______, JP_ZKHK, KC_LALT, JP_COMM, _______, _______, _______, _______, JP_DOT,  JP_SLSH, JP_BSLS, _______, _______
+  ),
+
+  [_FN] = LAYOUT_split_3x6_1(
+    _______, 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_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_CAD,  _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END,  _______
+  ),
+
+  [_RESERVED] = LAYOUT_split_3x6_1(
+    _______, _______, _______, _______, _______, _______, /*_____, _____,*/ _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, /*_____, _____,*/ _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+  ),
+};

keyboards/pisces/keymaps/default/readme.md

@@ -0,0 +1 @@
+# The default keymap

keyboards/pisces/keymaps/via/config.h

@@ -0,0 +1,20 @@
+/* Copyright 2021 knaruo
+ *
+ * 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
+
+#define TAPPING_TERM    175 // milliseconds
+#define IGNORE_MOD_TAP_INTERRUPT

keyboards/pisces/keymaps/via/keymap.c

@@ -0,0 +1,62 @@
+/* Copyright 2021 knaruo
+ *
+ * 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
+#include "keymap_jp.h"
+
+/* keymap layers */
+enum _layers {
+  _BASE = 0,
+  _NUM,
+  _FN,
+  _RESERVED,  // reserved for VIA
+  _END,       // end of supported layers
+};
+
+/* Keycode alias */
+#define KC_CTBS     RCTL_T(KC_BSPC)     // Backspace + Ctrl
+#define KC_SPF1     LT(_NUM, KC_SPC)    // Space + NUM layer
+#define KC_DLF2     LT(_FN, KC_DEL)     // Del + FN key layer
+#define KC_SFEN     RSFT_T(KC_ENT)      // Enter + Shift
+#define KC_CAD      LALT(LCTL(KC_DEL))  // Ctrl + Alt + Del
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  /* Base QWERTY key map */
+  [_BASE] = LAYOUT_split_3x6_1(
+    KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    /*_____, _____,*/ KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_ESC,
+    KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    /*_____, _____,*/ KC_H,    KC_J,    KC_K,    KC_L,    KC_CTBS, KC_PGUP,
+    KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_SPF1, KC_LWIN, KC_LALT, KC_DLF2, KC_B,    KC_N,    KC_M,    KC_SFEN, KC_PGDN
+  ),
+
+  [_NUM] = LAYOUT_split_3x6_1(
+    _______, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    /*_____, _____,*/ KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______,
+    _______, KC_TAB,  JP_MINS, JP_CIRC, JP_YEN,  JP_AT,   /*_____, _____,*/ JP_SCLN, JP_COLN, JP_LBRC, JP_RBRC, _______, _______,
+    _______, _______, JP_ZKHK, KC_LALT, JP_COMM, _______, _______, _______, _______, JP_DOT,  JP_SLSH, JP_BSLS, _______, _______
+  ),
+
+  [_FN] = LAYOUT_split_3x6_1(
+    _______, 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_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_CAD,  _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, KC_PGDN, KC_PGUP, KC_END,  _______
+  ),
+
+  [_RESERVED] = LAYOUT_split_3x6_1(
+    _______, _______, _______, _______, _______, _______, /*_____, _____,*/ _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, /*_____, _____,*/ _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+  ),
+};

keyboards/pisces/keymaps/via/readme.md

@@ -0,0 +1 @@
+# VIA enabled keymap

keyboards/pisces/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

keyboards/pisces/pisces.c

@@ -0,0 +1,27 @@
+/* Copyright 2021 knaruo
+ *
+ * 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 "pisces.h"
+
+const matrix_row_t matrix_mask[MATRIX_ROWS] = {
+//  87654321
+  0b00111111,
+  0b00111111,
+  0b01111111,
+  0b00111111,
+  0b00111111,
+  0b01111111
+};

keyboards/pisces/pisces.h

@@ -0,0 +1,41 @@
+/* Copyright 2021 knaruo
+ *
+ * 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_split_3x6_1( \
+    L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
+    L10, L11, L12, L13, L14, L15,           R10, R11, R12, R13, R14, R15, \
+    L20, L21, L22, L23, L24, L25, L26, R26, R20, R21, R22, R23, R24, R25  \
+) { \
+    { L00, L01, L02, L03, L04, L05, KC_NO }, \
+    { L10, L11, L12, L13, L14, L15, KC_NO }, \
+    { L20, L21, L22, L23, L24, L25, L26 }, \
+    { R05, R04, R03, R02, R01, R00, KC_NO }, \
+    { R15, R14, R13, R12, R11, R10, KC_NO }, \
+    { R25, R24, R23, R22, R21, R20, R26 } \
+}

keyboards/pisces/readme.md

@@ -0,0 +1,24 @@
+# pisces
+
+![pisces](https://i.imgur.com/rzIhYLZ.png)
+
+(Less than) 40% Ortholinear split keyboard
+
+* Keyboard Maintainer: [knaruo](https://github.com/knaruo)
+* Hardware Supported: pisces PCB, ATmega32U2
+* Hardware Availability: [PCB and Plate](https://github.com/knaruo/pisces)
+
+Getting the board into bootloader mode:
+
+To be able to flash firmware onto this board, you'll need to bring the micro controller into bootloader mode. Press the reset button (RSTSW1) on the top side of the PCB to enable the bootloader mode.
+
+
+Make example for this keyboard (after setting up your build environment):
+
+    make pisces:default
+
+Flashing example for this keyboard:
+
+    make pisces: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).

keyboards/pisces/rules.mk

@@ -0,0 +1,27 @@
+# MCU name
+MCU = atmega32u2
+
+# 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 = 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
+
+# Enable generic behavior for split boards
+SPLIT_KEYBOARD = yes
+
+LAYOUTS = split_3x6_1  # total 38