esp-idf/examples/storage
Adam Múdry e2da3a4259 fix(examples): Disable formatting SD cards in storage examples by default 2024-02-07 13:40:40 +01:00
..
custom_flash_driver feat(storage): update config for app tests 2023-10-27 10:07:31 +02:00
emmc sdmmc: in/out phase adapted to esp32 and esp32s3 2023-04-14 18:18:54 +08:00
ext_flash_fatfs feat(fatfs): Add an option to use 2 FATs (file allocation tables) in FATFS volumes 2024-01-18 14:03:28 +01:00
fatfsgen feat(fatfs): Add an option to use 2 FATs (file allocation tables) in FATFS volumes 2024-01-18 14:03:28 +01:00
littlefs feat: LittleFS bump version to 1.13.0 2024-01-15 13:15:24 +01:00
nvs_rw_blob feat(storage): minimize platforms for tests 2023-11-06 07:41:36 +01:00
nvs_rw_value feat(storage): minimize platforms for tests 2023-11-06 07:41:36 +01:00
nvs_rw_value_cxx feat(storage): minimize platforms for tests 2023-11-06 07:41:36 +01:00
nvsgen feat(storage): update config for app tests 2023-10-27 10:07:31 +02:00
partition_api feat(storage): update config for app tests 2023-10-27 10:07:31 +02:00
parttool feat(storage): update config for app tests 2023-10-27 10:07:31 +02:00
perf_benchmark feat(storage): update config for app tests 2023-10-27 10:07:31 +02:00
sd_card fix(examples): Disable formatting SD cards in storage examples by default 2024-02-07 13:40:40 +01:00
semihost_vfs ci(semihost_vfs): fixed test case failing due to shell quote issues 2024-01-16 13:27:51 +08:00
spiffs feat(storage): minimize platforms for tests 2023-11-06 07:41:36 +01:00
spiffsgen feat(storage): update config for app tests 2023-10-27 10:07:31 +02:00
wear_levelling feat(fatfs): Add an option to use 2 FATs (file allocation tables) in FATFS volumes 2024-01-18 14:03:28 +01:00
.build-test-rules.yml refactor(sdspi): place sdspi driver into a new component 2023-11-20 12:30:03 +08:00
README.md fix(sd_card): update sd_card troubleshooting notes in readme.md 2023-10-25 11:19:08 +02:00

README.md

Storage Examples

Storage and management of user and system data in modules flash and on external memory / devices. This directory contains a range of examples ESP-IDF projects. These are intended to demonstrate the storage features, and to provide code that you can copy and adapt into your own projects.

Example Layout

The examples are grouped into sub-directories by category. Each category directory contains one or more example projects:

  • custom_flash_driver example demonstrates how to implement your own flash chip driver by overriding the default driver.
  • emmc example demonstrates how to use an eMMC chip with an ESP device.
  • ext_flash_fatfs example demonstrates how to use FATFS partition with external SPI FLASH chip.
  • fatfsgen example demonstrates how to use FATFS partition
  • nvs_rw_blob example demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP module restarts.
  • nvs_rw_value example demonstrates how to read and write a single integer value using NVS.
  • nvs_rw_value_cxx example demonstrates how to read and write a single integer value using NVS (it uses the C++ NVS handle API).
  • partition_api examples demonstrate how to use different partition APIs.
  • parttool example demonstrates common operations the partitions tool allows the user to perform.
  • sd_card examples demonstrate how to use an SD card with an ESP device.
  • semihost_vfs example demonstrates how to use semihosting VFS driver with ESP device.
  • spiffs example demonstrates how to use SPIFFS with ESP device.
  • spiffsgen example demonstrates how to use the SPIFFS image generation tool spiffsgen.py to automatically create a SPIFFS.
  • wear_levelling example demonstrates how to use wear levelling library and FATFS library to store files in a partition inside SPI flash.

More

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