summaryrefslogtreecommitdiffstats
path: root/docs/feature_encoders.md
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2022-03-08 16:58:05 +1100
committerGitHub <noreply@github.com>2022-03-08 16:58:05 +1100
commit2f6751e48a37699cfd999e0afd8731ca3962611c (patch)
treec64605c10a8f8f758f46be209d79210bbf15c167 /docs/feature_encoders.md
parent2218690d0b718dc68de4c5d093f1ec8e55d82d00 (diff)
Asymmetric encoders, encoder tests. (#16068)
Diffstat (limited to 'docs/feature_encoders.md')
-rw-r--r--docs/feature_encoders.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md
index 6a1a3750a6..f71c7e7325 100644
--- a/docs/feature_encoders.md
+++ b/docs/feature_encoders.md
@@ -54,6 +54,19 @@ If you are using different pinouts for the encoders on each half of a split keyb
#define ENCODER_RESOLUTIONS_RIGHT { 2, 4 }
```
+If the `_RIGHT` definitions aren't specified in your `config.h`, then the non-`_RIGHT` versions will be applied to both sides of the split.
+
+Additionally, if one side does not have an encoder, you can specify `{}` for the pins/resolution -- for example, a split keyboard with only a right-side encoder:
+
+```c
+#define ENCODERS_PAD_A { }
+#define ENCODERS_PAD_B { }
+#define ENCODER_RESOLUTIONS { }
+#define ENCODERS_PAD_A_RIGHT { B12 }
+#define ENCODERS_PAD_B_RIGHT { B13 }
+#define ENCODER_RESOLUTIONS_RIGHT { 4 }
+```
+
## Callbacks
The callback functions can be inserted into your `<keyboard>.c`: