Skip to content

Commit b51ef07

Browse files
committed
Updated README.md and added a snapshot
1 parent 97143d0 commit b51ef07

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,20 @@ and uploads the image to ESP32 flash memory.
99
- This is the default filesystem implemented in esp-32 core for /data folder
1010
- Go to Arduino IDE menu: ***Tools > Partition Scheme*** and select an entry with SPIFFS partition
1111

12+
1213
## Notes for LittleFS
1314

1415
- Same partition scheme as SPIFFS
1516
- Until implemented to esp-32 core needs extra library
1617
- See [LITTLEFS esp32 library](https://github.com/lorol/LITTLEFS) for more details
18+
- You need an additional [mklittlefs tool](https://github.com/earlephilhower/mklittlefs) . Download the [release](https://github.com/earlephilhower/mklittlefs/releases) or find it [archived at latest release here](https://github.com/lorol/arduino-esp32fs-plugin/releases )
19+
- Copy **mklittlefs[.exe]** to **/tools** folder of esp32 platform where **espota** and **esptool** (.py or.exe) tools are located
1720

1821
## Notes for FatFS
1922

2023
- Go to Arduino IDE menu: ***Tools > Partition Scheme*** and select an entry with FAT partition
24+
- You need additional binary files for Windows or Linux, thanks [@lbernstone](https://github.com/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) or take from [archived at latest release here](https://github.com/lorol/arduino-esp32fs-plugin/releases )
25+
- Copy **mkfatfs[.exe]** to **/tools** folder of esp32 platform where **espota** and **esptool** (.py or.exe) tools are located
2126
- 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
2227
- 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)
2328
>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.
@@ -26,21 +31,17 @@ if (!FFat.begin(0, "", 1)) die("Fat FS mount failed. Not enough RAM?");
2631
```
2732
- 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)
2833

29-
3034
## Installation
3135

3236
- Make sure you use one of the supported versions of Arduino IDE and have ESP32 core installed.
3337
- Download **esp32fs.zip** zipped tool from [latest release](https://github.com/lorol/arduino-esp32fs-plugin/releases)
3438
- In your Arduino sketchbook directory, create tools directory if it doesn't exist yet.
3539
- Unpack the tool into tools directory (the path will look like ```<home_dir>/Arduino/tools/ESP32FS/tool/esp32fs.jar```).
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](https://github.com/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)
38-
- Copy **mklittlefs[.exe]** and **mkfatfs[.exe]** to **/tools** folder of esp32 platform where **espota** and **esptool** (.py or.exe) tools are located
39-
- Alternatively see at [latest release](https://github.com/lorol/arduino-esp32fs-plugin/releases) for copies of archived binaries in question.
40+
- Make sure you have **mklittlefs[.exe]** and **mkfatfs[.exe]** available at **/tools** folder or in sub-folder there
41+
- See at [latest release](https://github.com/lorol/arduino-esp32fs-plugin/releases) for copies of archived binaries in question.
4042
- You can also use provided **package_esp32_index.template.json** to run **get.py** with it and download the missing binary files
4143
- Restart Arduino IDE.
4244

43-
4445
## Usage
4546

4647
- Open a sketch (or create a new one and save it).

tool.png

21.5 KB
Loading

0 commit comments

Comments
 (0)