ESP32. Accéder aux fichiers SPIFFS en FTP avec la librairie ESP8266FtpServer • Domotique et objets connectés à faire soi-même

Il existe plusieurs librairies permettant d’accéder aux système de fichier SPIFFS stockés sur la mémoire flash d’un ESP32 en FTP. La librairie ESP8266FtpServer.h développée par David Paiva (nailbuster), très simple d’utilisation, permet d’ajouter un petit serveur FTP au code Arduino du projet ESP32. Elle fonctionne également sur ESP8266. On pourra l’utiliser pour récupérer des fichiers de données ou mettre à jour à distance les fichiers de l’interface HTML, le fichier de données d’une acquisition de données.

Le système de fichier SPIFFS pour ESP32 permet de stocker les fichiers sur le module à mémoire flash. On pourra séparer le code de l’interface HTML (fichier HTML, feuille de style CSS, code javascript) ainsi que des fichiers de données ou de paramètres. On utilisera la librairie SPIFFS.h pour accéder, créer ou modifier les fichiers depuis le code Arduino du projet.

Limitations du système de fichier SPIFFS

Avant de commencer, n’oubliez pas que le système de fichier SPIFFS est très limité.

  • Il n’y a aucune gestion d’arborescence. Les fichiers sont stockés à plat dans la zone mémoire
  • Il est possible d’utiliser le caractère / dans le nom de fichier. On peut créer une pseudo arborescence
  • Le nom de fichier est limité à 31 caractères utiles en incluant l’extension de fichier (4 caractères)
  • Evitez d’utiliser SPIFFS au delà de 128Mo de stockage
  • Le temps d’écriture est très variable

Ajouter la librairie ESP8266FtpServer.h à un projet Arduino ESP32

La librairie ESP8266FtpServer.h est en cours de développement. C’est une adaptation de la librairie Arduino de Gallegojm. Elle peut nous rendre bien des services dans deux situations.

Elle n’est pas disponible depuis le gestionnaire de librairies de l’IDE Arduino. Il faudra donc récupérer manuellement les fichiers et les ajouter au projet ESP32.

Allez sur la page GitHub du projet ici puis téléchargez le code du projet

Décompressez l’archive ZIP puis déplacez les fichiers ESP8266FtpServer.cpp et ESP8266FtpServer.h à la racine du projet au même niveau que le fichier ino du projet.

Exemple de serveur de fichier FTP sur ESP32

Créer un nouveau croquis sur l’IDE Arduino et coller le code suivant.

Modifier les paramètres suivants :

  • Identifiant et mot de passe WiFi
  • Identifiant et mot de passe du serveur FTP
#ifdef ESP8266
  #include  
#elif defined ESP32
  #include 
  #include "SPIFFS.h"
#endif
#include "ESP8266FtpServer.h"

const char* ssid = "enter_your_ssid";
const char* password = "enter_your_password";
const char* ftp_user = "esp32";
const char* ftp_password = "esp32";

FtpServer ftpSrv;  
void setup()
{
  Serial.begin(112500);

  WiFi.begin(ssid, password);
  Serial.println("");

  // Wait for connection
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print(".");
  }
  Serial.println("");
  Serial.print("Connected to ");
  Serial.println(ssid);
  Serial.print("IP address: ");
  Serial.println(WiFi.localIP());

  Serial.println(F("Inizializing FS..."));
  // FTP Setup, ensure SPIFFS is started before try to use ftp methods  
#ifdef ESP32       
  if (SPIFFS.begin(true)) {
#elif defined ESP8266
  if (SPIFFS.begin()) {
#endif
    Serial.println("SPIFFS opened!");
    ftpSrv.begin(ftp_user, ftp_password);   //username, password for ftp
  }
}

void loop() {
  ftpSrv.handleFTP();
}

Comment fonctionne le code C++

Comme les fichiers de la librairie sont au même niveau que le fichier ino, on déclare la librairie ESP8266FtpServer.h entre guillemets pour indiquer au compilateur qu’on doit utiliser les fichiers locaux.

#include "ESP8266FtpServer.h"

On créé ensuite l’objet C++ qui permettra de démarrer le serveur FTP et gérer les demandent externes

FtpServer ftpSrv;

A la mise sous tension de l’ESP32, on démarre le serveur FTP à l’aide de la méthode begin() dans le setup(). La méthode begin de l’objet FtpServer prend deux paramètres qui permettent de définir les identifiants de connexion au serveur FTP (utilisateur, mot de passe).

if (SPIFFS.begin()) {
  Serial.println("SPIFFS opened!");
  ftpSrv.begin(ftp_use,ftp_password);    //username, password for ftp.  set ports in ESP8266FtpServer.h  (default 21, 50009 for PASV)
}

Pour rendre accessible le serveur FTP, il faut appeler à chaque execution de la boucle loop la méthode handleFTP().

void loop(void){
  ftpSrv.handleFTP();
}

D’autres paramètres peuvent être configurés directement dans le code du projet

  • FTP_DEBUG dé-commentez pour activer l’envoi des messages de debug sur le moniteur série (pratique pour la mise au point)
  • FTP_CTRL_PORT port du serveur FTP. Par défaut, c’est le 21
  • FTP_TIME_OUT temps avant déconnexion automatique (j’ai un doute sur son bon fonctionnement)

C’est terminé, vous pouvez maintenant accéder à vos fichiers à l’aide d’un client FTP tel que FileZilla.

Accéder au système de fichier SPIFFS à l’aide du client FTP Filezilla

Dans la version actuelle, il n’y a que le mode passif qui est supporté. Le SFTP (FTP sécurisé) n’est pas supporté. Si vous ne connaissez pas Filezilla, vous pouvez commencer par lire ce tutoriel.

A LIRE AUSSI :

Comment se connecter en FTP à un Raspberry Pi

Lancez FileZilla. Le plus facile pour se connecter à un ESP8266 en FTP et d’utiliser le gestionnaire de site. J’ai rencontré des difficultés en utilisant la barre de connexion rapide. Ouvrez le gestionnaire de site depuis le menu Fichier et configurez l’accès comme ceci :

  • Hôte adresse IP de l’ESP32
  • Port 21 (ou celui configuré par la clé FTP_CTRL_PORT)
  • Protocole TFP – Protocole de Transfert de Fichiers
  • Chiffrement Connexion FTP simple (non sécurisé)
  • Type d’authentification  Normale
  • Identifiant et mot de passe 

Lancez la connexion en cliquant sur Connexion. La connexion est maintenant enregistrée par FileZilla, il ne sera plus nécessaire de le refaire.

Comme la connexion n’est pas sécurisée, vous devez accepter l’avertissement avant de pouvoir vous connecter à l’ESP32.

Une fois la connexion établie, vous avez un accès à tous les fichiers du répertoire Data du projet Arduino.

Il est également possible d’accéder en FTP aux fichiers SPIFFS et LittleFS sur ESP8266.

Mises à jour

02/09/2020 Première publication du tutoriel

Avez-vous aimé cet article ?