Browse Source

Requesting acceptance by Arduino Library Manager. Tag v1.0 is for esp32 core release 1.0.4

lorol 4 years ago
parent
commit
9b67677007
4 changed files with 17 additions and 17 deletions
  1. 7 7
      README.md
  2. 3 3
      library.json
  3. 6 6
      library.properties
  4. 1 1
      src/esp_littlefs.c

+ 7 - 7
README.md

@@ -1,4 +1,4 @@
-# LITTLEFS
+# LittleFS_esp32
 
 ## LittleFS library for arduino-esp32
 
@@ -6,18 +6,18 @@
 - Based on [ESP-IDF port of joltwallet/esp_littlefs](https://github.com/joltwallet/esp_littlefs) , thank you Brian!
 - See also the [LillteFS library for ESP8266 core](https://github.com/esp8266/Arduino/tree/master/libraries/LittleFS) 
 - Functionality is similar to SPIFFS
-- [Related PR at esp32 core development](https://github.com/espressif/arduino-esp32/pull/4096) 
-- [Related PR at esp-idf development](https://github.com/espressif/esp-idf/pull/5469)
+- [PR at esp32 core development](https://github.com/espressif/arduino-esp32/pull/4096) 
+- [PR at esp-idf development](https://github.com/espressif/esp-idf/pull/5469)
 ```diff
-! Warning: This wrapper depends on ESP-IDF, esp32 core, esp_littlefs and Mbed LittleFS versions
+! Warning: This wrapper depends on ESP-IDF version the esp32 core is built on
 ```
-- 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```
+- Tested with esp32 cores built on IDFv3.2, IDFv3.3 and IDFv4 - IDFv4.3
 - 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). 
+- If it gets accepted for [Arduino Library Manager](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ ), take it from there. The release 1.0 is compatible to core 1.0.4 and PlatformIO
+- Use git or copy  **LITTLEFS** to Arduino IDE **/libraries** folder (File > Preferences > Sketchbook location) and adjust ```//#define CONFIG_LITTLEFS_FOR_IDF_3_2``` in **esp_littlefs.c** if needed. For all higher version, it should be commented. 
 
 ### Usage
 

+ 3 - 3
library.json

@@ -1,10 +1,10 @@
 {
-  "name":"LITTLEFS",
-  "description":"LITTLEFS File System Library for ESP32",
+  "name":"LittleFS_esp32",
+  "description":"LittleFS for esp32",
   "keywords":"littlefs, spiffs",
   "authors":
   {
-    "name": "LL",
+    "name": "lorol",
     "maintainer": true
   },
   "repository":

+ 6 - 6
library.properties

@@ -1,9 +1,9 @@
-name=LITTLEFS
+name=LittleFS_esp32
 version=1.0
-author=LL
-maintainer=LL
-sentence=ESP32 LITTLEFS File System
-paragraph=
+author=lorol
+maintainer=lorol
+sentence=LittleFS for esp32
+paragraph=LittleFS for esp32
 category=Data Storage
-url=
+url=https://github.com/lorol/LITTLEFS
 architectures=esp32

+ 1 - 1
src/esp_littlefs.c

@@ -12,7 +12,7 @@
  */
 
 //#define LOG_LOCAL_LEVEL 4
-//#define CONFIG_LITTLEFS_FOR_IDF_3_2   /* For old IDF - like in release 1.0.4 */
+#define CONFIG_LITTLEFS_FOR_IDF_3_2   /* For old IDF - like in release 1.0.4 */
 
 #include "esp_log.h"
 #include "esp_spi_flash.h"