From 47109641d8d257ee8124fecd5977d618fa5839b4 Mon Sep 17 00:00:00 2001 From: Peter Johanson Date: Wed, 4 Aug 2021 22:25:41 -0400 Subject: [PATCH] Add warning about peripheral encoders. --- docs/docs/features/encoders.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docs/features/encoders.md b/docs/docs/features/encoders.md index cf86ea95..434fee23 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.