qmk

Unnamed repository; edit this file 'description' to name the repository.
git clone git://git.z3bra.org/qmk.git
Log | Files | Refs | Submodules | LICENSE

commit 52f1206712348a97b8de5700b5fc3eabe424096b
parent 12406c646f917b7451ec265d767f07a34ecf906a
Author: Drashna Jaelre <drashna@live.com>
Date:   Fri, 18 Jan 2019 07:33:43 -0800

Fix Encoder documentation (#4861)


Diffstat:
docs/feature_encoders.md | 20++++++++++++--------
docs/features.md | 1+
2 files changed, 13 insertions(+), 8 deletions(-)

diff --git 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 @@ -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.