qmk/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2026-09-07 10:53:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rework Plover HID to use Steno keycodes (#26421)

Browse Source
This commit is contained in:
Joel Challis
2026-08-27 02:13:00 +01:00
committed by GitHub
parent 0db4603acb
commit 4b16b5e520
7 changed files with 216 additions and 343 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/stenography.md
+41 -4
View File
@@ -97,19 +97,21 @@ Examples of steno strokes and the associated packet:
This mode operates independently of the other Steno "official" machine protocols. Like any other mouse or keyboard, it uses the USB HID protocol to communicate with Plover by sending an 8 byte (64 bit) packet representing a bitfield for all the possible keys on a steno machine plus a number of additional general purpose keys for custom use. This protocol is only understood by Plover as of [5.1.0](https://github.com/opensteno/plover/releases/tag/v5.1.0).
Add
To enable this functionality, add the following lines to your `rules.mk`:
```make
PLOVER_HID_ENABLE = yes
```
to your `rules.mk` file. This does **not** require `STENO_ENABLE` to be set.
::: warning
The Plover HID Protocol is currently mutually exclusive with the other steno protocols and will be disabled when `STENO_ENABLE` is set.
:::
All of the possible keycodes are defined with the `PLV_` prefix and are available without any additional includes.
All of the possible keycodes are defined with the `ST_` prefix and are available without any additional includes.
More details can be found here: https://github.com/dnaq/plover-machine-hid
### Switching protocols on the fly {#switching-protocols-on-the-fly}
## Switching protocols on the fly {#switching-protocols-on-the-fly}
If you wish to switch the serial protocol used to transfer the steno chords without having to recompile your keyboard firmware every time, you can press one of the [mode keycodes](#keycode-reference-mode) in order to switch protocols on the fly.
@@ -249,6 +251,41 @@ TX Bolt does not support the full set of keys. The TX Bolt implementation in QMK
| `QK_STENO_RESET2` | `ST_RES2` | | (Reset 2) |
| `QK_STENO_POWER` | `ST_PWR` | | (Power) |
### Protocol Specific {#keycode-reference-protocol-specific}
#### Plover HID {#keycode-reference-plover-hid}
Additional keycodes available for the [Plover HID Protocol](#plover-hid-protocol):
| Key | Aliases | Description |
|----------------|----------|-------------------------------------|
| `QK_STENO_X1` | `ST_X1` | Extra button 1 (Protocol specific) |
| `QK_STENO_X2` | `ST_X2` | Extra button 2 (Protocol specific) |
| `QK_STENO_X3` | `ST_X3` | Extra button 3 (Protocol specific) |
| `QK_STENO_X4` | `ST_X4` | Extra button 4 (Protocol specific) |
| `QK_STENO_X5` | `ST_X5` | Extra button 5 (Protocol specific) |
| `QK_STENO_X6` | `ST_X6` | Extra button 6 (Protocol specific) |
| `QK_STENO_X7` | `ST_X7` | Extra button 7 (Protocol specific) |
| `QK_STENO_X8` | `ST_X8` | Extra button 8 (Protocol specific) |
| `QK_STENO_X9` | `ST_X9` | Extra button 9 (Protocol specific) |
| `QK_STENO_X10` | `ST_X10` | Extra button 10 (Protocol specific) |
| `QK_STENO_X11` | `ST_X11` | Extra button 11 (Protocol specific) |
| `QK_STENO_X12` | `ST_X12` | Extra button 12 (Protocol specific) |
| `QK_STENO_X13` | `ST_X13` | Extra button 13 (Protocol specific) |
| `QK_STENO_X14` | `ST_X14` | Extra button 14 (Protocol specific) |
| `QK_STENO_X15` | `ST_X15` | Extra button 15 (Protocol specific) |
| `QK_STENO_X16` | `ST_X16` | Extra button 16 (Protocol specific) |
| `QK_STENO_X17` | `ST_X17` | Extra button 17 (Protocol specific) |
| `QK_STENO_X18` | `ST_X18` | Extra button 18 (Protocol specific) |
| `QK_STENO_X19` | `ST_X19` | Extra button 19 (Protocol specific) |
| `QK_STENO_X20` | `ST_X20` | Extra button 20 (Protocol specific) |
| `QK_STENO_X21` | `ST_X21` | Extra button 21 (Protocol specific) |
| `QK_STENO_X22` | `ST_X22` | Extra button 22 (Protocol specific) |
| `QK_STENO_X23` | `ST_X23` | Extra button 23 (Protocol specific) |
| `QK_STENO_X24` | `ST_X24` | Extra button 24 (Protocol specific) |
| `QK_STENO_X25` | `ST_X25` | Extra button 25 (Protocol specific) |
| `QK_STENO_X26` | `ST_X26` | Extra button 26 (Protocol specific) |
### Combined Map {#keycode-reference-combinedmap}
If you do not want to hit two keys with one finger combined keycodes can be used. These cause both keys to be reported as pressed or released. To use these keycodes define `STENO_COMBINEDMAP` in your `config.h` file.