diff options
author | Drashna Jaelre <drashna@live.com> | 2019-04-09 09:26:11 -0700 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2019-04-09 09:26:11 -0700 |
commit | 51a7fb1f1ea74648dc926354c887a04929297aba (patch) | |
tree | 653632f08da46b9dc8dc8ab65055927635087f85 /docs/feature_encoders.md | |
parent | 7c9d1d58ee9da18fa64cacd564fdf512ec4cb74e (diff) |
Remove documentation folder
Diffstat (limited to 'docs/feature_encoders.md')
-rw-r--r-- | docs/feature_encoders.md | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md deleted file mode 100644 index dd12c91ce3..0000000000 --- a/docs/feature_encoders.md +++ /dev/null @@ -1,52 +0,0 @@ -# Encoders - -Basic encoders are supported by adding this to your `rules.mk`: - - ENCODER_ENABLE = yes - -and this to your `config.h`: - - #define NUMBER_OF_ENCODERS 1 - #define ENCODERS_PAD_A { B12 } - #define ENCODERS_PAD_B { B13 } - -Each PAD_A/B variable defines an array so multiple encoders can be defined, e.g.: - - #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. - -Additionally, the resolution can be specified in the same file (the default & suggested is 4): - - #define ENCODER_RESOLUTION 4 - -## Callbacks - -The callback functions can be inserted into your `<keyboard>.c`: - - void encoder_update_kb(uint8_t index, bool clockwise) { - encoder_update_user(index, clockwise); - } - -or `keymap.c`: - - void encoder_update_user(uint8_t index, bool clockwise) { - if (index == 0) { /* First encoder */ - if (clockwise) { - tap_code(KC_PGDN); - } else { - tap_code(KC_PGUP); - } - } else if (index == 1) { /* Second encoder - if (clockwise) { - tap_code(KC_UP); - } else { - tap_code(KC_DOWN); - } - } - } - -## 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. |