Skip to content

Latest commit

 

History

History
269 lines (207 loc) · 10.9 KB

README.md

File metadata and controls

269 lines (207 loc) · 10.9 KB
Raw

esp-idf-ftpClient

FTP Client for esp-idf.
This project use ESP32-FTP-Client. It's a great job.

Software requirements

ESP-IDF V4.4/V5.x.
ESP-IDF V5.0 is required when using ESP32-C2.
ESP-IDF V5.1 is required when using ESP32-C6.

Installation

git clone https://github.com/nopnop2002/esp-idf-ftpClient
cd esp-idf-ftpClient/
idf.py set-target {esp32/esp32s2/esp32s3/esp32c2/esp32c3/esp32c6}
idf.py menuconfig
idf.py flash

If you need more storage space on FLASH, you need to modify partitions_example.csv.

Partition table

# Name,   Type, SubType, Offset,  Size, Flags
# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap
nvs,      data, nvs,     0x9000,  0x6000,
phy_init, data, phy,     0xf000,  0x1000,
factory,  app,  factory, 0x10000, 1M,
storage0,  data, spiffs, ,        0x70000,  ---> This is for SPIFFS file system
storage1,  data, fat,    ,        0x70000,  ---> This is for FAT file system

Configuration

config-top config-app

File System Selection

ESP32 supports the following file systems.
You can select any one using menuconfig.

  • SPIFFS file system on FLASH
  • FAT file system on FLASH
  • FAT file system on SPI peripheral SDCARD
  • FAT file system on SDMMC peripheral SDCARD(Valid only for ESP32/ESP32S3)
  • FAT file system on SPI Flash Memory like Winbond W25Q64(Valid only for ESP32)
  • FAT file system on USB Memory Stick(Not supported in this project)

config-file-system-1 config-file-system-2

Note:
The connection when using SDSPI, SDMMC, and SPI flash Memory will be described later.

Wifi Setting

config-wifi

FTP Server Setting

config-ftp-server

Using FAT file system on SPI peripheral SDCARD

ESP32 ESP32S2/S3 ESP32C2/C3/C6 SD card pin Notes
GPIO23 GPIO35 GPIO01 MOSI 10k pull up if can't mount
GPIO19 GPIO37 GPIO03 MISO
GPIO18 GPIO36 GPIO02 SCK
GPIO5 GPIO34 GPIO04 CS
3.3V 3.3V 3.3V VCC Don't use 5V supply
GND GND GND GND

config-file-system-sdspi

You can change it to any pin using menuconfig.

Note:
This project doesn't utilize card detect (CD) and write protect (WP) signals from SD card slot.

Using FAT file system on SDMMC peripheral SDCARD

On ESP32, SDMMC peripheral is connected to specific GPIO pins using the IO MUX.
GPIO pins cannot be customized.
GPIO2 and GPIO12 cannot be changed.
So using 4-line SD mode with ESP32 is very tricky.
Please see the table below for the pin connections.

ESP32 pin SD card pin Notes
GPIO14 CLK 10k pullup
GPIO15 CMD 10k pullup
GPIO2 D0 10k pullup or connect to GPIO00
GPIO4 D1 not used in 1-line SD mode; 10k pullup in 4-line SD mode
GPIO12 D2 not used in 1-line SD mode; 10k pullup in 4-line SD mode
GPIO13 D3 not used in 1-line SD mode, but card's D3 pin must have a 10k pullup
N/C CD not used in this project
N/C WP not used in this project
3.3V VCC Don't use 5V supply
GND GND

config-file-system-sdmmc-esp32

On ESP32-S3, SDMMC peripheral is connected to GPIO pins using GPIO matrix.
This allows arbitrary GPIOs to be used to connect an SD card.

ESP32-S3 pin SD card pin Notes
GPIO36 CLK 10k pullup
GPIO35 CMD 10k pullup
GPIO37 D0 10k pullup
GPIO38 D1 not used in 1-line SD mode; 10k pullup in 4-line SD mode
GPIO33 D2 not used in 1-line SD mode; 10k pullup in 4-line SD mode
GPIO34 D3 not used in 1-line SD mode, but card's D3 pin must have a 10k pullup
N/C CD not used in this project
N/C WP not used in this project
3.3V VCC Don't use 5V supply
GND GND

config-file-system-sdmmc-esp32s3

Note about GPIO2 (ESP32 only)

GPIO2 pin is used as a bootstrapping pin, and should be low to enter UART download mode. One way to do this is to connect GPIO0 and GPIO2 using a jumper, and then the auto-reset circuit on most development boards will pull GPIO2 low along with GPIO0, when entering download mode.

  • Some boards have pulldown and/or LED on GPIO2. LED is usually ok, but pulldown will interfere with D0 signals and must be removed. Check the schematic of your development board for anything connected to GPIO2.

Note about GPIO12 (ESP32 only)

GPIO12 is used as a bootstrapping pin to select output voltage of an internal regulator which powers the flash chip (VDD_SDIO).
This pin has an internal pulldown so if left unconnected it will read low at reset (selecting default 3.3V operation).
When adding a pullup to this pin for SD card operation, consider the following:

  • For boards which don't use the internal regulator (VDD_SDIO) to power the flash, GPIO12 can be pulled high.
  • For boards which use 1.8V flash chip, GPIO12 needs to be pulled high at reset. This is fully compatible with SD card operation.
  • On boards which use the internal regulator and a 3.3V flash chip, GPIO12 must be low at reset. This is incompatible with SD card operation.
    • In most cases, external pullup can be omitted and an internal pullup can be enabled using a gpio_pullup_en(GPIO_NUM_12); call. Most SD cards work fine when an internal pullup on GPIO12 line is enabled. Note that if ESP32 experiences a power-on reset while the SD card is sending data, high level on GPIO12 can be latched into the bootstrapping register, and ESP32 will enter a boot loop until external reset with correct GPIO12 level is applied.
    • Another option is to burn the flash voltage selection efuses. This will permanently select 3.3V output voltage for the internal regulator, and GPIO12 will not be used as a bootstrapping pin. Then it is safe to connect a pullup resistor to GPIO12. This option is suggested for production use.

Using FAT file system on SPI Flash Memory

I tested these SPI Flash Memory.
https://github.com/nopnop2002/esp-idf-w25q64

ESP32 pin SPI bus signal SPI Flash pin
GPIO23 MOSI DI
GPIO19 MISO DO
GPIO18 SCK CLK
GPIO5 CS CMD
3.3V /WP
3.3V /HOLD
3.3V VCC
GND GND

Note: You will get an error. It works fine after a few resets. At the moment, it is not stable.

I (2121) FTP: Initializing external SPI Flash
I (2121) FTP: Pin assignments:
I (2121) FTP: MOSI: 23   MISO: 19   SCLK: 18   CS:  5
E (2131) memspi: no response
E (2131) FTP: Failed to initialize external Flash: ESP_ERR_INVALID_RESPONSE (0x108)

After reset

I (1621) FTP: Initializing external SPI Flash
I (1621) FTP: Pin assignments:
I (1631) FTP: MOSI: 23   MISO: 19   SCLK: 18   CS:  5
I (1631) spi_flash: detected chip: winbond
I (1641) spi_flash: flash io: dio
I (1641) FTP: Initialized external Flash, size=8192 KB, ID=0xef4017
I (1651) FTP: Adding external Flash as a partition, label="storage", size=8192 KB
I (1661) FTP: Initializing FAT file system
I (1661) FTP: Mount FAT filesystem on /root

Using LilyGo ESP32-S2

The LilyGo ESP32-S2 development board has a micro SD card slot on the board.
It is connected to the ESP32 by SPI, and the peripheral power is supplied from GPIO14.
No equipment other than the development board is required.
It works very stably.

ESP32 pin SPI bus signal
GPIO11 MOSI
GPIO13 MISO
GPIO12 SCK
GPIO10 CS
GPIO14 POWER

LilyGo-esp32-s2-1 config_file-system-sdspi-LilyGo_ESP32-S2

API

Based on ftplib V4.0-1.

Server Connection

  • ftpClientConnect() - Connect to a remote server
  • ftpClientLogin() - Login to remote machine
  • ftpClientQuit() - Disconnect from remote server
  • ftpClientSetOptions() - Set Connection Options

Directory Functions

  • ftpClientChangeDir() - Change working directory
  • ftpClientMakeDir() - Create a directory
  • ftpClientRemoveDir() - Remove a directory
  • ftpClientDir() - List a remote directory
  • ftpClientNlst() - List a remote directory
  • ftpClientChangeDirUp() - Change to parent directory
  • ftpClientPwd() - Determine current working directory

File to File Transfer

  • ftpClientGet() - Retreive a remote file
  • ftpClientPut() - Send a local file to remote
  • ftpClientDelete() - Delete a remote file
  • ftpClientRename() - Rename a remote file

File to Program Transfer

These routines allow programs access to the data streams connected to remote files and directories.

  • ftpClientAccess() - Open a remote file or directory
  • ftpClientRead() - Read from remote file or directory
  • ftpClientWrite() - Write to remote file
  • ftpClientClose() - Close data connection

Using long file name support

By default, FATFS file names can be up to 8 characters long.
If you use filenames longer than 8 characters, you need to change the values below.
config_long_file_name_support-1 config_long_file_name_support-2 config_long_file_name_support-3

Screen Shot

ScrrenShot

  • Get remote file list
  • Write local file
  • Put file to server
  • Remove local file
  • Get file from sever
  • Read local file

Truble shooting

By changing this, you can see the response from the server:

#define FTP_CLIENT_DEBUG                    2

FTP Server using python

https://github.com/nopnop2002/esp-idf-ftpClient/tree/master/python-ftp-server

Reference