docs/feature_encoders.md

   1 # Encoders
   2
   3 Basic encoders are supported by adding this to your `rules.mk`:
   4
   5     ENCODER_ENABLE = yes
   6
   7 and this to your `config.h`:
   8
   9     #define ENCODERS_PAD_A { B12 }
  10     #define ENCODERS_PAD_B { B13 }
  11
  12 Each PAD_A/B variable defines an array so multiple encoders can be defined, e.g.:
  13
  14     #define ENCODERS_PAD_A { encoder1a, encoder2a }
  15     #define ENCODERS_PAD_B { encoder1b, encoder2b }
  16
  17 If your encoder's clockwise directions are incorrect, you can swap the A & B pad definitions.
  18
  19 Additionally, the resolution can be specified in the same file (the default & suggested is 4):
  20
  21     #define ENCODER_RESOLUTION 4
  22
  23 ## Split Keyboards
  24
  25 If you are using different pinouts for the encoders on each half of a split keyboard, you can define the pinout for the right half like this:
  26
  27 ```c
  28 #define ENCODERS_PAD_A_RIGHT { encoder1a, encoder2a }
  29 #define ENCODERS_PAD_B_RIGHT { encoder1b, encoder2b }
  30 ```
  31
  32 ## Callbacks
  33
  34 The callback functions can be inserted into your `<keyboard>.c`:
  35
  36     void encoder_update_kb(uint8_t index, bool clockwise) {
  37         encoder_update_user(index, clockwise);
  38     }
  39
  40 or `keymap.c`:
  41
  42     void encoder_update_user(uint8_t index, bool clockwise) {
  43       if (index == 0) { /* First encoder */
  44         if (clockwise) {
  45           tap_code(KC_PGDN);
  46         } else {
  47           tap_code(KC_PGUP);
  48         }
  49       } else if (index == 1) { /* Second encoder */
  50         if (clockwise) {
  51           tap_code(KC_UP);
  52         } else {
  53           tap_code(KC_DOWN);
  54         }
  55       }
  56     }
  57
  58 ## Hardware
  59
  60 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.