Browse Source

Add ows steno board (#25984)

ivan 5 months ago
parent
commit
45ccd2e935

+ 74 - 0
keyboards/ivndbt/ows/keyboard.json

@@ -0,0 +1,74 @@
+{
+    "keyboard_name": "OWS",
+    "manufacturer": "ivndbt",
+    "url": "https://github.com/ivndbt/obiwanstenobit",
+    "maintainer": "ivndbt",
+    "usb": {
+        "vid": "0x6961",
+        "pid": "0x3033",
+        "device_version": "0.1.1"
+    },
+    "development_board": "promicro_rp2040",
+    "diode_direction": "COL2ROW",
+    "matrix_pins": {
+        "cols": ["GP4", "GP5", "GP6", "GP8", "GP7", "GP22", "GP26", "GP21", "GP23", "GP20"],
+        "rows": ["GP9", "GP28", "GP27"]
+    },
+    "features": {
+        "bootmagic": true,
+        "nkro": true,
+        "steno": true,
+        "mousekey": false,
+        "extrakey": true
+    },
+    "host": {
+        "default": {
+            "nkro": true
+        }
+    },
+    "stenography": {
+        "enabled": true,
+        "protocol": "geminipr"
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"matrix": [2, 8], "x": 0, "y": 0},
+                {"matrix": [0, 9], "x": 1, "y": 0},
+                {"matrix": [0, 8], "x": 2, "y": 0},
+                {"matrix": [0, 7], "x": 3, "y": 0},
+                {"matrix": [0, 6], "x": 4, "y": 0},
+                {"matrix": [0, 5], "x": 5, "y": 0},
+
+                {"matrix": [0, 0], "x": 8, "y": 0},
+                {"matrix": [0, 1], "x": 9, "y": 0},
+                {"matrix": [0, 2], "x": 10, "y": 0},
+                {"matrix": [0, 3], "x": 11, "y": 0},
+                {"matrix": [0, 4], "x": 12, "y": 0},
+                {"matrix": [2, 3], "x": 13, "y": 0},
+
+                {"matrix": [2, 9], "x": 0, "y": 1},
+                {"matrix": [1, 9], "x": 1, "y": 1},
+                {"matrix": [1, 8], "x": 2, "y": 1},
+                {"matrix": [1, 7], "x": 3, "y": 1},
+                {"matrix": [1, 6], "x": 4, "y": 1},
+                {"matrix": [1, 5], "x": 5, "y": 1},
+
+                {"matrix": [1, 0], "x": 8, "y": 1},
+                {"matrix": [1, 1], "x": 9, "y": 1},
+                {"matrix": [1, 2], "x": 10, "y": 1},
+                {"matrix": [1, 3], "x": 11, "y": 1},
+                {"matrix": [1, 4], "x": 12, "y": 1},
+                {"matrix": [2, 4], "x": 13, "y": 1},
+
+                {"matrix": [2, 7], "x": 3, "y": 3},
+                {"matrix": [2, 6], "x": 4, "y": 3},
+                {"matrix": [2, 5], "x": 5, "y": 3},
+                
+                {"matrix": [2, 0], "x": 8, "y": 3},
+                {"matrix": [2, 1], "x": 9, "y": 3},
+                {"matrix": [2, 2], "x": 10, "y": 3}
+            ]
+        }
+    }
+}

+ 49 - 0
keyboards/ivndbt/ows/keymaps/default/keymap.c

@@ -0,0 +1,49 @@
+// Copyright 2026 ivndbt
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+// Layers declarations
+enum layers {
+    _PLOVER,
+    _LOWER,
+    _RAISE,
+    _CONTROL,
+    _QWERTY
+};
+
+#define LOWER TL_LOWR
+#define RAISE TL_UPPR
+#define QWERTY TG(_QWERTY)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+[_PLOVER] = LAYOUT(
+    LOWER,  STN_S1, STN_TL, STN_PL, STN_HL, STN_ST1,    STN_ST3, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR,
+    RAISE,  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
+  ),
+
+[_LOWER] = LAYOUT(
+    _______,  _______,  _______,  _______,  _______,  KC_DEL,   KC_ESC,   _______,  KC_UP,    _______,  KC_PGUP,  _______,
+    _______,  _______,  _______,  _______,  _______,  _______,  KC_TAB,   KC_LEFT,  KC_DOWN,  KC_RGHT,  KC_PGDN,  _______,
+                                  _______,  _______,  _______,  KC_HOME,  KC_END,   _______
+  ),
+
+[_RAISE] = LAYOUT(
+    _______,  _______,  _______,  _______,  _______,  _______,  KC_MUTE,  KC_VOLD,  KC_VOLU,  _______,  _______,  _______,
+    _______,  _______,  _______,  _______,  _______,  _______,  _______,  KC_BRID,  KC_BRIU,  _______,  _______,  _______,
+                                  _______,  _______,  _______,  KC_MPRV,  KC_MPLY,  KC_MNXT
+  ),
+
+[_CONTROL] = LAYOUT(
+    _______,    XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  QK_BOOT,    XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  QWERTY,
+    _______,    XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  QK_RBT,     XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,  XXXXXXX,
+                                    XXXXXXX,  XXXXXXX,  XXXXXXX,    XXXXXXX,  XXXXXXX,  XXXXXXX
+  ),
+
+[_QWERTY] = LAYOUT(
+    KC_BSPC,  KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, QWERTY,
+    KC_SPC,   KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_Z, KC_ENT,
+                          KC_X, KC_C, KC_V, KC_B, KC_N, KC_M
+  )
+};

+ 6 - 0
keyboards/ivndbt/ows/keymaps/default/readme.md

@@ -0,0 +1,6 @@
+# OWS usage
+
+OWS is meant to be use with [Plover](https://opensteno.org/plover/) via the GeminiPR steno protocol.\
+To get started, make sure to follow the setup guide described in the [Plover Wiki](https://plover.wiki/index.php/Setting_up_a_hobbyist_writer_with_Plover) for hobbyist writers.
+
+For an in-depth look at its features, please visit the [project repository](https://github.com/ivndbt/obiwanstenobit).

+ 1 - 0
keyboards/ivndbt/ows/keymaps/default/rules.mk

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

+ 32 - 0
keyboards/ivndbt/ows/readme.md

@@ -0,0 +1,32 @@
+# OWS
+
+Open-source steno keyboard with a pseudo-split layout, designed to be compact, portable, and cost-effective.
+
+![OWS](https://i.imgur.com/OKkenaR.jpeg "OWS v1 prototype")
+
+* Keyboard maintainer: [ivndbt](https://github.com/ivndbt)
+* Hardware supported: Pro Micro RP2040
+* Hardware Availability: OWS is open-source, check the [project repository](https://github.com/ivndbt/obiwanstenobit)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make ivndbt/ows:default
+
+Flashing example for this keyboard:
+
+    make ivndbt/ows: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).
+
+## Bootloader
+
+1. There are 4 ways to enter the bootloader:
+
+    * **Physical reset button**: Double tap the `RST` button located on the back of the Controller PCB.
+    * **Physical boot button**: Hold the `BOOT` button as you plug the RP2040
+    * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (the top-left key on the right-hand Main PCB) while plugging in the keyboard.
+    * **Keycode in layout**: Press the key assigned to `QK_BOOT` if it is available
+
+2. Wait for the OS to detect the device
+3. Copy the `.uf2` file to the new USB disk or flash via QMK CLI
+4. Wait for the keyboard to become available