Where possible we are going right to the answer and provide it within one or two paragraphs. If it takes more than that, you will see a link :arrow_right: to more details.
Please feel free to contribute if you believe that some frequent issues are not covered below.
I am getting “espcomm_sync failed” error when trying to upload my ESP. How to resolve this issue?¶
This message indicates issue with uploading ESP module over a serial connection. There are couple of possible causes, that depend on the type of your module, if you use separate USB to serial converter.
My ESP crashes running some code. How to troubleshoot it?¶
The code may crash because of s/w bug or issue with your h/w. Before entering an issue report, please perform initial troubleshooting.
This Arduino library doesn’t work on ESP. How do I make it working?¶
You would like to use this Arduino library with ESP8266 and it does not perform. It is not listed among libraries verified to work with ESP8266.
In the IDE, for ESP-12E that has 4M flash, I can choose 4M (1M SPIFFS) or 4M (3M SPIFFS). No matter what I select, the IDE tells me the maximum code space is about 1M. Where does my flash go?¶
The reason we cannot have more than 1MB of code in flash has to do with a hardware limitation. Flash cache hardware on the ESP8266 only allows mapping 1MB of code into the CPU address space at any given time. You can switch mapping offset, so technically you can have more than 1MB total, but switching such “banks” on the fly is not easy and efficient, so we don’t bother doing that. Besides, no one has so far complained about 1MB of code space being insufficient for practical purposes.
The option to choose 4M or 1M SPIFFS is to optimize the upload time.
Uploading 3MB takes a long time so sometimes you can just use 1MB. Other
2MB of flash can still be used with
ESP.flashWrite APIs if necessary.
I have observed a case when ESP.restart() doesn’t work. What is the reason for that?¶
You will see this issue only if serial upload was not followed by a
physical reset (e.g. power-on reset). For a device being in that state
ESP.restart will not work. Apparently the issue is caused by one of
internal registers not being properly updated until physical
This issue concerns only serial uploads. OTA uploads are not affected.
If you are using
ESP.restart, the work around is to reset ESP once
after each serial upload.