ESP32 Toolchain - Revision history

SteveT: Added a note for using it on PCs with restricted accounts

2024-10-17T15:21:20Z

Added a note for using it on PCs with restricted accounts

MartinW at 16:13, 3 October 2024

2024-10-03T16:13:17Z

MartinW at 15:31, 3 October 2024

2024-10-03T15:31:25Z

MartinW at 15:16, 3 October 2024

2024-10-03T15:16:33Z

MartinW at 10:59, 3 October 2024

2024-10-03T10:59:12Z

MartinW at 11:12, 22 April 2024

2024-04-22T11:12:41Z

MartinW at 09:23, 11 March 2024

2024-03-11T09:23:34Z

MartinW: Created page with "The ESP32 toolchain includes a lot more extras and so we have used the standard Espresif installer as that does all the extra functionality for you. The only downside to this..."

2024-02-07T13:58:38Z

Created page with "The ESP32 toolchain includes a lot more extras and so we have used the standard Espresif installer as that does all the extra functionality for you. The only downside to this..."

New page

The ESP32 toolchain includes a lot more extras and so we have used the standard Espresif installer as that does all the extra functionality for you.

The only downside to this is you have to manually point Flowcode at the toolchain.

The toolchain can be downloaded from here: https://flowcode.co.uk/download

Please report any problems or issues on the Flowcode user forum.

Installation

Once the download has finished run the installation file.

[[File:ESP32_Setup1.png]]

Select – I accept the agreement and click Next

[[File:ESP32_Setup2.png]]

If you have a different version of Python installed, then I would recommend sicking with Python 3.7

''<span style="color:red;">Please note some versions of Python may cause the installer to fail, if this happens then try again and use the supplied version 3.7</span>''

If you have Git already installed then you can select your version of Git.

Otherwise select Install Git

[[File:ESP32_Setup3.png]]

If you have an ESP-IDF already downloaded then you can select your version of ESP-IDF.

Otherwise, select Download ESP-IDF

[[File:ESP32_Setup4.png]]

Select which ESP-IDF to install, we recommend the lowest version as the higher versions have not been tested.

At the time of writing 5.1 (Release branch is OK to use)

Install to a location on your system with no spaces in the path.

For example C:\esp-idf

[[File:ESP32_Setup5.png]]

Select a location for the ESP-IDF Tools to be installed, again use a path that contains no spaces

For example C:\esp-idf-tools

[[File:ESP32_Setup6.png]]

Select addition tasks, recommend keeping all options checked and click Next.

[[File:ESP32_Setup7.png]]

On the confirmation screen check the paths are correct and click Install

[[File:ESP32_Setup8.png]]

During the installation process you may get some of the following pop-ups appearing

Click Yes to allow Git to be installed

[[File:ESP32_Setup9.png]]

Click Yes to allow Windows PowerShell to be installed

[[File:ESP32_Setup10.png]]

Installation complete

You do not need to run the ESP-IDF command prompt as we will be invoking this from Flowcode:

[[File:ESP32_Setup11.png]]

A PC reboot may be required after installation has been completed.

'''Setting up Flowcode for use with the ESP32 toolchain'''

Copy the location of the esp-idf (e.g. C:\esp-idf) into the

Global Settings > Locations tab.

Or if you have a project loaded

File > Global Settings > Locations tab:

[[File:ESP32_Setup12.png]]

Click OK

'''Flowcode ESP32 Projects'''

When you create a new Flowcode ESP32 project the first time you compile a folder will be created in
the Flowcode project directory with the same name as the Flowcde project file.

The folder contains all the standard build output for an ESP32 project.

The first compilation of a project will take a while to complete – around 5 minutes as all of the ESP32
libraries are pulled in from the ESP-IDF and compiled one by one. After the initial compilation
subsequent compilations will be much faster.

Inside the folder is a file called sdkconfig, this file is a text file that contains the configuration for the
ESP32 device.

Any changes to this file will automatically trigger another extended compilation.

If you connect your ESP board before running Flowcode then the boards COM port will appear in the Flowcode project options.

This will need to be selected and correct for the Compile to Chip menu option to function correctly.

[[File:ESP32_Setup13.png]]

← Older revision		Revision as of 15:21, 17 October 2024
Line 64:		Line 64:

	fatal: not a git repository (or any of the parent directories): .git		fatal: not a git repository (or any of the parent directories): .git
		+
		+
		+	=== Important note for ESP32 users using restricted multiuser Windows accounts ===
		+	[[File:CreateSingleCFile.png\|thumb\|Set Flowcode to create a single .c file]]
		+	When using the ESP32 toolchain in a multiuser environment, it is important that Flowcode is set to create a single .c file instead of using separate .c and .h files. This setting can be found in the “Application” tab of Flowcode’s “Global Options” and needs to be unticked for each user as shown in the image.
		+
		+	Note that the default setting is for this to be ticked. This setting is controlled by the following per-user registry key and IT administrators may find it more convenient to set the following key for all users during the installation of Flowcode:
		+	* [HKEY_CURRENT_USER\SOFTWARE\MatrixTSL\FlowcodeV10\Options\compilation]
		+	* "SeparateHeader"=dword:00000000
		+
		+
		+	In addition, it is important that all users of Flowcode have read/write/execute access to the following subfolders of the ESP32 installation (by default, this will be in C:\FC_ESP). These are temporary folders used during the compilation process by the ESP32 toolchain.
		+	* \mtxlolin32_lite_sdkconfig
		+	* \mtxesp32_c3_sdkconfig
		+	* \mtxesp32_c6_sdkconfig
		+	* \mtxesp32_s2_sdkconfig
		+	* \mtxesp32_s3_sdkconfig
		+	* \mtxesp32s_sdkconfig
		+	* \mtxheltec_sdkconfig
		+	* \mtxlolinD32_Pro_sdkconfig
		+	* \mtxttgo_td_sdkconfig
		+	* \mtx
		+
		+	The latest installer of this toolchain (from 18th Oct 2024) will attempt to create these folders with appropriate user privileges. If an earlier installer is used or the installer fails to set the permissions appropriately, an IT administrator will need to ensure that network users have generic read/write/execute access to these folders.

@@ Line 10: / Line 10: @@
 Right-click on the file and select install you will see:
-[[File:ESP32 Toolchain1.png|Left]]
+[[File:ESP32 Toolchain1.png]]
 The default drive will be on the same drive that the msi file is saved on.
 You can change the drive, but you must leave FC_ESP as the default directory.
 When you compile for the first time, it will take considerably longer then subsequence compiles.
 If there is the following error message:
@@ Line 29: / Line 59: @@
 Then either Flowcode project was not reloaded after full component database update, or all the components have not been updated with the latest Version.
 The following message can be ignored:
 fatal: not a git repository (or any of the parent directories): .git

@@ Line 2: / Line 2: @@
 Note: If you are upgrading from a previous version of the ESP32 toolchain then either rename your project or select the folder for your project that was created using the previous version of the ESP32 toolchain.
 Download the ESP32 toolchain from the Toolchain section of the [https://flowcode.co.uk/download/ Flowcode Downloads page].
@@ Line 7: / Line 8: @@
 Save the ESP .msi file to your PC.
-Right-click on the file and select install.
+Right-click on the file and select install you will see:
 The default drive will be on the same drive that the msi file is saved on.

@@ Line 1: / Line 1: @@
 Prior to installing the ESP32 toolchain, is vital that you [[Library_Updates|update Flowcode components]] using the Full database option, then reload (Fle > reload) your project or start a new one.
-Note: If you are upgrading from a previous version of the ESP32 toolchsain then either rename your project or delect the folder for your project that was created using the previous version of the ESP32 toolchain.
+Note: If you are upgrading from a previous version of the ESP32 toolchain then either rename your project or select the folder for your project that was created using the previous version of the ESP32 toolchain.
 Download the ESP32 toolchain from the Toolchain section of the [https://flowcode.co.uk/download/ Flowcode Downloads page].
@@ Line 11: / Line 11: @@
 Follow the prompts.
-The default drive will be on the same drive thart the msi file is saved on.
+The default drive will be on the same drive that the msi file is saved on.
 You can change the drive, but you must leave FC_ESP as the default directory.
-When you compile for the first time, it will take considerbly longer then subsequence compiles.
+When you compile for the first time, it will take considerably longer then subsequence compiles.
-If there is the following erorr message:
+If there is the following error message:
 'idf.py' is not recognized as an internal or external command
-Then either Flowcode project was not reloaded ater full componet database update, or all the components have not beeen updated with the latest Version.
+Then either Flowcode project was not reloaded after full component database update, or all the components have not been updated with the latest Version.
 The following message can be ignored:
 fatal: not a git repository (or any of the parent directories): .git

@@ Line 1: / Line 1: @@
-The ESP32 toolchain includes a lot more extras and so we have used the standard Espresif installer as that does all the extra functionality for you.
+Prior to installing the ESP32 toolchain, is vital that you [[Library_Updates|update Flowcode components]] using the Full database option, then reload (Fle > reload) your project or start a new one.
-The only downside to this is you have to manually point Flowcode at the toolchain.
+Note: If you are upgrading from a previous version of the ESP32 toolchsain then either rename your project or delect the folder for your project that was created using the previous version of the ESP32 toolchain.
-The toolchain can be downloaded from here: https://flowcode.co.uk/download
+Save the ESP .msi file to your PC.
-Please report any problems or issues on the Flowcode user forum.
+Right-click on the file and select install.
-Installation
+The default drive will be on the same drive thart the msi file is saved on.
-Once the download has finished run the installation file.
+You can change the drive, but you must leave FC_ESP as the default directory.
-[[File:ESP32_Setup1.png]]
+When you compile for the first time, it will take considerbly longer then subsequence compiles.
-Select – I accept the agreement and click Next
+If there is the following erorr message:
-[[File:ESP32_Setup2.png]]
+'idf.py' is not recognized as an internal or external command
-If you have a different version of Python installed, then I would recommend sicking with Python 3.7
+Then either Flowcode project was not reloaded ater full componet database update, or all the components have not beeen updated with the latest Version.
-''<span style="color:red;">Please note some versions of Python may cause the installer to fail, if this happens then try again and use the supplied version 3.7</span>''
+The following message can be ignored:
-If you have Git already installed then you can select your version of Git.
+fatal: not a git repository (or any of the parent directories): .git

← Older revision		Revision as of 11:12, 22 April 2024
Line 36:		Line 36:

	Select which ESP-IDF to install, we recommend the lowest version as the higher versions have not been tested.		Select which ESP-IDF to install, we recommend the lowest version as the higher versions have not been tested.
−
−	~~''<span style="color:red;">There now appears to be an installation issue with v5.1 Release branch, we now recommend v 5.1.3 release version </span>''~~

	Install to a location on your system with no spaces in the path.		Install to a location on your system with no spaces in the path.

@@ Line 29: / Line 29: @@
 [[File:ESP32_Setup3.png]]
-If you have an ESP-IDF already downloaded then you can select your version of ESP-IDF.
+If you have an ESP-IDF already downloaded, then you can select your version of ESP-IDF.
 Otherwise, select Download ESP-IDF
@@ Line 37: / Line 37: @@
 Select which ESP-IDF to install, we recommend the lowest version as the higher versions have not been tested.
-At the time of writing  5.1 (Release branch is OK to use)
+''<span style="color:red;">There now appears to be an installation issue with v5.1 Release branch, we now recommend  v 5.1.3 release version  </span>''
 Install to a location on your system with no spaces in the path.
@@ Line 94: / Line 94: @@
 When you create a new Flowcode ESP32 project the first time you compile a folder will be created in
-the Flowcode project directory with the same name as the Flowcde project file.
+the Flowcode project directory with the same name as the Flowcode project file.
 The folder contains all the standard build output for an ESP32 project.