aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_stenography.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_stenography.md')
-rw-r--r--docs/feature_stenography.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/feature_stenography.md b/docs/feature_stenography.md
index 9fb224b5d..0b2c82422 100644
--- a/docs/feature_stenography.md
+++ b/docs/feature_stenography.md
@@ -56,6 +56,29 @@ On the display tab click 'Open stroke display'. With Plover disabled you should
56* [Steno Jig](https://joshuagrams.github.io/steno-jig/) 56* [Steno Jig](https://joshuagrams.github.io/steno-jig/)
57* More resources at the Plover [Learning Stenography](https://github.com/openstenoproject/plover/wiki/Learning-Stenography) wiki 57* More resources at the Plover [Learning Stenography](https://github.com/openstenoproject/plover/wiki/Learning-Stenography) wiki
58 58
59## Interfacing with the code
60
61The steno code has three interceptible hooks. If you define these functions, they will be called at certain points in processing; if they return true, processing continues, otherwise it's assumed you handled things.
62
63```C
64bool send_steno_chord_user(steno_mode_t mode, uint8_t chord[6]);
65```
66
67This function is called when a chord is about to be sent. Mode will be one of `STENO_MODE_BOLT` or `STENO_MODE_GEMINI`. This represents the actual chord that would be sent via whichever protocol. You can modify the chord provided to alter what gets sent. Remember to return true if you want the regular sending process to happen.
68
69```C
70bool process_steno_user(uint16_t keycode, keyrecord_t *record) { return true; }
71```
72
73This function is called when a keypress has come in, before it is processed. The keycode should be one of `QK_STENO_BOLT`, `QK_STENO_GEMINI`, or one of the `STN_*` key values.
74
75```C
76bool postprocess_steno_user(uint16_t keycode, keyrecord_t *record, steno_mode_t mode, uint8_t chord[6], int8_t pressed);
77```
78
79This function is called after a key has been processed, but before any decision about whether or not to send a chord. If `IS_PRESSED(record->event)` is false, and `pressed` is 0 or 1, the chord will be sent shortly, but has not yet been sent. This is where to put hooks for things like, say, live displays of steno chords or keys.
80
81
59## Keycode Reference 82## Keycode Reference
60 83
61As defined in `keymap_steno.h`. 84As defined in `keymap_steno.h`.
@@ -106,3 +129,4 @@ As defined in `keymap_steno.h`.
106|`STN_RES1`||(GeminiPR only)| 129|`STN_RES1`||(GeminiPR only)|
107|`STN_RES2`||(GeminiPR only)| 130|`STN_RES2`||(GeminiPR only)|
108|`STN_PWR`||(GeminiPR only)| 131|`STN_PWR`||(GeminiPR only)|
132