Skip to content

Commit

Permalink
Add warning about peripheral encoders.
Browse files Browse the repository at this point in the history
  • Loading branch information
petejohanson committed Aug 5, 2021
1 parent 08687b1 commit 4710964
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/docs/features/encoders.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ sidebar_label: Encoders

Existing support for encoders in ZMK is focused around the five pin EC11 rotary encoder with push button design used in the majority of current keyboard and macropad designs.


:::note
Encoders are currently only support on the left/central sides of splits. For progress on this, see [#728](https://github.com/zmkfirmware/zmk/pull/728).
:::

## Enabling EC11 Encoders

To enable encoders for boards that have existing encoder support, uncomment the `EC11_CONFIG=y` and `CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y` lines in your board's .conf file in your `zmk-config/config` folder. Save and push your changes, then download and flash the new firmware.
Expand Down

0 comments on commit 4710964

Please sign in to comment.