Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove requirement for keymap_steno.h include in keymaps #22423

Merged
merged 2 commits into from
Nov 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/feature_stenography.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ After enabling stenography and optionally selecting a protocol, you may also nee

!> If you had *explicitly* set `VIRSTER_ENABLE = no`, none of the serial stenography protocols (GeminiPR, TX Bolt) will work properly. You are expected to either set it to `yes`, remove the line from your `rules.mk` or send the steno chords yourself in an alternative way using the [provided interceptable hooks](#interfacing-with-the-code).

In your keymap, create a new layer for Plover, that you can fill in with the [steno keycodes](#keycode-reference) (you will need to include `keymap_steno.h`, see `planck/keymaps/steno/keymap.c` for an example). Remember to create a key to switch to the layer as well as a key for exiting the layer.
In your keymap, create a new layer for Plover, that you can fill in with the [steno keycodes](#keycode-reference). Remember to create a key to switch to the layer as well as a key for exiting the layer.

Once you have your keyboard flashed, launch Plover. Click the 'Configure...' button. In the 'Machine' tab, select the Stenotype Machine that corresponds to your desired protocol. Click the 'Configure...' button on this tab and enter the serial port or click 'Scan'. Baud rate is fine at 9600 (although you should be able to set as high as 115200 with no issues). Use the default settings for everything else (Data Bits: 8, Stop Bits: 1, Parity: N, no flow control).

Expand Down Expand Up @@ -149,8 +149,6 @@ At the end of this scenario given as an example, `chord` would have five bits se

## Keycode Reference :id=keycode-reference

You must include `keymap_steno.h` to your `keymap.c` with `#include "keymap_steno.h"` before you can use these keycodes

> Note: TX Bolt does not support the full set of keys. The TX Bolt implementation in QMK will map the GeminiPR keys to the nearest TX Bolt key so that one key map will work for both.

|GeminiPR|TX Bolt|Steno Key|
Expand Down Expand Up @@ -198,7 +196,7 @@ You must include `keymap_steno.h` to your `keymap.c` with `#include "keymap_sten
|`STN_RES2`||(Reset 2)|
|`STN_PWR`||(Power)|

If you do not want to hit two keys with one finger combined keycodes can be used. These are also defined in `keymap_steno.h`, and causes both keys to be reported as pressed or released. To use these keycodes define `STENO_COMBINEDMAP` in your `config.h` file.
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.

|Combined key | Key1 | Key 2 |
|---------------|--------|----------|
Expand Down
1 change: 0 additions & 1 deletion docs/reference_keymap_extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,5 @@ There are also a few which are not quite language-specific, but useful if you ar
|Norman |`keymap_norman.h` |`sendstring_norman.h` |
|Plover |`keymap_plover.h` | |
|Plover (Dvorak) |`keymap_plover_dvorak.h` | |
|Steno |`keymap_steno.h` | |
|Workman |`keymap_workman.h` |`sendstring_workman.h` |
|Workman (ZXCVM) |`keymap_workman_zxcvm.h` |`sendstring_workman_zxcvm.h` |
1 change: 0 additions & 1 deletion keyboards/40percentclub/gherkin/keymaps/steno/keymap.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#include QMK_KEYBOARD_H
#include "keymap_steno.h"

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
LAYOUT_ortho_3x10(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#include QMK_KEYBOARD_H
#include "keymap_steno.h"

#define ST_BOLT QK_STENO_BOLT
#define ST_GEM QK_STENO_GEMINI
Expand Down
1 change: 0 additions & 1 deletion keyboards/chord/zero/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = LAYOUT(
Expand Down
3 changes: 0 additions & 3 deletions keyboards/ergodox_ez/keymaps/steno/keymap.c
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
#include QMK_KEYBOARD_H
#include "debug.h"
#include "action_layer.h"
#include "keymap_steno.h"

#define BASE 0 // default layer
#define SYMB 1 // symbols
Expand Down
1 change: 0 additions & 1 deletion keyboards/eyeohdesigns/babyv/keymaps/bghull/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"
#include "g/keymap_combo.h"


Expand Down
1 change: 0 additions & 1 deletion keyboards/gboards/butterstick/sten.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
#pragma once

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

extern size_t keymapsCount; // Total keymaps
extern uint32_t cChord; // Current Chord
Expand Down
1 change: 0 additions & 1 deletion keyboards/gboards/georgi/keymaps/colemak-dh/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@

#include QMK_KEYBOARD_H
#include "sten.h"
#include "keymap_steno.h"

// Steno Layers
#define FUNCT ( LSD | LK | LP | LH )
Expand Down
1 change: 0 additions & 1 deletion keyboards/gboards/georgi/keymaps/default-flipped/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@

#include QMK_KEYBOARD_H
#include "sten.h"
#include "keymap_steno.h"

// Proper Layers
#define FUNCT (LSD | LK | LP | LH)
Expand Down
1 change: 0 additions & 1 deletion keyboards/gboards/georgi/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@

#include QMK_KEYBOARD_H
#include "sten.h"
#include "keymap_steno.h"

// Proper Layers
#define FUNCT (LSD | LK | LP | LH)
Expand Down
1 change: 0 additions & 1 deletion keyboards/gboards/georgi/keymaps/minimal/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@

#include QMK_KEYBOARD_H
#include "sten.h"
#include "keymap_steno.h"

// Proper Layers
#define FUNCT (LSD | LK | LP | LH)
Expand Down
1 change: 0 additions & 1 deletion keyboards/gboards/georgi/keymaps/norman/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@

#include QMK_KEYBOARD_H
#include "sten.h"
#include "keymap_steno.h"

// Proper Layers
#define FUNCT (LSD | LK | LP | LH)
Expand Down
1 change: 0 additions & 1 deletion keyboards/gboards/georgi/sten.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
#pragma once

#include "georgi.h"
#include "keymap_steno.h"

extern size_t keymapsCount; // Total keymaps
extern uint32_t cChord; // Current Chord
Expand Down
1 change: 0 additions & 1 deletion keyboards/handwired/split_cloud/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

// clang-format off

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
#include QMK_KEYBOARD_H
#include "debug.h"
#include "action_layer.h"
#include "version.h"
#include "keymap_steno.h"
#ifndef MIDI_ENABLE
#error "Midi is not enabled"
#endif
Expand Down
1 change: 0 additions & 1 deletion keyboards/jian/keymaps/advanced/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ typedef union {
user_config_t user_config;

#ifdef STENO_ENABLE
#include "keymap_steno.h"
#endif // STENO_ENABLE


Expand Down
1 change: 0 additions & 1 deletion keyboards/kbdfans/niu_mini/keymaps/yttyx/keymap.c
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum layers {
_BA, // Base (Balance Twelve mirror variant)
Expand Down
2 changes: 0 additions & 2 deletions keyboards/keebio/levinson/keymaps/dcompact/keymap.c
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
#include QMK_KEYBOARD_H

#include "keymap_steno.h"

// Custom Keycodes and Combinations Used
#define DEL_SHF SFT_T(KC_DEL)
#define QUAKE LCTL(KC_GRV)
Expand Down
1 change: 0 additions & 1 deletion keyboards/keebio/levinson/keymaps/steno/keymap.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#include QMK_KEYBOARD_H
#include "keymap_steno.h"

extern keymap_config_t keymap_config;

Expand Down
1 change: 0 additions & 1 deletion keyboards/lily58/keymaps/narze/keymap.c
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#include QMK_KEYBOARD_H
#include "narze.h"
#include "keymap_colemak.h"
#include "keymap_steno.h"


#ifdef RGBLIGHT_ENABLE
Expand Down
1 change: 0 additions & 1 deletion keyboards/mechwild/bbs/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

// Defines names for use in layer keycodes and the keymap
enum layer_names {
Expand Down
1 change: 0 additions & 1 deletion keyboards/mechwild/sugarglider/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

// Defines names for use in layer keycodes and the keymap
enum layer_names {
Expand Down
3 changes: 0 additions & 3 deletions keyboards/planck/keymaps/altgr/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,6 @@


#include QMK_KEYBOARD_H
#ifdef STENO_ENABLE
#include "keymap_steno.h"
#endif

extern keymap_config_t keymap_config;

Expand Down
1 change: 0 additions & 1 deletion keyboards/planck/keymaps/bghull/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"
#include "g/keymap_combo.h"
#include "muse.h"

Expand Down
1 change: 0 additions & 1 deletion keyboards/planck/keymaps/dcompact/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

// Custom Keycodes and Combinations Used
#define DEL_SHF SFT_T(KC_DEL)
Expand Down
1 change: 0 additions & 1 deletion keyboards/planck/keymaps/experimental/keymap.c
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@

#include QMK_KEYBOARD_H
#include "keymap_steno.h"
#include "version.h"

extern keymap_config_t keymap_config;
Expand Down
3 changes: 0 additions & 3 deletions keyboards/planck/keymaps/hiea/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,6 @@


#include QMK_KEYBOARD_H
#ifdef STENO_ENABLE
#include "keymap_steno.h"
#endif

extern keymap_config_t keymap_config;

Expand Down
3 changes: 0 additions & 3 deletions keyboards/planck/keymaps/hieax/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,6 @@


#include QMK_KEYBOARD_H
#ifdef STENO_ENABLE
#include "keymap_steno.h"
#endif

extern keymap_config_t keymap_config;

Expand Down
3 changes: 0 additions & 3 deletions keyboards/planck/keymaps/sdothum/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,6 @@


#include QMK_KEYBOARD_H
#ifdef STENO_ENABLE
#include "keymap_steno.h"
#endif

extern keymap_config_t keymap_config;

Expand Down
1 change: 0 additions & 1 deletion keyboards/planck/keymaps/steno/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

extern keymap_config_t keymap_config;

Expand Down
1 change: 0 additions & 1 deletion keyboards/planck/keymaps/yttyx/keymap.c
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum layers {
_BA, // Base (Balance Twelve mirror variant)
Expand Down
1 change: 0 additions & 1 deletion keyboards/preonic/keymaps/bghull/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum preonic_layers {
_QWERTY,
Expand Down
1 change: 0 additions & 1 deletion keyboards/splitography/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum keyboard_layers {
_QWERTY = 0,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum keyboard_layers {
_QWERTY = 0,
Expand Down
1 change: 0 additions & 1 deletion keyboards/splitography/keymaps/dvorak/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum keyboard_layers {
_DVORAK = 0,
Expand Down
1 change: 0 additions & 1 deletion keyboards/splitography/keymaps/jeandeaual/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum keyboard_layers {
_GEMINI = 0,
Expand Down
1 change: 0 additions & 1 deletion keyboards/splitography/keymaps/multi/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum keyboard_layers {
_QWERTY = 0,
Expand Down
1 change: 0 additions & 1 deletion keyboards/stenokeyboards/the_uni/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum uni_layers {
_PLOVER,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

enum uni_layers {
_PLOVER,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

// Custom Keycodes and Combinations Used
#define DEL_SHF SFT_T(KC_DEL)
Expand Down
1 change: 0 additions & 1 deletion keyboards/xiudi/xd75/keymaps/raoeus/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
*/

#include QMK_KEYBOARD_H
#include "keymap_steno.h"

void matrix_init_user(void) {
steno_set_mode(STENO_MODE_GEMINI);
Expand Down
Loading
Loading