jeans/WLED
jeans/WLED
1
0
Fork 0
mirror of https://github.com/wled/WLED.git synced 2025-07-19 16:56:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Readme for Four Line Display Usermod

Browse Source
This commit is contained in:
thatdonfc 2024-03-19 14:48:04 -07:00
parent ecee073e08
commit 92ebeddcb0
No known key found for this signature in database
GPG Key ID: 805A5EDAE682FD3A
1 changed files with 49 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
usermods/usermod_v2_four_line_display_ALT/readme.md
View File

@ -1,4 +1,4 @@
# I2C 4 Line Display Usermod ALT # I2C/SPI 4 Line Display Usermod ALT
Thank you to the authors of the original version of these usermods. It would not have been possible without them! Thank you to the authors of the original version of these usermods. It would not have been possible without them!
"usermod_v2_four_line_display" "usermod_v2_four_line_display"
@ -9,20 +9,19 @@ The display usermod UI has been completely changed.
The changes made to the RotaryEncoder usermod were made to support the new UI in the display usermod. The changes made to the RotaryEncoder usermod were made to support the new UI in the display usermod.
Without the display it, functions identical to the original. Without the display, it functions identical to the original.
The original "usermod_v2_auto_save" will not work with the display just yet. The original "usermod_v2_auto_save" will not work with the display just yet.
Press the encoder to cycle through the options: Press the encoder to cycle through the options:
*Brightness * Brightness
*Speed * Speed
*Intensity * Intensity
*Palette * Palette
*Effect * Effect
*Main Color (only if display is used) * Main Color (only if display is used)
*Saturation (only if display is used) * Saturation (only if display is used)
Press and hold the encoder to display Network Info Press and hold the encoder to display Network Info. If AP is active, it will display AP, SSID and password
if AP is active, it will display AP, SSID and password
Also shows if the timer is enabled Also shows if the timer is enabled
@ -30,11 +29,47 @@ Also shows if the timer is enabled
## Installation ## Installation
Please refer to the original `usermod_v2_rotary_encoder_ui` readme for the main instructions Please refer to the original `usermod_v2_rotary_encoder_ui` readme for the main instructions.
Then to activate this alternative usermod add `#define USE_ALT_DISPlAY` to the `usermods_list.cpp` file,
Copy the example `platformio_override.sample.ini` from the usermod_v2_rotary_encoder_ui_ALT folder to the root directory of your particular build and rename it to `platformio_override.ini`.
This file should be placed in the same directory as `platformio.ini`.
Then, to activate this alternative usermod, add `#define USE_ALT_DISPlAY` (NOTE: CASE SENSITIVE) to the `usermods_list.cpp` file,
or add `-D USE_ALT_DISPlAY` to the original `platformio_override.ini.sample` file or add `-D USE_ALT_DISPlAY` to the original `platformio_override.ini.sample` file
## Configuration
These options are configurable in Config > Usermods
### Usermod Setup
* Global I2C GPIOs (HW) - Set the SDA and SCL pins
### 4LineDisplay
* `enabled` - enable/disable usermod
* `type` - display type in numeric format
* 1 = I2C SSD1306 128x32
* 2 = I2C SH1106 128x32
* 3 = I2C SSD1306 128x64 (4 double-height lines)
* 4 = I2C SSD1305 128x32
* 5 = I2C SSD1305 128x64 (4 double-height lines)
* 6 = I2C SSD1309 128x64 (4 double-height lines)
* 7 = SPI SSD1306 128x32
* 8 = SPI SSD1306 128x64 (4 double-height lines)
* 9 = SPI SSD1309 128x64 (4 double-height lines)
* `pin` - GPIO pins used for display; SPI displays can use SCK, MOSI, CS, DC & RST
* `flip` - flip/rotate display 180°
* `contrast` - set display contrast (higher contrast may reduce display lifetime)
* `screenTimeOutSec` - screen saver time-out in seconds
* `sleepMode` - enable/disable screen saver
* `clockMode` - enable/disable clock display in screen saver mode
* `showSeconds` - Show seconds on the clock display
* `i2c-freq-kHz` - I2C clock frequency in kHz (may help reduce dropped frames, range: 400-3400)
### PlatformIO requirements ### PlatformIO requirements
Note: the Four Line Display usermod requires the libraries `U8g2` and `Wire`. Note: the Four Line Display usermod requires the libraries `U8g2` and `Wire`.