varl/qmk_firmware
1
0
Fork 0
forked from forks/qmk_firmware
Code Pull requests Activity

Volume as default encoder documentation example (#15678)

Browse source 
Co-authored-by: filterpaper <filterpaper@localhost>
This commit is contained in:
Albert Y 2022-01-02 16:07:22 +08:00 committed by GitHub
parent f3c080b4b4
commit 6f043c5497
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/feature_encoders.md
View file

@ -70,15 +70,15 @@ or `keymap.c`:
bool encoder_update_user(uint8_t index, bool clockwise) {
if (index == 0) { /* First encoder */
if (clockwise) {
tap_code(KC_PGDN);
tap_code_delay(KC_VOLU, 10);
} else {
tap_code(KC_PGUP);
tap_code_delay(KC_VOLD, 10);
}
} else if (index == 1) { /* Second encoder */
if (clockwise) {
tap_code(KC_DOWN);
rgb_matrix_increase_hue();
} else {
tap_code(KC_UP);
rgb_matrix_decrease_hue();
}
}
return false;
@ -100,9 +100,9 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
}
} else if (index == 1) {
if (clockwise) {
tap_code(KC_VOLU);
tap_code_delay(KC_VOLU, 10);
} else {
tap_code(KC_VOLD);
tap_code_delay(KC_VOLD, 10);
}
}
} else { /* Layer 0 */
@ -114,9 +114,9 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
}
} else if (index == 1) {
if (clockwise) {
tap_code(KC_DOWN);
rgb_matrix_increase_speed();
} else {
tap_code(KC_UP);
rgb_matrix_decrease_speed();
}
}
}
@ -124,6 +124,8 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
}
```
?> Media and mouse countrol keycodes such as `KC_VOLU` and `KC_WH_D` requires `EXTRAKEY_ENABLE = yes` and `MOUSEKEY_ENABLE = yes` respectively in user's `rules.mk` if they are not enabled as default on keyboard level configuration.
## 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.