Skip to content

Commit

Permalink
Set the default steno protocol to "all"
Browse files Browse the repository at this point in the history
This is done so that existing keymaps invoking `steno_set_mode` don't
all suddenly break
  • Loading branch information
precondition committed Jun 22, 2022
1 parent 105b1ec commit 7600b65
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion builddefs/common_features.mk
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ ifeq ($(MUSIC_ENABLE), yes)
endif

VALID_STENO_PROTOCOL_TYPES := geminipr txbolt all
STENO_PROTOCOL ?= geminipr
STENO_PROTOCOL ?= all
ifeq ($(strip $(STENO_ENABLE)), yes)
ifeq ($(filter $(STENO_PROTOCOL),$(VALID_STENO_PROTOCOL_TYPES)),)
$(call CATASTROPHIC_ERROR,Invalid STENO_PROTOCOL,STENO_PROTOCOL="$(STENO_PROTOCOL)" is not a valid stenography protocol)
Expand Down
4 changes: 2 additions & 2 deletions docs/feature_stenography.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ STENO_PROTOCOL = txbolt

GeminiPR encodes 42 keys into a 6-byte packet. While TX Bolt contains everything that is necessary for standard stenography, GeminiPR opens up many more options, including differentiating between top and bottom `S-`, and supporting non-English theories.

This is the default stenography protocol.

To select it, add the following lines to your `rules.mk`:
```mk
STENO_ENABLE = yes
Expand All @@ -67,6 +65,8 @@ The default protocol is Gemini PR but the last protocol used is stored in non-vo

Naturally, this option takes the most amount of firmware space as it needs to compile the code for all the available stenography protocols. In most cases, compiling a single stenography protocol is sufficient.

The default value for `STENO_PROTOCOL` is `all`.

## Configuring QMK for Steno :id=configuring-qmk-for-steno

After enabling stenography and optionally selecting a protocol, you may also need disable mouse keys, extra keys, or another USB endpoint to prevent conflicts. The builtin USB stack for some processors only supports a certain number of USB endpoints and the virtual serial port needed for steno fills 3 of them.
Expand Down

0 comments on commit 7600b65

Please sign in to comment.