SPIFFS setConfig

[LeisureLadi]

----------------------------- Delete below -----------------------------

Basic Infos

• This issue complies with the issue POLICY doc.
• I have read the documentation at readthedocs and the issue is not addressed there.
• I have tested that the issue is present in current master branch (aka latest git).
• I have searched the issue tracker for a similar issue.
• If there is a stack dump, I have decoded it.
• I have filled out all fields below.

Problem Description

Description of SPIFFS file system is wrong (https://github.com/esp8266/Arduino/blob/master/doc/filesystem.rst):

"SPIFFSConfig" has to be replaced by "FSConfig", otherwise the compiler will throw the error:

'SPIFFSConfig' was not declared in this scope

Please change the description or edit definition in FS.h

[earlephilhower]

No, that won't work and the existing example is right. The code compiles fine. Maybe you're missing a #include <FS.h> in your code? It's required to do any filesystem work:

#include <FS.h>
void setup() {
  SPIFFSConfig cfg;
  cfg.setAutoFormat(false);
  SPIFFS.setConfig(cfg);
}
void loop() {
}

gives

Sketch uses 296503 bytes (28%) of program storage space. Maximum is 1044464 bytes.
Global variables use 27528 bytes (33%) of dynamic memory, leaving 54392 bytes for local variables. Maximum is 81920 bytes.

[LeisureLadi]

No. Clean install of core 2.5.2 on Windows 7 and Arduino 1.8.9 throws this message when trying to compile your code:
`#include <FS.h>

void setup() {
SPIFFSConfig cfg;
cfg.setAutoFormat(false);
SPIFFS.setConfig(cfg);
SPIFFS.begin();

}

void loop() {
// put your main code here, to run repeatedly:

}`

Arduino: 1.8.9 (Windows 7), Board: "LOLIN(WEMOS) D1 R2 & mini, 160 MHz, Flash, Disabled, All SSL ciphers (most compatible), 4M (2M SPIFFS), v2 Lower Memory, Disabled, None, Only Sketch, 921600"
C:\Users\Ladi\Documents\Arduino\SPIFFStest\SPIFFStest.ino: In function 'void setup()':
SPIFFStest:4:1: error: 'SPIFFSConfig' was not declared in this scope
SPIFFSConfig cfg;
^
C:\Users\Ladi\Documents\Arduino\SPIFFStest\SPIFFStest.ino:4:1: note: suggested alternative:
In file included from C:\Users\Ladi\Documents\Arduino\SPIFFStest\SPIFFStest.ino:1:0:
C:\Users\Ladi\AppData\Local\Arduino15\packages\esp8266\hardware\esp8266\2.5.2\cores\esp8266/FS.h:167:7: note: 'fs::SPIFFSConfig'

class SPIFFSConfig : public FSConfig
^
SPIFFStest:4:14: error: expected ';' before 'cfg'
SPIFFSConfig cfg;
^

SPIFFStest:5:1: error: 'cfg' was not declared in this scope

cfg.setAutoFormat(false);
^

exit status 1
'SPIFFSConfig' was not declared in this scope

However, replacing SPIFFSConfig with FSConfig, compiles well. Anyway, I hope this is going to help others running into the same issue.

[earlephilhower]

Very odd. I will try a 2.5.2 clean install. In any case, the current GIT head is fine.

The problem with passing in a FSConfig is that it doesn't have the right header and I believe the code will return an error and ignore any settings therein.

So, unfortunately, your suggestion will compile fine but won't actually work.

I'll update after I get the 2.5.2 toolchain installed/tested.

[earlephilhower]

Yup, you're right that the 2.5.2 release has a bug but it's not that it doesn't define SPIFFSConfig, its that it doesn't have a using fs::SPIFFSConfig; in <FS.h>

The correct solution, on 2.5.2 only, is to use fs::SPIFFSConfig cfg instead. Only that change will work properly.

GIT head is fine, so this has already been fixed. Don't pass in a FSConfig. It will compile, but if you check the return code you will find that it returns false and fails. Only use fs::SPIFFSConfig.

#include <FS.h>
void setup() {
  fs::SPIFFSConfig cfg;
  cfg.setAutoFormat(false);
  SPIFFS.setConfig(cfg);
}
void loop() {
}

[earlephilhower]

Actually, darn it, GIT head also seems wonky. Good catch and thanks for following up!