You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-16
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,43 @@
1
1
# Arduino ESP32 filesystem uploader
2
2
3
-
Arduino plugin which packs sketch data folder into SPIFFS, LITTLEFS or FATFS filesystem image,
3
+
-Arduino plugin which packs sketch data folder into SPIFFS, LittleFS or FatFS filesystem image,
4
4
and uploads the image to ESP32 flash memory.
5
-
</br> You can have only of three filesystems on given Arduino project.
5
+
- You can have only one of three filesystems on same Arduino project.
6
6
7
-
## Notes for LITTLEFS
7
+
## Notes for SPIFFS
8
8
9
-
- Uses same partition scheme as SPIFFS.
10
-
- See [LITTLEFS esp32 library](https://github.com/lorol/LITTLEFS)
9
+
- This is the default filesystem implemented in esp-32 core for /data folder
10
+
- Go to Arduino IDE menu: ***Tools > Partition Scheme*** and select an entry with SPIFFS partition
11
+
12
+
## Notes for LittleFS
13
+
14
+
- Same partition scheme as SPIFFS
15
+
- Until implemented to esp-32 core needs extra library
16
+
- See [LITTLEFS esp32 library](https://github.com/lorol/LITTLEFS) for more details
11
17
12
18
## Notes for FatFS
13
19
14
-
- On Arduino IDE menu: *Tools > Partition Scheme* select one with FAT partition
15
-
- The usable size of FAT partition is reduced with 1 sector of 4096 bytes (0x1000) to resolve wear leveling space requirement. Also file is flashed with +4096 bytes (0x1000) offset of partition address csv table entry
16
-
- To flash the data folder as FAT partition by network port (uses espota), replace your esp32-core Update library with the [modified files here](https://github.com/lorol/arduino-esp32fatfs-plugin/tree/master/extra/esp32-modified-Update-lib-ffat-espota.zip)
20
+
- Go to Arduino IDE menu: ***Tools > Partition Scheme*** and select an entry with FAT partition
21
+
- The usable size of FAT partition is reduced with 1 sector of 4096 bytes (0x1000) to resolve wear leveling space requirement. The image file is flashed with +4096 bytes (0x1000) offset of partition address of csv table entry
17
22
- You may need to decrease **maxOpenFiles** at FFat.begin() of your sketch , [see this note](http://marc.merlins.org/perso/arduino/post_2019-03-30_Using-FatFS-FFat-on-ESP32-Flash-With-Arduino.html)
18
23
>The FFAT module uses 8KB plus 4KB per concurrent file that can be opened. By default, it allows 10 files to be opened, which means it uses 48KB. IF you want to reduce its memory use, you can tell it to only support one file, and you will save 36KB, leaving you with only 12KB used.
19
24
```
20
25
if (!FFat.begin(0, "", 1)) die("Fat FS mount failed. Not enough RAM?");
21
26
```
27
+
- To flash the data folder as FAT partition by **network port (uses espota)**, replace your esp32-core Update library with the [modified files here](https://github.com/lorol/arduino-esp32fatfs-plugin/tree/master/extra/esp32-modified-Update-lib-ffat-espota.zip)
28
+
22
29
23
30
## Installation
24
31
25
32
- Make sure you use one of the supported versions of Arduino IDE and have ESP32 core installed.
26
-
- Download the tool from [here](https://github.com/lorol/arduino-esp32fs-plugin/releases/download/2.0/esp32fs.zip)
33
+
- Download **esp32fs.zip** zipped tool from [latest release](https://github.com/lorol/arduino-esp32fs-plugin/releases)
27
34
- In your Arduino sketchbook directory, create tools directory if it doesn't exist yet.
28
35
- Unpack the tool into tools directory (the path will look like ```<home_dir>/Arduino/tools/ESP32FS/tool/esp32fs.jar```).
29
-
- For LITTLEFS, you need an additional [mklittlefs tool](https://github.com/earlephilhower/mklittlefs) Download the [release](https://github.com/earlephilhower/mklittlefs/releases) or see below
30
-
- For FatFS, you need additional binary files for Windows and Linux (thanks @lbernstone for compiling) or take it from the author [here - mkfatfs tool](https://github.com/labplus-cn/mkfatfs/releases/tag/v1.0) Thanks to [labplus-cn](https://github.com/labplus-cn/mkfatfs)
36
+
- For **LittleFS**, you need an additional [mklittlefs tool](https://github.com/earlephilhower/mklittlefs) Download the [release](https://github.com/earlephilhower/mklittlefs/releases) or see below
37
+
- For **FatFS**, you need additional binary files for Windows or Linux (thanks @lbernstone for compiling) or take them from the author [here - mkfatfs tool](https://github.com/labplus-cn/mkfatfs/releases/tag/v1.0) Thanks to [labplus-cn](https://github.com/labplus-cn/mkfatfs)
31
38
- Copy **mklittlefs[.exe]** and **mkfatfs[.exe]** to **/tools** folder of esp32 platform where **espota** and **esptool** (.py or.exe) tools are located
32
-
- Alternatively see [here](https://github.com/lorol/arduino-esp32fs-plugin/releases/tag/2.0) , there are copy of the binaries. You can also use **package_esp32_index.template.json** and run get.py instead
39
+
- Alternatively see at [latest release](https://github.com/lorol/arduino-esp32fs-plugin/releases) for copies of archived binaries in question.
40
+
- You can also use provided **package_esp32_index.template.json** to run **get.py** with it and download the missing binary files
33
41
- Restart Arduino IDE.
34
42
35
43
@@ -38,9 +46,10 @@ if (!FFat.begin(0, "", 1)) die("Fat FS mount failed. Not enough RAM?");
38
46
- Open a sketch (or create a new one and save it).
39
47
- Go to sketch directory (choose Sketch > Show Sketch Folder).
40
48
- Create a directory named `data` and any files you want in the file system there.
41
-
- Make sure you have selected a board, port, and closed Serial Monitor.
42
-
- Select *Tools > ESP32 Sketch Data Upload* menu item. This should start uploading the files into ESP32 flash file system.
43
-
- On drop-down list select SPIFFS, LITTLEFS or FATFS you want to make from your data folder.
49
+
- Make sure you have selected a board, port, partition scheme and closed Serial Monitor.
50
+
- Select ***Tools > ESP32 Sketch Data Upload*** menu item.
51
+
- On drop-down list, select SPIFFS, LittleFS or FatFS you want to make from your /data folder.
52
+
- Clicking OK should start uploading the files into ESP32 flash file system.
44
53
45
54
When done, IDE status bar will display the status of Image Uploaded message. Might take a few minutes for large file system sizes.
46
55
@@ -53,7 +62,7 @@ if (!FFat.begin(0, "", 1)) die("Fat FS mount failed. Not enough RAM?");
0 commit comments