summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2019-01-18 16:33:43 +0100
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-01-18 16:33:43 +0100
commit52f1206712348a97b8de5700b5fc3eabe424096b (patch)
treef10e39741e4b81bd6f29ac44018b0674c8043b1f /docs
parent12406c646f917b7451ec265d767f07a34ecf906a (diff)
downloadqmk_firmware-52f1206712348a97b8de5700b5fc3eabe424096b.tar.gz
qmk_firmware-52f1206712348a97b8de5700b5fc3eabe424096b.tar.xz
Fix Encoder documentation (#4861)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_encoders.md20
-rw-r--r--docs/features.md1
2 files changed, 13 insertions, 8 deletions
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md
index 208d6db13..6eab402ef 100644
--- a/docs/feature_encoders.md
+++ b/docs/feature_encoders.md
@@ -32,15 +32,19 @@ The callback functions can be inserted into your `<keyboard>.c`:
or `keymap.c`:
void encoder_update_user(uint8_t index, bool clockwise) {
- if (index == 0) {
- if (clockwise) {
- register_code(KC_PGDN);
- unregister_code(KC_PGDN);
- } else {
- register_code(KC_PGUP);
- unregister_code(KC_PGUP);
- }
+ if (index == 0) { /* First encoder */
+ if (clockwise) {
+ tap_code(KC_PGDN);
+ } else {
+ tap_code(KC_PGUP);
}
+ } else if (index == 2) {
+ if (clockwise) {
+ tap_code(KC_UP);
+ } else {
+ tap_code(KC_DOWN);
+ }
+ }
}
## Hardware
diff --git a/docs/features.md b/docs/features.md
index 85f4cf6e0..9030500a2 100644
--- a/docs/features.md
+++ b/docs/features.md
@@ -11,6 +11,7 @@ QMK has a staggering number of features for building your keyboard. It can take
* [Combos](feature_combo.md) - Custom actions for multiple key holds.
* [Command](feature_command.md) - Runtime version of bootmagic (Formerly known as "Magic").
* [Dynamic Macros](feature_dynamic_macros.md) - Record and playback macros from the keyboard itself.
+* [Encoders](feature_encoders.md) - Rotary encoders!
* [Grave Escape](feature_grave_esc.md) - Lets you use a single key for Esc and Grave.
* [HD44780 LCD Display](feature_hd44780.md) - Support for LCD character displays using the HD44780 standard.
* [Key Lock](feature_key_lock.md) - Lock a key in the "down" state.