Skip to content

Commit dcfdca6

Browse files
committed
cleaned up old references to USE_ALT_DISPlAY that aren't used anymore in the code/source files; fixed readme.md documents and updated instructions; removed referencies to old usermods; fixed invalid filenames; removed referencies to old usermods; checked cycle options; splitted and fixed platformio_override.sample.ini;
1 parent 832599b commit dcfdca6

5 files changed

Lines changed: 32 additions & 47 deletions

File tree

platformio_override.sample.ini

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,6 @@ build_flags = ${common.build_flags} ${esp8266.build_flags}
111111
;
112112
; Use 4 Line Display usermod with SPI display
113113
; -D USERMOD_FOUR_LINE_DISPLAY
114-
; -D USE_ALT_DISPlAY # mandatory
115114
; -DFLD_SPI_DEFAULT
116115
; -D FLD_TYPE=SSD1306_SPI64
117116
; -D FLD_PIN_CLOCKSPI=14
@@ -377,7 +376,6 @@ build_flags = ${common.build_flags} ${esp32.build_flags}
377376
-D USERMOD_DALLASTEMPERATURE
378377
-D USERMOD_FOUR_LINE_DISPLAY
379378
-D TEMPERATURE_PIN=23
380-
-D USE_ALT_DISPlAY ; new versions of USERMOD_FOUR_LINE_DISPLAY and USERMOD_ROTARY_ENCODER_UI
381379
-D USERMOD_AUDIOREACTIVE
382380
lib_deps = ${esp32.lib_deps}
383381
OneWire@~2.3.5

usermods/usermod_v2_rotary_encoder_ui_ALT/platformio–override.sample.ini renamed to usermods/usermod_v2_four_line_display_ALT/platformio_override.sample.ini

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ platform = ${esp32.platform}
77
build_unflags = ${common.build_unflags}
88
build_flags =
99
${common.build_flags_esp32}
10-
-D USERMOD_FOUR_LINE_DISPLAY -D USE_ALT_DISPlAY
11-
-D USERMOD_ROTARY_ENCODER_UI -D ENCODER_DT_PIN=18 -D ENCODER_CLK_PIN=5 -D ENCODER_SW_PIN=19
12-
upload_speed = 460800
10+
-D USERMOD_FOUR_LINE_DISPLAY
11+
-D FLD_TYPE=SH1106
12+
-D I2CSCLPIN=27
13+
-D I2CSDAPIN=26
14+
1315
lib_deps =
1416
${esp32.lib_deps}
15-
U8g2@~2.34.4
17+
U8g2
1618
Wire
17-

usermods/usermod_v2_four_line_display_ALT/readme.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,27 @@
11
# I2C/SPI 4 Line Display Usermod ALT
22

3-
Thank you to the authors of the original version of these usermods. It would not have been possible without them!
4-
"usermod_v2_four_line_display"
5-
"usermod_v2_rotary_encoder_ui"
3+
This usermod could be used in compination with `usermod_v2_rotary_encoder_ui_ALT`.
64

7-
The core of these usermods are a copy of the originals. The main changes are to the FourLineDisplay usermod.
8-
The display usermod UI has been completely changed.
9-
10-
11-
The changes made to the RotaryEncoder usermod were made to support the new UI in the display usermod.
12-
Without the display, it functions identical to the original.
13-
The original "usermod_v2_auto_save" will not work with the display just yet.
5+
## Functionalities
146

157
Press the encoder to cycle through the options:
168
* Brightness
179
* Speed
1810
* Intensity
1911
* Palette
2012
* Effect
21-
* Main Color (only if display is used)
22-
* Saturation (only if display is used)
13+
* Main Color
14+
* Saturation
2315

24-
Press and hold the encoder to display Network Info. If AP is active, it will display AP, SSID and password
16+
Press and hold the encoder to display Network Info. If AP is active, it will display the AP, SSID and Password
2517

26-
Also shows if the timer is enabled
18+
Also shows if the timer is enabled.
2719

2820
[See the pair of usermods in action](https://www.youtube.com/watch?v=ulZnBt9z3TI)
2921

3022
## Installation
3123

32-
Please refer to the original `usermod_v2_rotary_encoder_ui` readme for the main instructions.
33-
34-
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`.
35-
36-
This file should be placed in the same directory as `platformio.ini`.
37-
38-
Then, to activate this alternative usermod, add `#define USE_ALT_DISPlAY` (NOTE: CASE SENSITIVE) to the `usermods_list.cpp` file,
39-
or add `-D USE_ALT_DISPlAY` to the original `platformio_override.ini.sample` file
40-
24+
Copy the example `platformio_override.sample.ini` to the root directory of your particular build.
4125

4226
## Configuration
4327

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[platformio]
2+
default_envs = esp32dev
3+
4+
[env:esp32dev]
5+
board = esp32dev
6+
platform = ${esp32.platform}
7+
build_unflags = ${common.build_unflags}
8+
build_flags =
9+
${common.build_flags_esp32}
10+
-D USERMOD_ROTARY_ENCODER_UI
11+
-D USERMOD_ROTARY_ENCODER_GPIO=INPUT
12+
-D ENCODER_DT_PIN=21
13+
-D ENCODER_CLK_PIN=23
14+
-D ENCODER_SW_PIN=0

usermods/usermod_v2_rotary_encoder_ui_ALT/readme.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
# Rotary Encoder UI Usermod ALT
22

3-
Thank you to the authors of the original version of these usermods. It would not have been possible without them!
4-
"usermod_v2_four_line_display"
5-
"usermod_v2_rotary_encoder_ui"
3+
This usermod supports the UI of the `usermod_v2_rotary_encoder_ui_ALT`.
64

7-
The core of these usermods are a copy of the originals. The main changes are to the FourLineDisplay usermod.
8-
The display usermod UI has been completely changed.
9-
10-
11-
The changes made to the RotaryEncoder usermod were made to support the new UI in the display usermod.
12-
Without the display, it functions identical to the original.
13-
The original "usermod_v2_auto_save" will not work with the display just yet.
5+
## Functionalities
146

157
Press the encoder to cycle through the options:
168
* Brightness
@@ -21,26 +13,22 @@ Press the encoder to cycle through the options:
2113
* Main Color (only if display is used)
2214
* Saturation (only if display is used)
2315

24-
Press and hold the encoder to display Network Info
25-
if AP is active, it will display the AP, SSID and Password
16+
Press and hold the encoder to display Network Info. If AP is active, it will display the AP, SSID and Password
2617

2718
Also shows if the timer is enabled.
2819

2920
[See the pair of usermods in action](https://www.youtube.com/watch?v=ulZnBt9z3TI)
3021

3122
## Installation
3223

33-
Copy the example `platformio_override.sample.ini` to the root directory of your particular build and rename it to `platformio_override.ini`.
34-
35-
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 your `platformio_override.ini` file
24+
Copy the example `platformio_override.sample.ini` to the root directory of your particular build.
3625

3726
### Define Your Options
3827

3928
* `USERMOD_ROTARY_ENCODER_UI` - define this to have this user mod included wled00\usermods_list.cpp
4029
* `USERMOD_FOUR_LINE_DISPLAY` - define this to have this the Four Line Display mod included wled00\usermods_list.cpp
4130
also tells this usermod that the display is available
4231
(see the Four Line Display usermod `readme.md` for more details)
43-
* `USE_ALT_DISPlAY` - Mandatory to use Four Line Display
4432
* `ENCODER_DT_PIN` - defaults to 18
4533
* `ENCODER_CLK_PIN` - defaults to 5
4634
* `ENCODER_SW_PIN` - defaults to 19
@@ -50,7 +38,7 @@ To activate this alternative usermod, add `#define USE_ALT_DISPlAY` (NOTE: CASE
5038

5139
### PlatformIO requirements
5240

53-
Note: the Four Line Display usermod requires the libraries `U8g2` and `Wire`.
41+
No special requirements.
5442

5543
## Change Log
5644

0 commit comments

Comments
 (0)