LittleFS_esp32

LittleFS for esp32


Keywords
littlefs, spiffs
License
GPL-2.0
Install
platformio lib install 11164

Documentation

LITTLEFS

LittleFS library for arduino-esp32

! Warning: This wrapper depends on ESP-IDF, esp32 core, esp_littlefs and Mbed LittleFS versions
  • Tested with esp32 cores built on IDFv3.2, IDFv3.3 and esp32s2 on IDFv4.2
  • For esp32 core release 1.0.4 w/ IDFv3.2 you need to uncomment this line in esp_littlefs.c: //#define CONFIG_LITTLEFS_FOR_IDF_3_2
  • See LITTLEFS_time example with file timestamps that works with esp32 core on IDF v3.3

Installation

  • Copy LITTLEFS to Arduino IDE /libraries folder (File > Preferences > Sketchbook location).

Usage

  • Use LITTLEFS same way as SPIFFS
  • A quick startup based on your existing code you can re-define SPIFFS like this
#define USE_LittleFS

#include <FS.h>
#ifdef USE_LittleFS
  #define SPIFFS LITTLEFS
  #include <LITTLEFS.h> 
#else
  #include <SPIFFS.h>
#endif 

Differences with SPIFFS

  • LittleFS has folders, you need need to iterate files in folders
  • At root a "/folder" = "folder"
  • Requires a label for mount point, NULL will not work
  • maxOpenFiles parameter is unused, kept for compatibility
  • LITTLEFS.mkdir(path) and LITTLEFS.rmdir(path) work as expected for folders
  • Speed comparison based on LittleFS_test.ino sketch (for a file 1048576 bytes):
Filesystem Read time [ms] Write time [ms]
FAT 276 14493
LITTLEFS 446* 16387
SPIFFS 767 65622

*The read speed improved by changing #define CONFIG_LITTLEFS_CACHE_SIZE from 128 to 512

Arduino ESP32 LittleFS filesystem upload tool

PlatformIO

(notes from BlueAndi )

  • Add to platformio.ini: extra_scripts = replace_fs.py

  • Add replace_fs.py to project root directory (where platformio.ini is located):

Import("env")
print("Replace MKSPIFFSTOOL with mklittlefs.exe")
env.Replace (MKSPIFFSTOOL = "mklittlefs.exe")
  • Add mklittlefs.exe to project root directory as well.

Credits and license