arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-19 23:22:16 +03:00
Code

Improve file system documentation

Browse Source
This commit is contained in:
Ivan Grokhotkov 2015-08-10 15:57:13 +03:00
parent 15fca01031
commit 208ae95979
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/reference.md
View File

@ -105,6 +105,35 @@ const char HTTP[] PROGMEM = "http:";
## File system
Even though file system is stored on the same flash chip as the program, programming new sketch will not modify file system contents. This allows to use file system to store sketch data, configuration files, or content for Web server.
The following diagram illustrates flash layout used in Arduino environment:
|--------------|-------|---------------|--|--|--|--|--|
^ ^ ^ ^ ^
Sketch OTA update File system EEPROM WiFi config (SDK)
File system size depends on the flash chip size. Depending on the board which is selected in IDE, you have the following options for flash size:
Board | Flash chip size, bytes | File system size, bytes
------|-----------------|-----------------
Generic module | 512k | 64k
Generic module | 1M | 64k, 128k, 256k, 512k
Generic module | 2M | 1M
Generic module | 4M | 3M
Adafruit HUZZAH | 4M | 3M
NodeMCU 0.9 | 4M | 3M
NodeMCU 1.0 | 4M | 3M
Olimex MOD-WIFI-ESP8266(-DEV)| 2M | 1M
SparkFun Thing | 512k | 64k
SweetPea ESP-210 | 4M | 3M
**Note:** to use any of file system functions in the sketch, add the following include to the sketch:
```c++
#include "FS.h"
```
### File system object (SPIFFS)
#### begin