blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 01:29:21 -04:00
Code Issues Projects Releases Wiki Activity
esp-idf/examples/storage/spiffs
History
Frantisek Hrbata 1c92945f59 change(examples): switch examples to use a minimal build 
Currently, several example dependencies rely on the fact that all
registered components are added to the build, along with components
specified in common requirements. This results in longer build times
because even unused components must be built. Switch all examples to use
idf_minimal_build to compile only the components actually required by
the example.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2024-11-20 20:14:40 +01:00
..
main
change(examples): explicitly specify component dependencies for examples
2024-11-20 14:11:24 +01:00
CMakeLists.txt
change(examples): switch examples to use a minimal build
2024-11-20 20:14:40 +01:00
partitions_example.csv
Whitespace: Automated whitespace fixes (large commit)
2020-11-11 07:36:35 +00:00
pytest_spiffs_example.py
ci: fix pytest generic env markers
2024-04-03 18:10:43 +08:00
README.md
feat(esp32c61): disable unsupported build test
2024-07-16 16:06:19 +08:00
sdkconfig.ci
example_tests: Deletes usage esp32c3 ECO0 in CI (by default ECO3)
2021-09-24 13:55:07 +08:00
sdkconfig.defaults
examples: remove non-existent options from sdkconfig.defaults
2019-07-29 04:57:38 +02:00

README.md

Supported Targets ESP32 ESP32-C2 ESP32-C3 ESP32-C5 ESP32-C6 ESP32-C61 ESP32-H2 ESP32-P4 ESP32-S2 ESP32-S3

SPIFFS example

(See the README.md file in the upper level 'examples' directory for more information about examples.)

This example demonstrates how to use SPIFFS with ESP32. Example does the following steps:

  1. Use an "all-in-one" esp_vfs_spiffs_register function to:
    • initialize SPIFFS,
    • mount SPIFFS filesystem using SPIFFS library (and format, if the filesystem can not be mounted),
    • register SPIFFS filesystem in VFS, enabling C standard library and POSIX functions to be used.
  2. Create a file using fopen and write to it using fprintf.
  3. Rename the file. Before renaming, check if destination file already exists using stat function, and remove it using unlink function.
  4. Open renamed file for reading, read back the line, and print it to the terminal.

SPIFFS partition size is set in partitions_example.csv file. See Partition Tables documentation for more information.

How to use example

Hardware required

This example does not require any special hardware, and can be run on any common development board.

Configure the project

  • Open the project configuration menu (idf.py menuconfig)
  • Configure SPIFFS settings under "SPIFFS Example menu". See note about esp_spiffs_check function on SPIFFS Filesystem page.

Build and flash

Replace PORT with serial port name:

idf.py -p PORT flash monitor

(To exit the serial monitor, type Ctrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

Example output

Here is an example console output. In this case format_if_mount_failed parameter was set to true in the source code. SPIFFS was unformatted, so the initial mount has failed. SPIFFS was then formatted, and mounted again.

I (324) example: Initializing SPIFFS
W (324) SPIFFS: mount failed, -10025. formatting...
I (19414) example: Partition size: total: 896321, used: 0
I (19414) example: Opening file
I (19504) example: File written
I (19544) example: Renaming file
I (19584) example: Reading file
I (19584) example: Read from file: 'Hello World!'
I (19584) example: SPIFFS unmounted

To erase the contents of SPIFFS partition, run idf.py erase-flash command. Then upload the example again as described above.