You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

51 lines
1.3 KiB

  1. # Encoders
  2. Basic encoders are supported by adding this to your `rules.mk`:
  3. ENCODER_ENABLE = yes
  4. and this to your `config.h`:
  5. #define ENCODERS_PAD_A { B12 }
  6. #define ENCODERS_PAD_B { B13 }
  7. Each PAD_A/B variable defines an array so multiple encoders can be defined, e.g.:
  8. #define ENCODERS_PAD_A { encoder1a, encoder2a }
  9. #define ENCODERS_PAD_B { encoder1b, encoder2b }
  10. If your encoder's clockwise directions are incorrect, you can swap the A & B pad definitions.
  11. Additionally, the resolution can be specified in the same file (the default & suggested is 4):
  12. #define ENCODER_RESOLUTION 4
  13. ## Callbacks
  14. The callback functions can be inserted into your `<keyboard>.c`:
  15. void encoder_update_kb(uint8_t index, bool clockwise) {
  16. encoder_update_user(index, clockwise);
  17. }
  18. or `keymap.c`:
  19. void encoder_update_user(uint8_t index, bool clockwise) {
  20. if (index == 0) { /* First encoder */
  21. if (clockwise) {
  22. tap_code(KC_PGDN);
  23. } else {
  24. tap_code(KC_PGUP);
  25. }
  26. } else if (index == 1) { /* Second encoder */
  27. if (clockwise) {
  28. tap_code(KC_UP);
  29. } else {
  30. tap_code(KC_DOWN);
  31. }
  32. }
  33. }
  34. ## Hardware
  35. The A and B lines of the encoders should be wired directly to the MCU, and the C/common lines should be wired to ground.