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 ## Callbacks
  24
  25 The callback functions can be inserted into your `<keyboard>.c`:
  26
  27     void encoder_update_kb(uint8_t index, bool clockwise) {
  28         encoder_update_user(index, clockwise);
  29     }
  30
  31 or `keymap.c`:
  32
  33     void encoder_update_user(uint8_t index, bool clockwise) {
  34       if (index == 0) { /* First encoder */
  35         if (clockwise) {
  36           tap_code(KC_PGDN);
  37         } else {
  38           tap_code(KC_PGUP);
  39         }
  40       } else if (index == 1) { /* Second encoder */
  41         if (clockwise) {
  42           tap_code(KC_UP);
  43         } else {
  44           tap_code(KC_DOWN);
  45         }
  46       }
  47     }
  48
  49 ## Hardware
  50
  51 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.