mirror of
https://github.com/m5stack/M5Stack_MicroPython.git
synced 2026-05-20 10:14:44 -07:00
mkspiffs
Tool to build and unpack SPIFFS images.
IMPORTANT - building for ESP32 esp-idf spiffs
The sdkconfig.h from your application using spiffs has to be used in build process! Before building mkspiffs, copy the sdkconfig.h from your application build/include directory to mkspiffs/include After every change to spiffs configuration rebuild mkspiffs
Usage
mkspiffs {-c <pack_dir>|-u <dest_dir>|-l|-i} [-d <0-5>] [-b <number>]
[-p <number>] [-s <number>] [--] [--version] [-h]
<image_file>
Where:
-c <pack_dir>, --create <pack_dir>
(OR required) create spiffs image from a directory
-- OR --
-u <dest_dir>, --unpack <dest_dir>
(OR required) unpack spiffs image to a directory
-- OR --
-l, --list
(OR required) list files in spiffs image
-- OR --
-i, --visualize
(OR required) visualize spiffs image
-d <0-5>, --debug <0-5>
Debug level. 0 means no debug output.
-b <number>, --block <number>
fs block size, in bytes
-p <number>, --page <number>
fs page size, in bytes
-s <number>, --size <number>
fs image size, in bytes
--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.
--version
Displays version information and exits.
-h, --help
Displays usage information and exits.
<image_file>
(required) spiffs image file
Build
You need gcc (≥4.8) or clang(≥600.0.57), and make. On Windows, use MinGW.
Run:
$ make dist
Build status
| Linux | Windows |
|---|---|
License
MIT
To do
- Add more debug output and print SPIFFS debug output
- Error handling
- Determine the image size automatically when opening a file
- Code cleanup