Add user-overridable callback for cancelling UCIS input (#5564)

[qmk_firmware.git] / docs / feature_encoders.md

diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md
index 036c6a1d8961485d59de2917b9a224e1a6b10672..9ac97a9a160bfc170ea0819e8c600bd29a2d651a 100644 (file)
--- a/docs/feature_encoders.md
+++ b/docs/feature_encoders.md
@@ -13,7 +13,7 @@ and this to your `config.h`:
 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 }
+    #define ENCODERS_PAD_B { encoder1b, encoder2b }
 
 If your encoder's clockwise directions are incorrect, you can swap the A & B pad definitions.
 
@@ -32,15 +32,19 @@ The callback functions can be inserted into your `<keyboard>.c`:
 or `keymap.c`:
 
     void encoder_update_user(uint8_t index, bool clockwise) {
-        if (index == 0) {
-            if (clockwise) {
-                register_code(KC_PGDN);
-                unregister_code(KC_PGDN);
-            } else {
-                register_code(KC_PGUP);
-                unregister_code(KC_PGUP);
-            }
+      if (index == 0) { /* First encoder */
+        if (clockwise) {
+          tap_code(KC_PGDN);
+        } else {
+          tap_code(KC_PGUP);
         }
+      } else if (index == 1) { /* Second encoder */  
+        if (clockwise) {
+          tap_code(KC_UP);
+        } else {
+          tap_code(KC_DOWN);
+        }
+      }
     }
 
 ## Hardware