Skip to content

Commit

Permalink
fix(docs): Update docs about split encoder support
Browse files Browse the repository at this point in the history
  • Loading branch information
petejohanson committed Jun 28, 2023
1 parent 18b0db5 commit 0f9ba15
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 9 deletions.
4 changes: 0 additions & 4 deletions docs/docs/features/encoders.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ 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 `CONFIG_EC11=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
9 changes: 4 additions & 5 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ ZMK is currently missing some features found in other popular firmware. This tab
| Split Keyboard Support ||||
| [Keymaps and Layers](behaviors/layers.md) ||||
| [Hold-Tap](behaviors/hold-tap.md) (which includes [Mod-Tap](behaviors/mod-tap.md) and [Layer-Tap](behaviors/layers.md/#layer-tap)) ||||
| [Tap-Dance](behaviors/tap-dance.md) ||[^3] ||
| [Tap-Dance](behaviors/tap-dance.md) ||[^2] ||
| [Keyboard Codes](codes/index.mdx#keyboard) ||||
| [Media](codes/index.mdx#media-controls) & [Consumer](codes/index.mdx#consumer-controls) Codes ||||
| [Encoders](features/encoders.md)[^1] ||||
| [Display Support](features/displays.md)[^2] | 🚧 | 🚧 ||
| [Encoders](features/encoders.md) ||||
| [Display Support](features/displays.md)[^1] | 🚧 | 🚧 ||
| [RGB Underglow](features/underglow.md) ||||
| [Backlight](features/backlight.md) ||||
| One Shot Keys ||||
Expand All @@ -43,8 +43,7 @@ ZMK is currently missing some features found in other popular firmware. This tab
| AVR/8 Bit | | ||
| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) || | |

[^3]: Tap-Dances are limited to single and double-tap on BlueMicro
[^2]: Encoders are not currently supported on peripheral side splits.
[^2]: Tap-Dances are limited to single and double-tap on BlueMicro
[^1]: OLEDs are currently proof of concept in ZMK.

## Code Of Conduct
Expand Down

0 comments on commit 0f9ba15

Please sign in to comment.