Skip to content

Commit 35aa97e

Browse files
authored
Update README.md
1 parent 97345fb commit 35aa97e

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# ESPNexUpload
22
ESP8266 & ESP32 library for uploading .tft files to the Nextion display over serial. The ESP32 uses HardwareSerial and the ESP8266 uses SoftwareSerial. Pins are defined in the ESPNexUpload.cpp file.
33

4+
## IMPORTANT NOTES
5+
6+
### Arduino core version
7+
ESP8266: Due to bugs in older arduino cores we recommend using version 2.5.1 or higher.
8+
ESP32: Latest arduino core should work fine
9+
10+
### Hardresets
11+
If the nextion displays an error: Failed to update, Connection lost, Incompatible upload etc.
12+
You will need to hardreset(power cycle) the display before trying the next update. This might be an issue if you are updating from a remote location. You should therefore consider adding a transistor or relay to your nextion power lines.
13+
414
## Usage
515
This library expects a byte (buffer of Stream), filesize and serial baudrate as parameters. The examples provided demonstrate how to use these with Wifi, SPIFFS, SD cards and a local webserver.
616

7-
## IMPORTANT
8-
Due to bugs in older ESP8266 arduino core we recommend using version 2.5.1 or higher.
9-
1017
#### Begin
1118
```C++
1219
// initialize ESPNexUpload
@@ -45,15 +52,6 @@ The library examples "[WifiClient](examples/WifiClient/WifiClient.ino#L128), [Ht
4552
```
4653
</br>
4754

48-
49-
## Hardresets
50-
If the nextion displays an error: Failed to update, Connection lost, Incompatible upload etc.
51-
You will need to hardreset(power cycle) the display before trying the next update. This might be an issue if you are updating from a remote location. You should therefore consider adding a transistor or relay to your nextion power lines.
52-
53-
## Note on baudrates
54-
- In previous versions the Nextion <-> ESP communication was quite fault prone.
55-
- This seems to no longer be the case. 115200 seems to work fine.
56-
5755
## Releases
5856
- v0.4.0 - Fixed combatibility issues with some displays
5957
- v0.3.1 - Fixed typo in UploadServer example

0 commit comments

Comments
 (0)