FTP Client

This ESP32 project is a FTP client that can download files from a remote server and store them in flash memory.

Prerequisites

• ESP32 development board
• ESP-IDF v5.4.1 or later

Installation

1. Clone the repository:

   git clone https://github.com/fabiooo4/esp32_ftp_client.git
   cd esp32_ftp_client
   

2. Build the project:

   idf.py build
   

3. Flash the project to the ESP32 (flash also builds the project):

   idf.py flash
   

4. Monitor the ESP32:

   idf.py monitor
   

Configuration

• FTP Client configuration
• Default configuration

The project is configured using the ESP-IDF menuconfig tool. To open the configuration menu, run the following command:

idf.py menuconfig

FTP Client configuration

All the possible FTP Client configurations can be found in the menuconfig under FTP Client configuration.

Wifi station

In Wifi station configuration set the SSID and password of the wifi network you want to connect to. You can also change other parameters.

FTP Server

In FTP Server configuration set the IP and Port of the FTP server you want to connect to.

If the FTP server requires authentication, set the username and password in FTP Server authentication menu.

Default configuration

Configuration options

• Flash size
• Custom partition table
  • Create filesystem images from the contents of a host folder
• Wifi setup
• Stack size

Flash size

In Serial Flasher Config/Flash Size set the amount of flash memory available on your model of microcontroller.

Custom partition table

In Partition Table/Partition Table set the option "Custom Partition Table CSV". This option expects a "partitions.csv" file that defines the custom partitions.

To add another storage partition add the configuration line to partitions.csv, for example:

# Name,  Type, SubType, Offset,   Size,     Flags
storage, data, spiffs,  0x110000, 0x100000,

Spiffs stands for "SPI Flash File System" wich is a lightweight filesystem that is designed to work with flash memory. The last two numbers are the start address and the size of the partition.

Create filesystem images from the contents of a host folder

To add default files to the ESP32 filesystem from the project root folder, add the following line to main/CMakeLists.txt:

spiffs_create_partition_image(<partition> <base_dir> [FLASH_IN_PROJECT] [DEPENDS dep dep dep...])

With this command the build configuration is automatically passed to the tool, ensuring that the generated image is valid for that build.

Optionally, you can opt to have the image automatically flashed together with the app binaries, partition tables, etc. on idf.py flash by specifying FLASH_IN_PROJECT. For example:

spiffs_create_partition_image(my_spiffs_partition my_folder FLASH_IN_PROJECT)

Stack size

In Component config/ESP System Settings/Main Task Stack Size has been set to 5120 bytes to prevent stack overflow errors due to large data buffers.

Testing ftplib

This code is tested with the following steps:

1. Connect to the FTP server.
2. Login to the FTP server.
3. List the remote directory.
4. Create a directory on the FTP server.
5. Upload a file to the FTP server.
6. Change the current directory to the created directory.
7. Print the current working directory.
8. List the remote directory again.
9. Download the file from the FTP server.
10. Delete the file from the FTP server.
11. Go to the parent directory.
12. Print the current working directory.
13. Remove the created directory from the FTP server.
14. Rename a file on the FTP server.
15. Access a file on the FTP server.
16. Edit the file on the FTP server.
17. Close the file on the FTP server.
18. List the remote directory again.
19. Get the file from the FTP server and check if its contents match the edited content.
20. Remove the file from the FTP server.
21. Close the FTP connection.

At the end of the program, the FTP connection is closed and no files or directories are left on the server.

References

• ESP-IDF Storage API
• ESP-IDF Wifi Driver