Skip to content

Commit

Permalink
Mention how to use steno_set_mode
Browse files Browse the repository at this point in the history
  • Loading branch information
precondition committed Jun 22, 2022
1 parent 8f6ca84 commit 105b1ec
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/feature_stenography.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ STENO_ENABLE = yes
STENO_PROTOCOL = all
```

If you want to switch protocols programatically, as part of a custom macro for example, don't use `tap_code(QK_STENO_*)`, as `tap_code` only supports [basic keycodes](keycodes_basic). Instead, you should use `steno_set_mode(STENO_MODE_*)`, whose valid arguments are `STENO_MODE_BOLT` and `STENO_MODE_GEMINI`.

The default protocol is Gemini PR but the last protocol used is stored in non-volatile memory so QMK will remember your choice between reboots of your keyboard — assuming that your keyboard features (emulated) EEPROM.

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.
Expand Down

0 comments on commit 105b1ec

Please sign in to comment.