[Keyboard] Add royal directory and add 2 keyboard releases (#8877)

* add royal project folder and 2 released keyboards * fix iso keymap clarification * Apply suggestions from code review * Update keyboards/the_royal/schwann/schwann.h * Update keyboards/the_royal/liminal/liminal.h * Update keyboards/the_royal/schwann/keymaps/default/keymap.c * Apply suggestions from code review new * Update keymap.c * Update keymap.c * Apply suggestions from code review * Update rules.mk * add rules.mk to schwann default * Apply suggestions from code review * add rules.mk to shwann default
2020-04-27 16:35:03 -05:00
parent 4c51049b2b
commit c7449b3840
20 changed files with 929 additions and 0 deletions
--- a/keyboards/the_royal/schwann/config.h
+++ b/keyboards/the_royal/schwann/config.h
@@ -0,0 +1,39 @@
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x3521
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    TheRoyalSweatshirt
+#define PRODUCT         The Schwann PCB
+#define DESCRIPTION     "A simple, HHKB-Styled, Ortholinear PCB Designed for use with the Neuron Keyboard by Worldspawn and Walletburner."
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 12
+
+#define MATRIX_ROW_PINS { F0, F1, F6, C7 }
+#define MATRIX_COL_PINS { F4, F5, D5, D3, D2, C6, B6, B5, B4, D7, D6, D1 }
+#define UNUSED_PINS
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* Set 0 if debouncing isn't 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
+
+/* ws2812 RGB LED */
+#define RGB_DI_PIN B3
+#define RGBLED_NUM 8    // Number of LEDs
+
+#define RGBLIGHT_ANIMATIONS
+#define RGBLIGHT_HUE_STEP 6
+#define RGBLIGHT_SAT_STEP 4
+#define RGBLIGHT_VAL_STEP 8
--- a/keyboards/the_royal/schwann/info.json
+++ b/keyboards/the_royal/schwann/info.json
@@ -0,0 +1,156 @@
+{
+  "keyboard_name": "Schwann's PCB",
+  "url": "https://github.com/TheRoyalSweatshirt/The_Royal_Projects/tree/schwann/PCBs/Schwann_PCB",
+  "maintainer": "TheRoyalSweatshirt",
+  "width": 12,
+  "height": 4,
+  "layouts": {
+   "LAYOUT_mit": {
+    "key_count": 45,
+      "layout": [
+        {"label":"TAB", "x":0, "y":0},
+        {"label":"Q", "x":1, "y":0}, 
+        {"label":"W", "x":2, "y":0}, 
+        {"label":"E", "x":3, "y":0}, 
+        {"label":"R", "x":4, "y":0}, 
+        {"label":"T", "x":5, "y":0}, 
+        {"label":"Y", "x":6, "y":0}, 
+        {"label":"U", "x":7, "y":0}, 
+        {"label":"I", "x":8, "y":0}, 
+        {"label":"O", "x":9, "y":0}, 
+        {"label":"P", "x":10, "y":0},
+        {"label":"BSPC", "x":11, "y":0},
+        {"label":"LCtl", "x":0, "y":1},
+        {"label":"A", "x":1, "y":1},
+        {"label":"S", "x":2, "y":1},
+        {"label":"D", "x":3, "y":1},
+        {"label":"F", "x":4, "y":1},
+        {"label":"G", "x":5, "y":1},
+        {"label":"H", "x":6, "y":1},
+        {"label":"J", "x":7, "y":1},
+        {"label":"K", "x":8, "y":1},
+        {"label":"L", "x":9, "y":1},
+        {"label":"SCLN", "x":10, "y":1},
+        {"label":"QUOT", "x":11, "y":1},
+        {"label":"LSFT", "x":0, "y":2},
+        {"label":"Z", "x":1, "y":2},
+        {"label":"X", "x":2, "y":2},
+        {"label":"C", "x":3, "y":2},
+        {"label":"V", "x":4, "y":2},
+        {"label":"B", "x":5, "y":2},
+        {"label":"N", "x":6, "y":2},
+        {"label":"M", "x":7, "y":2},
+        {"label":"COMM", "x":8, "y":2},
+        {"label":"DOT", "x":9, "y":2},
+        {"label":"SLSH", "x":10, "y":2},
+        {"label":"ENTER", "x":11, "y":2},
+        {"label":"DEL", "x":1, "y":3},
+        {"label":"LGUI", "x":2, "y":3},
+        {"label":"LALT", "x":3, "y":3},
+        {"label":"LOWER", "x":4, "y":3},
+        {"label":" ", "x":5, "y":3, "w":2},
+        {"label":"RAISE", "x":7, "y":3},
+        {"label":"RALT", "x":8, "y":3},
+        {"label":"MENU", "x":9, "y":3},
+        {"label":"RCTL", "x":10, "y":3}
+      ]
+    },
+
+    "LAYOUT_full_ortho": {
+      "key_count": 46,
+        "layout": [
+        {"label":"TAB", "x":0, "y":0},
+        {"label":"Q", "x":1, "y":0}, 
+        {"label":"W", "x":2, "y":0}, 
+        {"label":"E", "x":3, "y":0}, 
+        {"label":"R", "x":4, "y":0}, 
+        {"label":"T", "x":5, "y":0}, 
+        {"label":"Y", "x":6, "y":0}, 
+        {"label":"U", "x":7, "y":0}, 
+        {"label":"I", "x":8, "y":0}, 
+        {"label":"O", "x":9, "y":0}, 
+        {"label":"P", "x":10, "y":0},
+        {"label":"BSPC", "x":11, "y":0},
+        {"label":"LCtl", "x":0, "y":1},
+        {"label":"A", "x":1, "y":1},
+        {"label":"S", "x":2, "y":1},
+        {"label":"D", "x":3, "y":1},
+        {"label":"F", "x":4, "y":1},
+        {"label":"G", "x":5, "y":1},
+        {"label":"H", "x":6, "y":1},
+        {"label":"J", "x":7, "y":1},
+        {"label":"K", "x":8, "y":1},
+        {"label":"L", "x":9, "y":1},
+        {"label":"SCLN", "x":10, "y":1},
+        {"label":"QUOT", "x":11, "y":1},
+        {"label":"LSFT", "x":0, "y":2},
+        {"label":"Z", "x":1, "y":2},
+        {"label":"X", "x":2, "y":2},
+        {"label":"C", "x":3, "y":2},
+        {"label":"V", "x":4, "y":2},
+        {"label":"B", "x":5, "y":2},
+        {"label":"N", "x":6, "y":2},
+        {"label":"M", "x":7, "y":2},
+        {"label":"COMM", "x":8, "y":2},
+        {"label":"DOT", "x":9, "y":2},
+        {"label":"SLSH", "x":10, "y":2},
+        {"label":"ENTER", "x":11, "y":2},
+        {"label":"DEL", "x":1, "y":3},
+        {"label":"LGUI", "x":2, "y":3},
+        {"label":"LALT", "x":3, "y":3},
+        {"label":"LOWER", "x":4, "y":3},
+        {"label":" ", "x":5, "y":3},
+        {"label":" ", "x":6, "y":3},
+        {"label":"RAISE", "x":7, "y":3},
+        {"label":"RALT", "x":8, "y":3},
+        {"label":"MENU", "x":9, "y":3},
+        {"label":"RCTL", "x":10, "y":3}
+      ]
+    },
+
+    "LAYOUT_big_boy": {
+      "key_count": 39,
+        "layout": [
+        {"label":"TAB", "x":0, "y":0},
+        {"label":"Q", "x":1, "y":0}, 
+        {"label":"W", "x":2, "y":0}, 
+        {"label":"E", "x":3, "y":0}, 
+        {"label":"R", "x":4, "y":0}, 
+        {"label":"T", "x":5, "y":0}, 
+        {"label":"Y", "x":6, "y":0}, 
+        {"label":"U", "x":7, "y":0}, 
+        {"label":"I", "x":8, "y":0}, 
+        {"label":"O", "x":9, "y":0}, 
+        {"label":"P", "x":10, "y":0},
+        {"label":"BSPC", "x":11, "y":0},
+        {"label":"LCtl", "x":0, "y":1},
+        {"label":"A", "x":1, "y":1},
+        {"label":"S", "x":2, "y":1},
+        {"label":"D", "x":3, "y":1},
+        {"label":"F", "x":4, "y":1},
+        {"label":"G", "x":5, "y":1},
+        {"label":"H", "x":6, "y":1},
+        {"label":"J", "x":7, "y":1},
+        {"label":"K", "x":8, "y":1},
+        {"label":"L", "x":9, "y":1},
+        {"label":"SCLN", "x":10, "y":1},
+        {"label":"QUOT", "x":11, "y":1},
+        {"label":"LSFT", "x":0, "y":2},
+        {"label":"Z", "x":1, "y":2},
+        {"label":"X", "x":2, "y":2},
+        {"label":"C", "x":3, "y":2},
+        {"label":"V", "x":4, "y":2},
+        {"label":"B", "x":5, "y":2},
+        {"label":"N", "x":6, "y":2},
+        {"label":"M", "x":7, "y":2},
+        {"label":"COMM", "x":8, "y":2},
+        {"label":"DOT", "x":9, "y":2},
+        {"label":"SLSH", "x":10, "y":2},
+        {"label":"ENTER", "x":11, "y":2},
+        {"label":"LOWER", "x":1, "y":3, "w":1.5},
+        {"label":" ", "x":2.5, "y":3, "w":7},
+        {"label":"RAISE", "x":9.5, "y":3, "w":1.5}
+      ]
+    }
+  }
+}
--- a/keyboards/the_royal/schwann/keymaps/default/keymap.c
+++ b/keyboards/the_royal/schwann/keymaps/default/keymap.c
@@ -0,0 +1,136 @@
+#include QMK_KEYBOARD_H
+
+enum layer_names {
+  _QWERTY,
+  _LOWER,
+  _RAISE,
+  _OTHER
+};
+
+enum schwann_keycodes {
+  QWERTY = SAFE_RANGE,
+  LOWER,
+  RAISE
+};
+
+//Tap Dance Declarations
+enum {
+  TD_RST
+};
+
+void dance_rst_reset (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count >= 2) {
+    reset_keyboard();
+    reset_tap_dance(state);
+  }
+}
+
+//All tap dance functions would go here. Only showing this one.
+qk_tap_dance_action_t tap_dance_actions[] = {
+  [TD_RST] = ACTION_TAP_DANCE_FN_ADVANCED (NULL, NULL, dance_rst_reset)
+};
+
+
+#define XXXXX KC_TRNS
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* Default Layer
+   * ┌────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┐
+   * │Tab │ Q  │ W  │ E  │ R  │ T  │ Y  │ U  │ I  │ O  │ P  │BkSp│
+   * ├────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┤
+   * │LCtl│ A  │ S  │ D  │ F  │ G  │ H  │ J  │ K  │ L  │ ;  │ '  │
+   * ├────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┤
+   * │LSft│ Z  │ X  │ C  │ V  │ B  │ N  │ M  │ ,  │ .  │ /  │Entr│
+   * └────┼────┼────┼────┼────┼────┴────┼────┼────┼────┼────┼────┘
+   *      │Del │Gui │Alt │Lwr │         │Rse │Alt │Menu│Ctrl│
+   *      └────┴────┴────┴────┴─────────┴────┴────┴────┴────┘
+   */
+
+  [_QWERTY] = LAYOUT_mit(
+    KC_TAB,   KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,     KC_O,     KC_P,    KC_BSPC,
+    KC_LCTRL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    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_ENT,
+              KC_DEL,  KC_LGUI, KC_LALT, LOWER,     KC_SPACE,       RAISE,   KC_RALT,  KC_MENU,  KC_RCTL
+  ),
+
+  /* Lower Layer
+   * ┌────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┐
+   * │Esc │ 1  │ 2  │ 3  │ 4  │ 5  │ 6  │ 7  │ 8  │ 9  │ 0  │    │
+   * ├────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┤
+   * │ ~  │ !  │ @  │ #  │ $  │ %  │ ^  │ &  │ *  │ (  │ )  │ "  │
+   * ├────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┤
+   * │    │    │    │    │    │    │    │    │ `  │ [  │ ]  │ .  │
+   * └────┼────┼────┼────┼────┼────┴────┼────┼────┼────┼────┼────┘
+   *      │    │    │    │    │         │    │    │    │    │
+   *      └────┴────┴────┴────┴─────────┴────┴────┴────┴────┘
+   */
+  [_LOWER] = LAYOUT_mit(
+    KC_ESC,     KC_1,      KC_2,      KC_3,      KC_4,      KC_5,      KC_6,      KC_7,     KC_8,     KC_9,     KC_0,     _______,
+    KC_TILD,    KC_EXLM,   KC_AT,     KC_HASH,   KC_DLR,    KC_PERC,   KC_CIRC,   KC_AMPR,  KC_ASTR,  KC_LPRN,  KC_RPRN,  KC_DQT,
+    _______,    _______,   _______,   _______,   _______,   _______,   _______,   _______,  KC_GRAVE, KC_LBRC,  KC_RBRC,  KC_DOT,
+                _______,   _______,   _______,   _______,         _______,        _______,  _______,  _______,  _______
+  ),
+
+  /* Raise Layer
+   * ┌────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┐
+   * │    │    │    │    │    │    │    │    │    │    │ -  │    │
+   * ├────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┤
+   * │CAPS│    │    │    │    │    │    │    │    │    │ _  │ \  │
+   * ├────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┤
+   * │PrSc│    │    │    │    │    │    │    │    │ UP │    │ =  │
+   * └────┼────┼────┼────┼────┼────┴────┼────┼────┼────┼────┼────┘
+   *      │    │    │    │    │         │    │Left│Down│Rght│
+   *      └────┴────┴────┴────┴─────────┴────┴────┴────┴────┘
+   */
+  [_RAISE] = LAYOUT_mit(
+    _______,    _______,   _______,    _______,   _______,   _______,   _______,   _______,  _______,  _______,  KC_MINS,  _______,
+    KC_CAPS,    _______,   _______,    _______,   _______,   _______,   _______,   _______,  _______,  _______,  KC_UNDS,  KC_BSLS,
+    KC_PSCR,    _______,   _______,    _______,   _______,   _______,   _______,   _______,  _______,   KC_UP,   _______,  KC_EQUAL,
+                 _______,   _______,    _______,   _______,         _______,       _______,  KC_LEFT,  KC_DOWN,  KC_RIGHT
+),
+
+  /* Other Layer
+   * ┌────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┐
+   * │RSET│    │    │    │    │    │    │    │    │SAT+│Hue+│Brt+│
+   * ├────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┤
+   * │    │    │    │    │    │    │    │    │    │SAT-│Hue-│Brt-│
+   * ├────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┼────┤
+   * │    │    │    │    │    │    │    │    │    │    │    │RGB!│
+   * └────┼────┼────┼────┼────┼────┴────┼────┼────┼────┼────┼────┘
+   *      │    │    │    │    │         │    │    │    │    │
+   *      └────┴────┴────┴────┴─────────┴────┴────┴────┴────┘
+   */
+  [_OTHER] = LAYOUT_mit(
+    TD(TD_RST), _______,   _______,    _______,   _______,   _______,   _______,   _______,  _______,  RGB_SAI,  RGB_HUI,  RGB_VAI,
+    _______,    _______,   _______,    _______,   _______,   _______,   _______,   _______,  _______,  RGB_SAD,  RGB_HUD,  RGB_VAD,
+    _______,    _______,   _______,    _______,   _______,   _______,   _______,   _______,  _______,  _______,  _______,  RGB_MOD,
+                _______,   _______,    _______,   _______,         _______,        _______,  _______,  _______,  _______
+  )
+
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case LOWER:
+      if (record->event.pressed) {
+        layer_on(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _OTHER);
+      } else {
+        layer_off(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _OTHER);
+      }
+      return false;
+      break;
+    case RAISE:
+      if (record->event.pressed) {
+        layer_on(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _OTHER);
+      } else {
+        layer_off(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _OTHER);
+      }
+      return false;
+      break;
+  }
+  return true;
+};
--- a/keyboards/the_royal/schwann/keymaps/default/rules.mk
+++ b/keyboards/the_royal/schwann/keymaps/default/rules.mk
@@ -0,0 +1 @@
+TAP_DANCE_ENABLE = yes
--- a/keyboards/the_royal/schwann/readme.md
+++ b/keyboards/the_royal/schwann/readme.md
@@ -0,0 +1,15 @@
+# Schwann PCB
+
+![schwann_render](https://i.imgur.com/04uaN8xl.jpg)
+
+A simple, HHKB ortho PCB, designed for use with the Neuron Keyboard by Wallet Burner
+
+* Keyboard Maintainer: [TheRoyalSweatshirt](https://github.com/TheRoyalSweatshirt) a.k.a [The_Royal](https://reddit.com/u/The_Royal)
+* Hardware Supported: Rev0.2 and Rev0.5 Schwann PCB
+* Hardware Availability: Private Message, Group buy, or self-procurement via the open sourced [Schwann Documentation](https://github.com/TheRoyalSweatshirt/The_Royal_Projects/tree/schwann/PCBs/Schwann_PCB).
+
+Make example for this keyboard (after setting up your build environment):
+
+    make the_royal/schwann: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).
--- a/keyboards/the_royal/schwann/rules.mk
+++ b/keyboards/the_royal/schwann/rules.mk
@@ -0,0 +1,32 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+#   Teensy       halfkay
+#   Pro Micro    caterina
+#   Atmel DFU    atmel-dfu
+#   LUFA DFU     lufa-dfu
+#   QMK DFU      qmk-dfu
+#   ATmega32A    bootloadHID
+#   ATmega328P   USBasp
+
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no        # 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
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+MIDI_ENABLE = no            # MIDI support
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+AUDIO_ENABLE = no           # Audio output on port C6
+
--- a/keyboards/the_royal/schwann/schwann.c
+++ b/keyboards/the_royal/schwann/schwann.c
@@ -0,0 +1 @@
+#include "schwann.h"
--- a/keyboards/the_royal/schwann/schwann.h
+++ b/keyboards/the_royal/schwann/schwann.h
@@ -0,0 +1,44 @@
+#pragma once
+
+#include "quantum.h"
+
+#define XXX KC_NO
+
+#define LAYOUT_mit( \
+  k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, \
+  k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, \
+  k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, \
+       k31, k32, k33, k34,    k36,   k37, k38, k39, k3A       \
+) \
+{ \
+  {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B}, \
+  {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B}, \
+  {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B}, \
+  {XXX, k31, k32, k33, k34, XXX, k36, k37, k38, k39, k3A, XXX}  \
+}
+
+#define LAYOUT_full_ortho( \
+  k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, \
+  k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, \
+  k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, \
+       k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A       \
+) \
+{ \
+  {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B}, \
+  {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B}, \
+  {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B}, \
+  {XXX, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, XXX}  \
+}
+
+#define LAYOUT_big_boy( \
+  k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, \
+  k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, \
+  k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, \
+         k31,                 k36,                 k3A        \
+) \
+{ \
+  {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B}, \
+  {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B}, \
+  {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B}, \
+  {XXX, k31, XXX, XXX, XXX, XXX, k36, XXX, XXX, XXX, k3A, XXX}  \
+}