https://github.com/wolffshots/esp32-spiffs
component to interact with a spiffs partition (flashing and creating of the partition and data needs to still be done in the parent project)
https://github.com/wolffshots/esp32-spiffs
Last synced: 2 months ago
JSON representation
component to interact with a spiffs partition (flashing and creating of the partition and data needs to still be done in the parent project)
- Host: GitHub
- URL: https://github.com/wolffshots/esp32-spiffs
- Owner: wolffshots
- License: mit
- Created: 2021-05-26T12:02:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-05T20:50:05.000Z (almost 4 years ago)
- Last Synced: 2025-02-01T19:44:37.904Z (4 months ago)
- Language: C
- Size: 141 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# esp32-component
example template for
## how to use project
1. run `git submodule add [email protected]:wolffshots/esp32-spiffs.git components/esp32-spiffs` in your main project
2. configure project if needed
3. `#include "spiffs.h"` should give you access to this component.
if the above steps don't work then you may need to run `git submodule init components/esp32-spiffs`
and then `git submodule update --remote --recursive` in your main project
## folder contents
the component **esp32-spiffs** contains three source files in C lang: [spiffs.c](spiffs.c). this file is located in root folder.
esp-idf projects are build using cmake. the project build configuration is contained in `CMakeLists.txt` files that provide set of directives and instructions describing the project's source files and targets (executable, library, or both).
below is short explanation of remaining files in the project folder.
```
├── .github directory of templates used by github
├── doc documentation path
│ ├── .gitignore ignore directive for generated docs
│ └── Doxyfile instructions for doxygen to produce documentation
├── include header file directory
│ └── spiffs.h the main header file for this component
├── .gitignore describes what files and folders git should ignore
├── CMakeLists.txt base project cmake file (describes dependencies, include dir and src dir)
├── spiffs.c core src file of the component
├── component.mk component make file
├── Kconfig.projbuild kconfig description file to add build time vars
├── LICENSE.md MIT license file
└── README.md this file
```
for more information on structure and contents of esp-idf projects, please refer to Section [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) of the esp-idf programming guide.
## license
the code in this project is licensed under the MIT license - see LICENSE for details.
# helpful commands
- `git submodule update --remote --recursive` - updates the checked out modules to the most recent commit to their main branch
see [spiffgen example](https://github.com/espressif/esp-idf/tree/master/examples/storage/spiffsgen) or [spiffs docs](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/spiffs.html) for more info