Installing ESP32/Arduino libraries - Revision history

Heerko at 08:34, 2 December 2022

2022-12-02T08:34:37Z

← Older revision		Revision as of 10:34, 2 December 2022
Line 59:		Line 59:
	'''<big>If everything went well, you are now ready to upload your own code to the board!</big>'''		'''<big>If everything went well, you are now ready to upload your own code to the board!</big>'''

			=== Next steps: ===
	You probably want to continue to [[Uploading a website to the ESP32 module\|Uploading a website to the ESP32 module.]]		You probably want to continue to [[Uploading a website to the ESP32 module\|Uploading a website to the ESP32 module.]]

Heerko at 08:34, 2 December 2022

2022-12-02T08:34:13Z

← Older revision		Revision as of 10:34, 2 December 2022
Line 2:		Line 2:
	==Install libraries==		==Install libraries==
	Depending on the situation you may have to install additional libraries. In this specific example we are installing the ESPAsyncWebserver and AsyncTCP libraries that are used in the [https://github.com/hackersanddesigners/WifiZineThrowie_ScavengerHunt WifiZine Scavengerhunt]workshop. The process is the same for other libraries.		Depending on the situation you may have to install additional libraries. In this specific example we are installing the ESPAsyncWebserver and AsyncTCP libraries that are used in the [https://github.com/hackersanddesigners/WifiZineThrowie_ScavengerHunt WifiZine Scavengerhunt]workshop. The process is the same for other libraries.

			We assume you have already [[ESP32 Arduino Setup\|downloaded and setup the Arduino IDE for use with the ESP32 modules]].

	Both these libraries are not available to install through the Arduino IDE's manage libraries interface, so we have to install them manually:		Both these libraries are not available to install through the Arduino IDE's manage libraries interface, so we have to install them manually:
Line 56:		Line 58:

	'''<big>If everything went well, you are now ready to upload your own code to the board!</big>'''		'''<big>If everything went well, you are now ready to upload your own code to the board!</big>'''

			You probably want to continue to [[Uploading a website to the ESP32 module\|Uploading a website to the ESP32 module.]]

Heerko at 08:31, 2 December 2022

2022-12-02T08:31:38Z

← Older revision		Revision as of 10:31, 2 December 2022
Line 1:		Line 1:

	==Install libraries==		==Install libraries==
	~~These~~ are ~~all optional depending on~~ the workshop ~~your following~~.		Depending on the situation you may have to install additional libraries. In this specific example we are installing the ESPAsyncWebserver and AsyncTCP libraries that are used in the [https://github.com/hackersanddesigners/WifiZineThrowie_ScavengerHunt WifiZine Scavengerhunt]workshop. The process is the same for other libraries.

			Both these libraries are not available to install through the Arduino IDE's manage libraries interface, so we have to install them manually:
	===ESPAsyncWebServer===		===ESPAsyncWebServer===
	#[https://github.com/me-no-dev/ESPAsyncWebServer/archive/refs/heads/master.zip Download the code]		#[https://github.com/me-no-dev/ESPAsyncWebServer/archive/refs/heads/master.zip Download the code]

Heerko: Created page with " ==Install libraries== These are all optional depending on the workshop your following. ===ESPAsyncWebServer=== #[https://github.com/me-no-dev/ESPAsyncWebServer/archive/refs/heads/master.zip Download the code] #Unzip the downloaded file. #Remove the "-master" part from the unzipped directory name, so `ESPAsyncWebServer-master` should now be called `ESPAsyncWebServer` #Move the renamed directory to your library directory: *On Windows: `My Docume..."`


2022-12-02T08:23:08Z
Created page with " ==Install libraries== These are all optional depending on the workshop your following. ===ESPAsyncWebServer=== #[https://github.com/me-no-dev/ESPAsyncWebServer/archive/refs/heads/master.zip Download the code] #Unzip the downloaded file. #Remove the "-master" part from the unzipped directory name, so <code>ESPAsyncWebServer-master</code> should now be called <code>ESPAsyncWebServer</code> #Move the renamed directory to your library directory: *On Windows: <code>My Docume..."
New page


==Install libraries==

These are all optional depending on the workshop your following.

===ESPAsyncWebServer===

#[https://github.com/me-no-dev/ESPAsyncWebServer/archive/refs/heads/master.zip Download the code]

#Unzip the downloaded file.

#Remove the "-master" part from the unzipped directory name, so <code>ESPAsyncWebServer-master</code> should now be called <code>ESPAsyncWebServer</code>

#Move the renamed directory to your library directory:

*On Windows: <code>My Documents\Arduino\libraries</code>

*On Linux: <code>{sketchbook folder}/libraries</code>. The sketchbook folder location can be found (or changed) at File > Preferences > Sketchbook location:. This is the location of libraries installed via Library Manager (Sketch > Include Library > Manage Libraries…) or Sketch > Include Library > Add .ZIP Library. You should also manually install libraries to that location.

*On MacOS: <code>~/Documents/Arduino/libraries</code>

===AsyncTCP===

Much the same as above:

#[https://github.com/me-no-dev/AsyncTCP/archive/refs/heads/master.zip Download the code]

#Unzip the downloaded file.

#Remove the "-master" part from the unzipped directory name, so <code>AsyncTCP-master</code> should now be called <code>AsyncTCP</code>

#Move the renamed directory to your library directory (See above).

''Restart the IDE after installation.''

==Confirming code compilation==

*Restart the Arduino IDE (the Arduino software)

*Create a new sketch.

*Copy/paste the following code. This code does nothing, but if it compiles and upload without errors we know that everything is installed correctly.

<syntaxhighlight lang="c">

#include <WiFi.h>

#include <AsyncTCP.h>

#include <ESPAsyncWebServer.h>



void setup() {

}



void loop() {

}

</syntaxhighlight>

*Select the ESP32 Dev Module board

[[File:Arduino-wifizine-select-board.png|500px|frame|none|alt=Screenshot of Arduino menu open at > Tools > Board > ESP32 Dev Module|Screenshot of Arduino menu open at > Tools > Board > ESP32 Dev Module]]

===Compile===

Click on the compile button in the top left of the editor (see red arrow in pic beneath)[[File:Arduino-wifizine-popup.png|500px|frame|none|alt=arduino window with red arrow pointing to the compile button on the top left|Arduino window with red arrow pointing to the compile button on the top left]]

*'''If the compilation process is successful, it will say “DONE COMPILING” at the bottom'''

*This means Arduino confirms it can find everything it needs to upload working code

*Don’t upload the code to the board yet, first we need some more stuff

[[File:Arduino-wifizine-compile-done.png|500px|frame|none|alt=Screenshot of Arduino window with “done compiling” message in the bottom bar of the window|Screenshot of Arduino window with “done compiling” message in the bottom bar of the window]]

*'''If the compilation process ends abnormally, it will give an orange error'''

*If necessary, troubleshoot using the error messages (if you don’t get any, check that “verbose” is checked in settings of Arduino.

[[File:Arduino-wifizine-compile-failed.png|500px|frame|none|alt=Arduino window with an orange error message|Arduino window with an orange error message]]

===Upload to the Board===

*Click on the Upload button (arrow pointing right on top of the Arduino window), and then '''''while''''' the text ‘''Connecting …''’ displays in the control window at the bottom of the screen, [https://randomnerdtutorials.com/solved-failed-to-connect-to-esp32-timed-out-waiting-for-packet-header/ press and hold the’ BOOT ’button on the ESP board for one second].

[[File:Arduino-connecting.jpg|500px|frame|none|alt=when the output window in Arduino says CONNECTING, push the boot button on the board|when the output window in Arduino says CONNECTING, push the boot button on the board]]

*'''If the upload was successful, you will see this screen''':

[[File:Arduino-wifizine-upload-done.png|500px|frame|none|alt=output window in Arduino stating Leaving...Hard resetting via RTS pin....|output window in Arduino stating Leaving...Hard resetting via RTS pin....]]

*'''If the upload was unsuccessful, you will see this error'''

[[File:Arduino-wifizine-upload-failed.png|500px|frame|none|alt=arduino window with an orange error message|arduino window with an orange error message]][https://randomnerdtutorials.com/esp32-troubleshooting-guide/ Troubleshooting tips for various problem factors here]



For MacOS users we've collected some common [[ESP32 Mac troubleshooting|troubleshooting steps here]]



'''<big>If everything went well, you are now ready to upload your own code to the board!</big>'''