[LittleFS] Support for LittleFS

LittleFS can be built in custom 16M build env.
See esp8266/Arduino#5932

Author: TD-er

platformio.ini

@@ -116,9 +116,17 @@ build_flags               = ${esp82xx_defaults.build_flags} -DARDUINO_ESP8266_RE
 platform                  = [email protected]
 build_flags               = ${esp82xx_2_5_0.build_flags}
 
+
+; No idea how to make it multi-platform.
+; After initial download, go to the .platformio/packages/framework... directory
+; and type:  git submodule update
+[core_2_5_1_littlefs]
+platform                  = https://github.com/TD-er/platform-espressif8266.git#patch/v2.0.3_littlefs
+build_flags               = ${esp82xx_2_5_0.build_flags} -DCORE_POST_2_6_0 -DLITTLE_FS
+
 [core_stage]
 platform                  = https://github.com/platformio/platform-espressif8266.git#feature/stage
-build_flags               = ${esp82xx_2_5_0.build_flags}
+build_flags               = ${esp82xx_2_5_0.build_flags} -DCORE_POST_2_6_0
 
 
 [core_esp32_0_12_0]
@@ -179,6 +187,10 @@ build_unflags             =
 build_flags               = ${core_stage.build_flags} ${common.build_flags} -DARDUINO_ESP8266_RELEASE='"2.6.0-dev"'
 platform                  = ${core_stage.platform}
 
+[test_littlefs]
+build_unflags             =
+build_flags               = ${core_2_5_1_littlefs.build_flags} ${common.build_flags} -DARDUINO_ESP8266_RELEASE='"2.6.0-dev"'
+platform                  = ${core_2_5_1_littlefs.platform}
 
 
 [normal]
@@ -371,9 +383,49 @@ board_build.flash_mode    = dout
 targets                   = ${common.targets}
 
 
+;;; NORMAL (STABLE) ***************************************************
+; Custom defined build                                                ;
+; Hint: Also look at USE_CUSTOM_H                                     ;
+; *********************************************************************
+
+; NORMAL: 4096k version --------------------------
+[env:custom_ESP8266_4M]
+platform                  = ${normal_beta.platform}
+lib_deps                  = ${common.lib_deps}
+lib_ignore                = ${common.lib_ignore}
+lib_ldf_mode              = ${common.lib_ldf_mode}
+lib_archive               = ${common.lib_archive}
+framework                 = ${common.framework}
+upload_speed              = ${common.upload_speed}
+monitor_speed             = ${common.monitor_speed}
+board                     = ${esp8266_4M.board}
+board_build.f_cpu         = ${esp8266_4M.board_build.f_cpu}
+board_build.flash_mode    = ${esp8266_4M.board_build.flash_mode}
+build_unflags             = ${esp8266_4M.build_unflags}
+build_flags               = ${esp8266_4M.build_flags} ${normal_beta.build_flags} -DPLUGIN_BUILD_CUSTOM
+targets                   = ${common.targets}
+extra_scripts             = pre:pre_extra_script.py
+
+[env:custom_ESP8266_16M]
+platform                  = ${test_littlefs.platform}
+lib_deps                  = ${common.lib_deps}
+lib_ignore                = ${common.lib_ignore}
+lib_ldf_mode              = ${common.lib_ldf_mode}
+lib_archive               = ${common.lib_archive}
+framework                 = ${common.framework}
+upload_speed              = ${common.upload_speed}
+monitor_speed             = ${common.monitor_speed}
+board                     = ${esp8266_16M.board}
+board_build.f_cpu         = ${esp8266_16M.board_build.f_cpu}
+board_build.flash_mode    = ${esp8266_16M.board_build.flash_mode}
+build_unflags             = ${esp8266_16M.build_unflags}
+build_flags               = ${esp8266_16M.build_flags} ${test_littlefs.build_flags} -DPLUGIN_BUILD_CUSTOM
+targets                   = ${common.targets}
+extra_scripts             = pre:pre_extra_script.py
+
 
-;;; NORMAL (STABLE) ; ****; ****; ****; ****; ****; ****; ****; ****; ****; ****; ****;;;;
-; normal version with stable plugins                                                     ;
+;;; NORMAL (STABLE) ***************************************************
+; normal version with stable plugins                                  ;
 ; *********************************************************************
 
 ; NORMAL: 1024k version --------------------------
@@ -820,7 +872,7 @@ build_flags               = ${esp8266_4M.build_flags} ${normal_beta.build_flags}
 targets                   = ${common.targets}
 
 [env:normal_core_260_sdk222_alpha_ESP8266_4M]
-platform                  = ${testing_beta.platform}
+platform                  = ${normal_beta.platform}
 lib_deps                  = ${common.lib_deps}
 lib_ignore                = ${common.lib_ignore}
 lib_ldf_mode              = ${common.lib_ldf_mode}

pre_extra_script.py

@@ -0,0 +1,28 @@
+Import("env")
+
+# access to global construction environment
+#print env
+
+# Dump construction environment (for debug purpose)
+#print env.Dump()
+
+# append extra flags to global build environment
+# which later will be used to build:
+# - project source code
+# - frameworks
+# - dependent libraries
+env.Append(CPPDEFINES=[
+  "PIO_FRAMEWORK_ARDUINO_ESPRESSIF_SDK22x",
+  "CONTROLLER_SET_ALL",
+  "NOTIFIER_SET_NONE",
+  "PLUGIN_SET_ONLY_SWITCH",
+  "USES_P002",  # ADC
+  "USES_P028",  # BME280
+  "USES_P036",  # FrameOLED
+  "USES_P049",  # MHZ19
+  "USES_P052",  # SenseAir
+  "USES_P056",  # SDS011-Dust
+  "USES_P082",  # GPS
+
+  ("WEBSERVER_RULES_DEBUG", "0")
+])

src/ESPEasy-Globals.h

@@ -491,6 +491,7 @@ void setBitToUL(uint32_t& number, byte bitnr, bool value);
 void serialHelper_getGpioNames(struct EventStruct *event, bool rxOptional=false, bool txOptional=false);
 
 fs::File tryOpenFile(const String& fname, const String& mode);
+//String FileError(int line, const char * fname);
 
 enum SettingsType {
   BasicSettings_Type = 0,
@@ -565,10 +566,19 @@ bool showSettingsFileLayout = false;
   extern "C" {
   #include "spi_flash.h"
   }
-  extern "C" uint32_t _SPIFFS_start;
-  extern "C" uint32_t _SPIFFS_end;
-  extern "C" uint32_t _SPIFFS_page;
-  extern "C" uint32_t _SPIFFS_block;
+
+  #ifdef LITTLE_FS
+    #include "LittleFS.h"
+    extern "C" uint32_t _FS_start;
+    extern "C" uint32_t _FS_end;
+    extern "C" uint32_t _FS_page;
+    extern "C" uint32_t _FS_block;
+  #else
+    extern "C" uint32_t _SPIFFS_start;
+    extern "C" uint32_t _SPIFFS_end;
+    extern "C" uint32_t _SPIFFS_page;
+    extern "C" uint32_t _SPIFFS_block;
+  #endif
   #ifdef FEATURE_MDNS
     #include <ESP8266mDNS.h>
   #endif
@@ -2095,13 +2105,14 @@ unsigned long timingstats_last_reset = 0;
 #define WIFI_NOTCONNECTED_STATS 40
 #define LOAD_TASK_SETTINGS      41
 #define TRY_OPEN_FILE           42
-#define SPIFFS_GC_SUCCESS       43
-#define SPIFFS_GC_FAIL          44
-#define RULES_PROCESSING        45
-#define GRAT_ARP_STATS          46
-#define BACKGROUND_TASKS        47
-#define HANDLE_SCHEDULER_IDLE   48
-#define HANDLE_SCHEDULER_TASK   49
+#define CLEARFILE_STATS         43
+#define SPIFFS_GC_SUCCESS       44
+#define SPIFFS_GC_FAIL          45
+#define RULES_PROCESSING        46
+#define GRAT_ARP_STATS          47
+#define BACKGROUND_TASKS        48
+#define HANDLE_SCHEDULER_IDLE   49
+#define HANDLE_SCHEDULER_TASK   50
 
 
 
@@ -2117,6 +2128,7 @@ String getMiscStatsName(int stat) {
     switch (stat) {
         case LOADFILE_STATS:        return F("Load File");
         case SAVEFILE_STATS:        return F("Save File");
+        case CLEARFILE_STATS:       return F("Clear File");
         case LOOP_STATS:            return F("Loop");
         case PLUGIN_CALL_50PS:      return F("Plugin call 50 p/s");
         case PLUGIN_CALL_10PS:      return F("Plugin call 10 p/s");
@@ -2348,7 +2360,7 @@ void addPredefinedRules(const GpioFactorySettingsStruct& gpio_settings);
 // may not filter the ifdef checks properly.
 // Also the functions use a lot of global defined variables, so include at the end of this file.
 #include "ESPEasyWiFiEvent.h"
-#define SPIFFS_CHECK(result, fname) if (!(result)) { return(FileError(__LINE__, fname)); }
+#define FS_RES_CHECK(result, fname) if (!(result)) { return(FileError(__LINE__, fname)); }
 #include "WebServer_Rules.h"
 
 #endif /* ESPEASY_GLOBALS_H_ */

src/ESPEasy.ino

@@ -159,7 +159,7 @@ void setup()
   APModeStationDisconnectedHandler = WiFi.onSoftAPModeStationDisconnected(onDisonnectedAPmode);
 #endif
 
-  if (SpiffsSectors() < 32)
+  if (FS_sectorCount() < 32)
   {
     serialPrintln(F("\nNo (or too small) SPIFFS area..\nSystem Halted\nPlease reflash with 128k SPIFFS minimum!"));
     while (true)
@@ -577,7 +577,7 @@ void loop()
     runPeriodicalMQTT();
     flushAndDisconnectAllClients();
 
-    SPIFFS.end();
+    FILESYSTEMTYPE.end();
 
     deepSleep(Settings.Delay);
     //deepsleep will never return, its a special kind of reboot

src/ESPEasyRTC.ino

@@ -289,7 +289,7 @@ struct RTC_cache_handler_struct
     initRTCcache_data();
     for (int i=0; i < 2; ++i) {
       String fname = createCacheFilename(RTC_cache.readFileNr);
-      if (SPIFFS.exists(fname)) {
+      if (FILESYSTEMTYPE.exists(fname)) {
         if (i != 0) {
           // First attempt failed, so stored read position is not valid
           RTC_cache.readPos = 0;
@@ -318,7 +318,7 @@ struct RTC_cache_handler_struct
       fname = createCacheFilename(peekfilenr);
     }
     islast = peekfilenr > RTC_cache.writeFileNr;
-    if (SPIFFS.exists(fname)) {
+    if (FILESYSTEMTYPE.exists(fname)) {
       return fname;
     }
     return "";
@@ -331,7 +331,7 @@ struct RTC_cache_handler_struct
         String fname = createCacheFilename(RTC_cache.readFileNr);
         if (tryDeleteFile(fname)) {
           #ifdef RTC_STRUCT_DEBUG
-          String log = F("RTC  : Removed file from SPIFFS: ");
+          String log = F("RTC  : Removed file from FS: ");
           log += fname;
           addLog(LOG_LEVEL_INFO, String(log));
           #endif
@@ -461,9 +461,9 @@ private:
 //    if (storageLocation != CACHE_STORAGE_SPIFFS) {
 //      return false;
 //    }
-    if (SpiffsFull()) {
+    if (FS_full()) {
       #ifdef RTC_STRUCT_DEBUG
-      addLog(LOG_LEVEL_ERROR, String(F("RTC  : SPIFFS full")));
+      addLog(LOG_LEVEL_ERROR, String(F("RTC  : FS full")));
       #endif
       return false;
     }
@@ -478,7 +478,7 @@ private:
         // Open file to write
         initRTCcache_data();
         if (updateRTC_filenameCounters()) {
-          if (writeerror || SpiffsFreeSpace() < ((2 * CACHE_FILE_MAX_SIZE) + SpiffsBlocksize())) {
+          if (writeerror || FS_freeSpace() < ((2 * CACHE_FILE_MAX_SIZE) + FS_blockSize())) {
             // Not enough room for another file, remove the oldest one.
             deleteOldestCacheBlock();
           }

src/ESPEasyRules.ino

@@ -40,7 +40,7 @@ void checkRuleSets() {
 #endif
     fileName += x + 1;
     fileName += F(".txt");
-    if (SPIFFS.exists(fileName))
+    if (FILESYSTEMTYPE.exists(fileName))
       activeRuleSets[x] = true;
     else
       activeRuleSets[x] = false;
@@ -88,7 +88,7 @@ void rulesProcessing(String &event) {
   } else {
     String fileName = EventToFileName(event);
     // if exists processed the rule file
-    if (SPIFFS.exists(fileName))
+    if (FILESYSTEMTYPE.exists(fileName))
       rulesProcessingFile(fileName, event);
 #ifndef BUILD_NO_DEBUG
       else
@@ -139,7 +139,7 @@ String rulesProcessingFile(const String &fileName, String &event) {
   }
 
   fs::File f = tryOpenFile(fileName, "r+");
-  SPIFFS_CHECK(f, fileName.c_str());
+  FS_RES_CHECK(f, fileName.c_str());
 
   String line = "";
   bool match = false;
@@ -157,7 +157,7 @@ String rulesProcessingFile(const String &fileName, String &event) {
     for (int x = 0; x < len; x++) {
       data = buf[x];
 
-      SPIFFS_CHECK(data >= 0, fileName.c_str());
+      FS_RES_CHECK(data >= 0, fileName.c_str());
 
       if (data != 10) {
         line += char(data);