qmk_firmware/docs/feature_encoders.md

53 lines
1.4 KiB
Markdown
Raw Normal View History

2018-10-26 20:19:23 +00:00
# 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 }
2018-12-09 22:26:09 +00:00
#define ENCODERS_PAD_B { encoder1b, encoder2b }
2018-10-26 20:19:23 +00:00
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) {
2019-01-18 15:33:43 +00:00
if (index == 0) { /* First encoder */
if (clockwise) {
tap_code(KC_PGDN);
} else {
tap_code(KC_PGUP);
2018-10-26 20:47:00 +00:00
}
} else if (index == 1) { /* Second encoder */
2019-01-18 15:33:43 +00:00
if (clockwise) {
tap_code(KC_UP);
} else {
tap_code(KC_DOWN);
}
}
2018-10-26 20:19:23 +00:00
}
## 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.