8e71c3ae17
* Ability to lookup Usermod by id so Usermods can use other Usermods. * Rotary Encoder UI using two Usermods * Updates. More to come, probably. * Updated rotary usermod to honor USE_FOUR_LINE_DISPLAY if you want to use four line display. It should be truly optional, now. * minor logic improvement to showing the current time in clock mode. * improved 24 hour display foratting and ability to use the FourLineDisplayUsermod without the RotaryEncoderUIUsermod (option disable sleep and clock modes). * Improved ordering of defines in the FourLineDisplayUsermod to put options people might need to change together toward the top. * relocate plugins. add mention of the Wire requirement. * usermod filenames changed, updating comment in const.h * fix usermod locations. * fix usermods_list to include changed folder. * Improved for both usermods: install, config, and docs. Included sample platform_override.ini. * Updated name of SDA and SCL defines for config of display * update docs. * Wrong year. Fixed. * Fix youtube link, improve config of sleep/clock when the rotary usermod isn't installed. * Minor fixes to four line display. Addition of Auto Save v2 usermod. * Allow config for auto-save to set the preset number to use. Load preset at startup (so brightness is set correctly). * Updated docs for Auto Save. * Updated docs for Auto Save. Co-authored-by: Kevin Dorff <kevin@macbookpro-kevin-wifi.local>
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# 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](https://www.youtube.com/watch?v=tITQY80rIOA)
|
|
|
|
## 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
|