Jelajahi Sumber

The Uni keyboard. Add keyboard (#12566)

* first commit

* Apply suggestions from code review

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Apply suggestions from code review by ridingqwerty

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
Peter Park 4 tahun lalu
induk
melakukan
1c81e69503

+ 52 - 0
keyboards/the_uni/config.h

@@ -0,0 +1,52 @@
+/*
+Copyright 2021 Peter C. Park <peter@stenokeyboards.com>
+
+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      0x0001
+#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 { F4, B2, B6 }
+#define MATRIX_COL_PINS { F5, F6, F7, B1, B3, B5, B4, E6, D7, C6, 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

+ 41 - 0
keyboards/the_uni/info.json

@@ -0,0 +1,41 @@
+{
+    "keyboard_name": "The Uni",
+    "url": "https://www.stenokeyboards.com",
+    "maintainer": "qmk",
+    "width": 13,
+    "height": 4,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                { "x": 0, "y": 0 },
+                { "x": 1, "y": 0 },
+                { "x": 2, "y": 0 },
+                { "x": 3, "y": 0 },
+                { "x": 4, "y": 0 },
+                { "x": 7, "y": 0 },
+                { "x": 8, "y": 0 },
+                { "x": 9, "y": 0 },
+                { "x": 10, "y": 0 },
+                { "x": 11, "y": 0 },
+                { "x": 12, "y": 0 },
+                { "x": 0, "y": 1 },
+                { "x": 1, "y": 1 },
+                { "x": 2, "y": 1 },
+                { "x": 3, "y": 1 },
+                { "x": 4, "y": 1 },
+                { "x": 7, "y": 1 },
+                { "x": 8, "y": 1 },
+                { "x": 9, "y": 1 },
+                { "x": 10, "y": 1 },
+                { "x": 11, "y": 1 },
+                { "x": 12, "y": 1 },
+                { "x": 2, "y": 3 },
+                { "x": 3, "y": 3 },
+                { "x": 4, "y": 3 },
+                { "x": 7, "y": 3 },
+                { "x": 8, "y": 3 },
+                { "x": 9, "y": 3 }
+            ]
+        }
+    }
+}

+ 77 - 0
keyboards/the_uni/keymaps/default/keymap.c

@@ -0,0 +1,77 @@
+/*
+Copyright 2021 Peter C. Park <peter@stenokeyboards.com>
+
+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_steno.h"
+
+enum uni_layers {
+/*
+  _QWERTY,
+  _CHOOSE,
+*/
+  _PLOVER,
+};
+
+/*
+enum uni_keycodes {
+	PLOVER,
+	QWERTY
+};
+*/
+
+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),
+
+};
+
+/*
+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
+ }

+ 77 - 0
keyboards/the_uni/keymaps/qwerty/keymap.c

@@ -0,0 +1,77 @@
+/*
+Copyright 2021 Peter C. Park <peter@stenokeyboards.com>
+
+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_steno.h"
+
+enum uni_layers {
+  _QWERTY,
+/*
+  _CHOOSE,
+  _PLOVER,
+*/
+};
+
+/*
+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),
+*/
+
+};
+
+/*
+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
+ }

+ 19 - 0
keyboards/the_uni/readme.md

@@ -0,0 +1,19 @@
+# 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)
+​
+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)
+    ​
+    Make example for this keyboard (after setting up your build environment):
+    ​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.
+    make the_uni: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).

+ 21 - 0
keyboards/the_uni/rules.mk

@@ -0,0 +1,21 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader
+BOOTLOADER = atmel-dfu
+
+
+# Build Options
+#   comment out to disable the options.
+#
+BOOTMAGIC_ENABLE = lite	# Virtual DIP switch configuration
+CONSOLE_ENABLE = no	# Console for debug
+COMMAND_ENABLE = no    # Commands for debug and configuration
+SLEEP_LED_ENABLE = no  # Breathing sleep LED during USB suspend
+NKRO_ENABLE = yes		# USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no  # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no
+FORCE_NKRO = yes
+EXTRAKEY_ENABLE = no
+MOUSEKEY_ENABLE = no        # Mouse keys
+STENO_ENABLE = yes      

+ 18 - 0
keyboards/the_uni/the_uni.c

@@ -0,0 +1,18 @@
+/*
+Copyright 2021 Peter C. Park <peter@stenokeyboards.com>
+
+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 "the_uni.h"

+ 30 - 0
keyboards/the_uni/the_uni.h

@@ -0,0 +1,30 @@
+/*
+Copyright 2021 Peter C. Park <peter@stenokeyboards.com>
+
+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 }  \
+}