diff options
| author | Drashna Jaelre <drashna@live.com> | 2019-01-18 07:33:43 -0800 |
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-01-18 07:33:43 -0800 |
| commit | 52f1206712348a97b8de5700b5fc3eabe424096b (patch) | |
| tree | f10e39741e4b81bd6f29ac44018b0674c8043b1f | |
| parent | 12406c646f917b7451ec265d767f07a34ecf906a (diff) | |
| download | qmk_firmware-52f1206712348a97b8de5700b5fc3eabe424096b.tar.gz qmk_firmware-52f1206712348a97b8de5700b5fc3eabe424096b.zip | |
Fix Encoder documentation (#4861)
| -rw-r--r-- | docs/feature_encoders.md | 20 | ||||
| -rw-r--r-- | docs/features.md | 1 |
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`: | |||
| 32 | or `keymap.c`: | 32 | or `keymap.c`: |
| 33 | 33 | ||
| 34 | void encoder_update_user(uint8_t index, bool clockwise) { | 34 | void encoder_update_user(uint8_t index, bool clockwise) { |
| 35 | if (index == 0) { | 35 | if (index == 0) { /* First encoder */ |
| 36 | if (clockwise) { | 36 | if (clockwise) { |
| 37 | register_code(KC_PGDN); | 37 | tap_code(KC_PGDN); |
| 38 | unregister_code(KC_PGDN); | 38 | } else { |
| 39 | } else { | 39 | tap_code(KC_PGUP); |
| 40 | register_code(KC_PGUP); | ||
| 41 | unregister_code(KC_PGUP); | ||
| 42 | } | ||
| 43 | } | 40 | } |
| 41 | } else if (index == 2) { | ||
| 42 | if (clockwise) { | ||
| 43 | tap_code(KC_UP); | ||
| 44 | } else { | ||
| 45 | tap_code(KC_DOWN); | ||
| 46 | } | ||
| 47 | } | ||
| 44 | } | 48 | } |
| 45 | 49 | ||
| 46 | ## Hardware | 50 | ## 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 | |||
| 11 | * [Combos](feature_combo.md) - Custom actions for multiple key holds. | 11 | * [Combos](feature_combo.md) - Custom actions for multiple key holds. |
| 12 | * [Command](feature_command.md) - Runtime version of bootmagic (Formerly known as "Magic"). | 12 | * [Command](feature_command.md) - Runtime version of bootmagic (Formerly known as "Magic"). |
| 13 | * [Dynamic Macros](feature_dynamic_macros.md) - Record and playback macros from the keyboard itself. | 13 | * [Dynamic Macros](feature_dynamic_macros.md) - Record and playback macros from the keyboard itself. |
| 14 | * [Encoders](feature_encoders.md) - Rotary encoders! | ||
| 14 | * [Grave Escape](feature_grave_esc.md) - Lets you use a single key for Esc and Grave. | 15 | * [Grave Escape](feature_grave_esc.md) - Lets you use a single key for Esc and Grave. |
| 15 | * [HD44780 LCD Display](feature_hd44780.md) - Support for LCD character displays using the HD44780 standard. | 16 | * [HD44780 LCD Display](feature_hd44780.md) - Support for LCD character displays using the HD44780 standard. |
| 16 | * [Key Lock](feature_key_lock.md) - Lock a key in the "down" state. | 17 | * [Key Lock](feature_key_lock.md) - Lock a key in the "down" state. |
