summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2018-10-26 16:19:23 -0400
committerDrashna Jaelre <drashna@live.com>2018-10-26 14:24:13 -0700
commit85688e5b52112c86895171d3dc8b26610480e932 (patch)
tree03f3f7bf585ebdf158576aeb6a8cf0c8c5319d6f /docs
parente22c3992454ade93ccaef70ab077e79a4b2a5ef0 (diff)
add support for encoders to core
Diffstat (limited to 'docs')
-rw-r--r--docs/_sidebar.md1
-rw-r--r--docs/_summary.md1
-rw-r--r--docs/feature_encoders.md41
3 files changed, 43 insertions, 0 deletions
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
index 465f4657cd..2c57380122 100644
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -52,6 +52,7 @@
* [Combos](feature_combo)
* [Command](feature_command.md)
* [Dynamic Macros](feature_dynamic_macros.md)
+ * [Encoders](feature_encoders.md)
* [Grave Escape](feature_grave_esc.md)
* [Key Lock](feature_key_lock.md)
* [Layouts](feature_layouts.md)
diff --git a/docs/_summary.md b/docs/_summary.md
index 465f4657cd..2c57380122 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -52,6 +52,7 @@
* [Combos](feature_combo)
* [Command](feature_command.md)
* [Dynamic Macros](feature_dynamic_macros.md)
+ * [Encoders](feature_encoders.md)
* [Grave Escape](feature_grave_esc.md)
* [Key Lock](feature_key_lock.md)
* [Layouts](feature_layouts.md)
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md
new file mode 100644
index 0000000000..f482eefec8
--- /dev/null
+++ b/docs/feature_encoders.md
@@ -0,0 +1,41 @@
+# Encoders
+
+Basic encoders are supported by adding this to your `rules.mk`:
+
+ ENCODER_ENABLE = yes
+
+and this to your `config.h`:
+
+ #define NUMBER_OF_ENCODERS 1
+ #define ENCODERS_PAD_A { B12 }
+ #define ENCODERS_PAD_B { B13 }
+
+Each PAD_A/B variable defines an array so multiple encoders can be defined, e.g.:
+
+ #define ENCODERS_PAD_A { encoder1a, encoder2a }
+ #define ENCODERS_PAD_B { encoder1a, encoder2b }
+
+If your encoder's clockwise directions are incorrect, you can swap the A & B pad definitions.
+
+Additionally, the resolution can be specified in the same file (the default & suggested is 4):
+
+ #define ENCODER_RESOLUTION 4
+
+## Callbacks
+
+The callback functions can be inserted into your `<keyboard>.c`:
+
+ void encoder_update_kb(uint8_t index, bool clockwise) {
+ encoder_update_user(index, clockwise);
+ }
+
+or `keymap.c`:
+
+ void encoder_update_user(uint8_t index, bool clockwise) {
+
+ }
+
+
+## Hardware
+
+The A an B lines of the encoders should be wired directly to the MCU, and the C/common lines should be wired to ground.