Skip to content

Commit e0c42ad

Browse files
committed
updated README
1 parent d6991a3 commit e0c42ad

File tree

3 files changed

+27
-20
lines changed

3 files changed

+27
-20
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,13 @@ It is or will be supported by:
1414
A full tutorial of its installation is available in [English](https://www.pincabpassion.net/t14796-tuto-zedmd-installation-english) and in [French](https://www.pincabpassion.net/t14798-tuto-installation-du-zedmd)
1515

1616
Meanwhile, there're different "flavours" of the ZeDMD firmware. Because it pushes the cheap ESP32 to its limits, we can't provide a unified firmware, so you have to pick the appropriate one:
17-
* ZeDMD: using two 64x32 panels driven by an ESP32 connected over USB
18-
* ZeDMD HD: using four 64x64 or two 128x64 panels driven by an ESP32 connected over USB
19-
* ZeDMD HALF: using one 128x64 panel driven by an ESP32 connected over USB
20-
* ZeDMD WiFi: using two 64x32 panels driven by an ESP32 connected over WiFi
21-
* ZeDMD HALF WiFi: using one 128x64 panel driven by an ESP32 connected over WiFi
22-
* ZeDMD S3: using two 64x32 panels driven by an ESP32 S3 N16R8 connected over USB
23-
* ZeDMD S3 HD: using four 64x64 or two 128x64 panels driven by an ESP32 S3 N16R8 connected over USB
24-
* ZeDMD S3 HALF: using one 128x64 panel driven by an ESP32 S3 N16R8 connected over USB
25-
* ZeDMD S3 WiFi: using two 64x32 panels driven by an ESP32 S3 N16R8 connected over WiFi
26-
* ZeDMD S3 HD WiFi: using four 64x64 or two 128x64 panels driven by an ESP32 S3 N16R8 connected over WiFi
27-
* ZeDMD S3 HALF WiFi: using one 128x64 panel driven by an ESP32 S3 N16R8 connected over WiFi
28-
* ZeDMD S3 AMOLED: using a small OLED driven by a LilyGo AMOLED T-Display-S3 V2 connected via USB
17+
* ZeDMD 128x32: using two 64x32 panels driven by an ESP32 connected over USB or WiFi
18+
* ZeDMD HD 256x64: using four 64x64 or two 128x64 panels driven by an ESP32 connected over USB or WiFi
19+
* ZeDMD 128x64: using one 128x64 panel driven by an ESP32 connected over USB or WiFi, showing 128x32 content with an offset, suitable for mini cabinets
20+
* ZeDMD S3 128x32: using two 64x32 panels driven by an ESP32 S3 N16R8 connected over USB CDC or WiFi
21+
* ZeDMD S3 HD 256x64: using four 64x64 or two 128x64 panels driven by an ESP32 S3 N16R8 connected over USB CDC or WiFi
22+
* ZeDMD S3 128x64: using one 128x64 panel driven by an ESP32 S3 N16R8 connected over USB CDC or WiFi, showing 128x32 content with an offset, suitable for mini cabinets
23+
* ZeDMD S3 AMOLED: using a small OLED driven by a LilyGo AMOLED T-Display-S3 V2 connected via USB CDC
2924
* ZeDMD S3 AMOLED WiFi: using a small OLED driven by a LilyGo AMOLED T-Display-S3 V2 connected via WiFi
3025

3126
Here's are short demo of ZeDMD and ZeDMD HD in parallel:
@@ -71,17 +66,15 @@ Download and install the [ZeDMD_Updater](https://github.com/zesinger/ZeDMD_Updat
7166
## First start
7267

7368
After flashing the firmware you'll see the ZeDMD logo. But due to the different panels available on the market,
74-
you need to adjust the colors. While the logo is visible you can press the RGB button to rotate the colors until
75-
`red` in the left top corner is red, `green` is green and `blue` is shown in blue.
69+
you need to adjust the colors. While the logo is visible you can press the brightness button on older ZeDMD or the forward button on newer ZeDMD to enter the settings menu.
70+
To set the correct RGB order, rotate the colors until `red` in the left top corner is red, `green` is green and `blue` is shown in blue.
7671

7772
Using the brightness butten you can adjust the brightness.
7873

7974
## ZeDMD-WiFi
8075

81-
After flashing the ZeDMD-WiFi firmware, connect your mobile device or laptop to the "ZeDMD-WiFi" network using the password zedmd1234.
82-
83-
After connecting to the ZeDMD-WiFI network, open your web browser and navigate to http://ZeDMD-WiFi.local (IP: 192.168.4.1) to access the configuration settings.
84-
76+
After activating the WiFi mode in the settings menu, connect your mobile device or laptop to the `ZeDMD-WiFi` network using the password `zedmd1234`.
77+
Then open your web browser and navigate to http://ZeDMD-WiFi.local (IP: 192.168.4.1) to access the configuration settings.
8578

8679
## IMPORTANT LEGAL NOTICES:
8780

@@ -139,3 +132,16 @@ If you find out what config adjustment gets a specific panel to work, you should
139132
### "I'm running a shop, can I assemble and sell ZeDMDs?"
140133

141134
Yes, you can, as long as you respect the legal notices above. You could also do your own hardware design. But it would be nice if you sent us a ready to-use device for testing because people might ask here or on discord about problems with a specific variation of ZeDMD.
135+
136+
### ZeDMD S3 crashes when connected via USB to a Windows machine
137+
138+
This is a known issue. ZeDMD S3 works perfectly well with Linux and macOS. But if you're using Windows you should use the WiFi mode.
139+
140+
### ZeDMD S3 crashed, how can I help fixing the issue
141+
142+
If you discover a crash, there's a good chance that a coredump has been written to flash. If you flashed the device using `pio`, you can extract and interpret the coredump:
143+
```shell
144+
python ~/esp/v5.3.2/esp-idf/components/espcoredump/espcoredump.py info_corefile .pio/build/S3-N16R8_128x32/firmware.elf
145+
```
146+
147+

src/displayConfig.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
int8_t rgbMode = 0;
44
uint8_t rgbModeLoaded = 0;
5-
uint8_t yOffset = 0;
5+
int8_t yOffset = 0;
66

77
// I needed to change these from RGB to RC (Red Color), BC, GC to prevent
88
// conflicting with the TFT_SPI Library.

src/main.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1314,7 +1314,8 @@ void setup() {
13141314
}
13151315
#ifdef ZEDMD_HD_HALF
13161316
case 6: { // Y Offset
1317-
if (++yOffset > 32) yOffset = 0;
1317+
if (up && ++yOffset > 32) yOffset = 0;
1318+
else if (down && --yOffset < 0) yOffset = 32;
13181319
display->ClearScreen();
13191320
RefreshSetupScreen();
13201321
display->DisplayText("Y Offset",

0 commit comments

Comments
 (0)