1
0
Fork 0
qmk_firmware/docs/feature_encoders.md

77 lines
1.7 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`:
```make
ENCODER_ENABLE = yes
```
2018-10-26 20:19:23 +00:00
and this to your `config.h`:
```c
#define ENCODERS_PAD_A { B12 }
#define ENCODERS_PAD_B { B13 }
```
2018-10-26 20:19:23 +00:00
Each PAD_A/B variable defines an array so multiple encoders can be defined, e.g.:
```c
#define ENCODERS_PAD_A { encoder1a, encoder2a }
#define ENCODERS_PAD_B { encoder1b, encoder2b }
```
If your encoder's clockwise directions are incorrect, you can swap the A & B pad definitions. They can also be flipped with a define:
2018-10-26 20:19:23 +00:00
```c
#define ENCODER_DIRECTION_FLIP
```
2018-10-26 20:19:23 +00:00
Additionally, the resolution can be specified in the same file (the default & suggested is 4):
```c
#define ENCODER_RESOLUTION 4
```
2018-10-26 20:19:23 +00:00
## Split Keyboards
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:
```c
#define ENCODERS_PAD_A_RIGHT { encoder1a, encoder2a }
#define ENCODERS_PAD_B_RIGHT { encoder1b, encoder2b }
```
2018-10-26 20:19:23 +00:00
## Callbacks
The callback functions can be inserted into your `<keyboard>.c`:
```c
void encoder_update_kb(uint8_t index, bool clockwise) {
encoder_update_user(index, clockwise);
}
```
2018-10-26 20:19:23 +00:00
or `keymap.c`:
```c
void encoder_update_user(uint8_t index, bool clockwise) {
if (index == 0) { /* First encoder */
2019-01-18 15:33:43 +00:00
if (clockwise) {
tap_code(KC_PGDN);
2019-01-18 15:33:43 +00:00
} 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_DOWN);
2019-01-18 15:33:43 +00:00
} else {
tap_code(KC_UP);
2019-01-18 15:33:43 +00:00
}
2018-10-26 20:19:23 +00:00
}
}
```
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.