[Keyboard] Update Support for The Uni (#14569)

Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: ridingqwerty <[email protected]> Co-authored-by: Ryan <[email protected]> Co-authored-by: Peter Park <[email protected]>
qmk · Oct 17, 2021 · 772f674 · 772f674
1 parent 3c0eeec
commit 772f674
Show file tree

Hide file tree

Showing 14 changed files with 217 additions and 130 deletions.
diff --git a/keyboards/the_uni/keymaps/default/keymap.c b/keyboards/the_uni/keymaps/default/keymap.c
@@ -19,59 +19,18 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "keymap_steno.h"
 
 enum uni_layers {
-/*
-  _QWERTY,
-  _CHOOSE,
-*/
-  _PLOVER,
-};
-
-/*
-enum uni_keycodes {
-	PLOVER,
-	QWERTY
+    _PLOVER,
 };
-*/
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-/*
-	 [_QWERTY] = LAYOUT(
-	 	KC_Q, KC_W, KC_E, KC_R, LT(_CHOOSE, KC_T), KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, 
-	 	KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, 
-	 	            KC_1, KC_C, KC_V, KC_N, KC_M, KC_2),
 
-	 [_CHOOSE] = LAYOUT(
-	 	_______, _______, _______, _______, _______, PLOVER, _______, _______, _______, _______, _______, 
-	 	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
-	 	            _______, _______, _______, _______, _______, _______),
-*/
-	[_PLOVER] = LAYOUT(
-		STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1,  STN_ST3,  STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR , 
-		STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2,  STN_ST4,  STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR , 
-		                  STN_N1,  STN_A,   STN_O,    STN_E,    STN_U,   STN_N2),
+    [_PLOVER] = LAYOUT(
+        STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1,  STN_ST3,  STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR ,
+        STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2,  STN_ST4,  STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR ,
+                          STN_N1,  STN_A,   STN_O,    STN_E,    STN_U,   STN_N2),
 
 };
 
-/*
-switch (keycode) {
- bool process_record_user(uint16_t keycode, keyrecord_t *record) {
- 	case PLOVER:
-       if (!record->event.pressed) {
-		 layer_on(_PLOVER);
-       }
-       return false;
-       break;
- 	case QWERTY:
-       if (!record->event.pressed) {
-		 layer_on(_QWERTY);
-       }
-       return false;
-       break;
- 	}
- 	return true;
- }
-*/
-
  void matrix_init_user() {
-   steno_set_mode(STENO_MODE_GEMINI); // or STENO_MODE_BOLT
+    steno_set_mode(STENO_MODE_GEMINI); // or STENO_MODE_BOLT
  }
diff --git a/keyboards/the_uni/keymaps/qwerty/keymap.c b/keyboards/the_uni/keymaps/qwerty/keymap.c
@@ -16,62 +16,15 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include QMK_KEYBOARD_H
-//#include "keymap_steno.h"
 
 enum uni_layers {
-  _QWERTY,
-/*
-  _CHOOSE,
-  _PLOVER,
-*/
+    _QWERTY,
 };
 
-/*
-enum uni_keycodes {
-	PLOVER,
-	QWERTY
-};
-*/
-
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-	 [_QWERTY] = LAYOUT(
-	 	KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, 
-	 	KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, 
-	 	            KC_1, KC_C, KC_V, KC_N, KC_M, KC_2),
-/*
-
-	 [_CHOOSE] = LAYOUT(
-	 	_______, _______, _______, _______, _______, PLOVER, _______, _______, _______, _______, _______, 
-	 	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, 
-	 	            _______, _______, _______, _______, _______, _______),
-	[_PLOVER] = LAYOUT(
-		STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1,  STN_ST3,  STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR , 
-		STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2,  STN_ST4,  STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR , 
-		                  STN_N1,  STN_A,   STN_O,    STN_E,    STN_U,   STN_N2),
-*/
+    [_QWERTY] = LAYOUT(
+        KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
+        KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+                    KC_1, KC_C, KC_V, KC_N, KC_M, KC_2),
 
 };
-
-/*
-switch (keycode) {
- bool process_record_user(uint16_t keycode, keyrecord_t *record) {
- 	case PLOVER:
-       if (!record->event.pressed) {
-		 layer_on(_PLOVER);
-       }
-       return false;
-       break;
- 	case QWERTY:
-       if (!record->event.pressed) {
-		 layer_on(_QWERTY);
-       }
-       return false;
-       break;
- 	}
- 	return true;
- }
-*/
-
- void matrix_init_user() {
-   //steno_set_mode(STENO_MODE_GEMINI); // or STENO_MODE_BOLT
- }
diff --git a/keyboards/the_uni/config.h → keyboards/the_uni/pro_micro/config.h b/keyboards/the_uni/config.h → keyboards/the_uni/pro_micro/config.h
diff --git a/keyboards/the_uni/pro_micro/pro_micro.c b/keyboards/the_uni/pro_micro/pro_micro.c
@@ -0,0 +1,18 @@
+/*
+Copyright 2021 Peter C. Park <[email protected]>
+
+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 "pro_micro.h"
diff --git a/keyboards/the_uni/the_uni.h → keyboards/the_uni/pro_micro/pro_micro.h b/keyboards/the_uni/the_uni.h → keyboards/the_uni/pro_micro/pro_micro.h
diff --git a/keyboards/the_uni/pro_micro/readme.md b/keyboards/the_uni/pro_micro/readme.md
@@ -0,0 +1,20 @@
+# The Uni
+
+-   Keyboard Maintainer: [Peter](https://github.com/petercpark)
+-   Link to Keyboard Files: [The_Uni](https://github.com/petercpark/The_Uni)
+-   Hardware Supported:
+    -   The Uni v1 and v2 (pro_micro)
+-   Hardware Availability: [https://www.stenokeyboards.com](https://www.stenokeyboards.com)
+
+# Bootloader
+
+Enter the bootloader by:
+
+* **Physical reset button**: On the Uni v3, briefly press the button on the back of the PCB.
+* **Reset Pads**: Uni v1 and v2 have pins/pads you must short instead (RST to GND).
+
+Make examples for this keyboard (after setting up your build environment):
+
+    make the_uni/pro_micro: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/the_uni/pro_micro/rules.mk b/keyboards/the_uni/pro_micro/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = no        # 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
+AUDIO_ENABLE = no           # Audio output
+STENO_ENABLE = yes
diff --git a/keyboards/the_uni/readme.md b/keyboards/the_uni/readme.md
@@ -1,19 +1,31 @@
 # The Uni
 
-![The Uni](https://raw.githubusercontent.com/petercpark/The_Uni/main/Pics/layout.png)
-![The Uni Closeup](https://github.com/petercpark/The_Uni/blob/main/Pics/close-up-uni.jpg?raw=true)
+
+![Layout](https://docs.stenokeyboards.com/images/uni-layout.png)
+![The Uni v2](https://github.com/petercpark/The_Uni/blob/main/Pics/uni%20v2/uni-v2.JPG?raw=true)
 
 A compact unibody split ortholinear keyboard made specifically for stenography.
 
--   Keyboard Maintainer: [Peter C. Park](https://github.com/petercpark)
--   Link to Keyboard Files: [The_Uni](https://github.com/petercpark/The_Uni)
--   Hardware Supported: The Uni v1 and v2 (pro micro or equivalent)
--   Hardware Availability: [website](https://www.stenokeyboards.com)
+-   Keyboard Maintainer: [Peter](https://github.com/petercpark)
+-   Link to Keyboard Files (pro_micro version): [https://github.com/petercpark/The_Uni](https://github.com/petercpark/The_Uni)
+-   Hardware Supported:
 
-Make example for this keyboard (after setting up your build environment):
+    -   The Uni v1 and v2 (pro_micro)
+    -   The Uni v3 (usb_c)
 
-    make the_uni:default
+-   Hardware Availability: [https://www.stenokeyboards.com](https://www.stenokeyboards.com)
 
-To enter the bootloader, short the rst and gnd pins with a conductive material such as a tweezer or a wire. Uni v2 will have reset pads next to the pro micro so you can short these pads to reset the pro micro.
+# Bootloader
+
+Enter the bootloader by:
+
+* **Physical reset button**: On the Uni v3, briefly press the button on the back of the PCB.
+* **Reset Pads**: Uni v1 and v2 have pins/pads you must short instead (RST to GND).
+
+Make examples for this keyboard (after setting up your build environment):
+
+    make the_uni/pro_micro:default
+
+    make the_uni/usb_c: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/the_uni/rules.mk b/keyboards/the_uni/rules.mk
diff --git a/keyboards/the_uni/usb_c/config.h b/keyboards/the_uni/usb_c/config.h
@@ -0,0 +1,52 @@
+/*
+Copyright 2021 Peter C. Park <[email protected]>
+
+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       0x9000
+#define PRODUCT_ID      0x0001
+#define DEVICE_VER      0x0002
+#define MANUFACTURER    stenokeyboards
+#define PRODUCT         The Uni
+
+/* key matrix size */
+#define MATRIX_ROWS 3
+#define MATRIX_COLS 11
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS { B7, D6, C7 }
+#define MATRIX_COL_PINS { F0, F1, F4, F5, F6, D5, D3, D2, D1, D0, D4 }
+#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
+
+
+/*force the nkro if it does not work*/
+#define FORCE_NKRO
diff --git a/keyboards/the_uni/usb_c/readme.md b/keyboards/the_uni/usb_c/readme.md
@@ -0,0 +1,20 @@
+# The Uni v3 Firmware
+
+-   Keyboard Maintainer: [Peter](https://github.com/petercpark)
+-   Link to Keyboard Files: Not Available
+-   Hardware Supported:
+    -   The Uni v3 (usb_c)
+-   Hardware Availability: [https://www.stenokeyboards.com](https://www.stenokeyboards.com)
+
+## Bootloader
+
+Enter the bootloader by:
+
+* **Physical reset button**: On the Uni v3, briefly press the button on the back of the PCB.
+* **Reset Pads**: Uni v1 and v2 have pins/pads you must short instead (RST to GND).
+
+Make examples for this keyboard (after setting up your build environment):
+
+    make the_uni/usb_c: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/the_uni/usb_c/rules.mk b/keyboards/the_uni/usb_c/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = no        # 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
+AUDIO_ENABLE = no           # Audio output
+STENO_ENABLE = yes
diff --git a/keyboards/the_uni/the_uni.c → keyboards/the_uni/usb_c/usb_c.c b/keyboards/the_uni/the_uni.c → keyboards/the_uni/usb_c/usb_c.c
@@ -15,4 +15,4 @@ 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 "the_uni.h"
+#include "usb_c.h"
diff --git a/keyboards/the_uni/usb_c/usb_c.h b/keyboards/the_uni/usb_c/usb_c.h
@@ -0,0 +1,30 @@
+/*
+Copyright 2021 Peter C. Park <[email protected]>
+
+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( \
+	K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, \
+	K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, \
+	            K202, K203, K204, K205, K206, K207  \
+) { \
+	{ K000,  K001,  K002,  K003,  K004,  K005,  K006,  K007,  K008,  K009,  K010 }, \
+	{ K100,  K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110 }, \
+	{ KC_NO, KC_NO, K202,  K203,  K204,  K205,  K206,  K207,  KC_NO, KC_NO, KC_NO }  \
+}