sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix typo in encoder docs

Browse Source 
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
This commit is contained in:
Gleb Sabirzyanov 2022-06-22 10:39:30 +10:00 committed by xs5871
parent edb5bc336e
commit 17e63a435d
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/encoder.md
View File

@ -8,7 +8,7 @@ I2C encoder type has been tested with the Adafruit I2C QT Rotary Encoder with Ne
## Enabling the extension
The constructor(`EncoderHandler` class) takes a list of encoders, each one defined as either:
* a list of `pad_a` pin, `pad_b` pin, `button_pin` and optionally a flag set to `True` is you want encoder direction to be reversed;
* a list of `pad_a` pin, `pad_b` pin, `button_pin` and optionally a flag set to `True` if you want encoder direction to be reversed;
* a `busio.I2C`, address and optionally a flag set to `True` if you want it to be reversed.
The `encoder_map` is modeled after the keymap and works the same way. It should have as many layers (key pressed on "turned left", key pressed on "turned right", key pressed on "knob pressed") as your keymap, and use `KC.NO` keys for layers that you don't require any action. The encoder supports a velocity mode if you desire to make something for video or sound editing.