diff options
| author | Peter Johanson <peter@peterjohanson.com> | 2021-08-04 22:25:41 -0400 |
|---|---|---|
| committer | Peter Johanson <peter@peterjohanson.com> | 2021-08-04 22:25:41 -0400 |
| commit | 47109641d8d257ee8124fecd5977d618fa5839b4 (patch) | |
| tree | 5908d052dbead53d1837d54b10928d643fcae35f /docs | |
| parent | 08687b170920c20661be89569213e7ab32f2dc61 (diff) | |
Add warning about peripheral encoders.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/features/encoders.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/docs/features/encoders.md b/docs/docs/features/encoders.md index cf86ea9..434fee2 100644 --- a/docs/docs/features/encoders.md +++ b/docs/docs/features/encoders.md @@ -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. |