aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-08-14 22:39:08 -0700
committerGitHub <noreply@github.com>2021-08-15 15:39:08 +1000
commit488aaa0980b113240a461d6d7878c62f5663f5c6 (patch)
treee660854792b5a2b5ae357b0bb6a5115c2daea99a /docs
parent4b3691e72da69290f63e859bb6ecb55dc561ece5 (diff)
downloadqmk_firmware-488aaa0980b113240a461d6d7878c62f5663f5c6.tar.gz
qmk_firmware-488aaa0980b113240a461d6d7878c62f5663f5c6.zip
Enable sync of OLED/ST7565 display on/off state on Splits (#13542)
* Enable sync of OLED/ST7565 display on/off state on Splits * Only send if states are not matched Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md6
-rw-r--r--docs/feature_split_keyboard.md12
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 78c1f70fd..94f99e74c 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -343,6 +343,12 @@ There are a few different ways to set handedness for split keyboards (listed in
343* `#define SPLIT_WPM_ENABLE` 343* `#define SPLIT_WPM_ENABLE`
344 * Ensures the current WPM is available on the slave when using the QMK-provided split transport. 344 * Ensures the current WPM is available on the slave when using the QMK-provided split transport.
345 345
346* `#define SPLIT_OLED_ENABLE`
347 * Syncs the on/off state of the OLED between the halves.
348
349* `#define SPLIT_ST7565_ENABLE`
350 * Syncs the on/off state of the ST7565 screen between the halves.
351
346* `#define SPLIT_TRANSACTION_IDS_KB .....` 352* `#define SPLIT_TRANSACTION_IDS_KB .....`
347* `#define SPLIT_TRANSACTION_IDS_USER .....` 353* `#define SPLIT_TRANSACTION_IDS_USER .....`
348 * Allows for custom data sync with the slave when using the QMK-provided split transport. See [custom data sync between sides](feature_split_keyboard.md#custom-data-sync) for more information. 354 * Allows for custom data sync with the slave when using the QMK-provided split transport. See [custom data sync between sides](feature_split_keyboard.md#custom-data-sync) for more information.
diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
index 428d581ca..a84d38460 100644
--- a/docs/feature_split_keyboard.md
+++ b/docs/feature_split_keyboard.md
@@ -233,6 +233,18 @@ This enables transmitting modifier state (normal, weak and oneshot) to the non p
233 233
234This enables transmitting the current WPM to the slave side of the split keyboard. The purpose of this feature is to support cosmetic use of WPM (e.g. displaying the current value on an OLED screen). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. 234This enables transmitting the current WPM to the slave side of the split keyboard. The purpose of this feature is to support cosmetic use of WPM (e.g. displaying the current value on an OLED screen). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
235 235
236```c
237#define SPLIT_OLED_ENABLE
238```
239
240This enables transmitting the current OLED on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
241
242```c
243#define SPLIT_ST7565_ENABLE
244```
245
246This enables transmitting the current ST7565 on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
247
236### Custom data sync between sides :id=custom-data-sync 248### Custom data sync between sides :id=custom-data-sync
237 249
238QMK's split transport allows for arbitrary data transactions at both the keyboard and user levels. This is modelled on a remote procedure call, with the master invoking a function on the slave side, with the ability to send data from master to slave, process it slave side, and send data back from slave to master. 250QMK's split transport allows for arbitrary data transactions at both the keyboard and user levels. This is modelled on a remote procedure call, with the master invoking a function on the slave side, with the ability to send data from master to slave, process it slave side, and send data back from slave to master.