History

Kevin Dorff 75c46f7a0e Create the sorted index of modes and palettes at startup (#1741 ) * Very incomplete work toward sorting. * Sort modes and palettes upon startup so I don't have to maintain the static index array. * Remove cpp test file I used for development * Added ModeSortUsermod, modified the other two usermods to use it. * Update platformio_override.ini.sample and readme for ModeSortUsermod * restore methods accidentally removed.		2021-02-18 00:28:01 +01:00
..
platformio_override.ini.sample	Create the sorted index of modes and palettes at startup (#1741 )	2021-02-18 00:28:01 +01:00
readme.md	Rotary Encoder, Four Line Display, and Auto Save Usermods (#1722 )	2021-02-09 17:15:43 +01:00
usermod_v2_rotary_encoder_ui.h	Create the sorted index of modes and palettes at startup (#1741 )	2021-02-18 00:28:01 +01:00

readme.md

Rotary Encoder UI Usermod

First, thanks to the authors of other Rotary Encoder usermods.

This usermod starts to provide a relatively complete on-device UI when paired with the Four Line Display usermod. I strongly encourage you to try them together.

See the pair of usermods in action

Installation

Copy and update the example platformio_override.ini.sample to the root directory of your particular build. This file should be placed in the same directory as platformio.ini.

Define Your Options

USERMOD_ROTARY_ENCODER_UI - define this to have this user mod included wled00\usermods_list.cpp
USERMOD_FOUR_LINE_DISLAY - define this to have this the Four Line Display mod included wled00\usermods_list.cpp - also tells this usermod that the display is available (see the Four Line Display usermod readme.md for more details)
ENCODER_DT_PIN - The encoders DT pin, defaults to 12
ENCODER_CLK_PIN - The encoders CLK pin, defaults to 14
ENCODER_SW_PIN - The encoders SW pin, defaults to 13

PlatformIO requirements

No special requirements.

Note: the Four Line Display usermod requires the libraries U8g2 and Wire.

Change Log

2021-02

First public release