mirror of
https://github.com/esp8266/Arduino.git
synced 2025-08-20 05:03:14 +03:00
b1da9eda46
* Add a FAT filesystem for SD cards to Arduino FS
Arduino forked a copy of SD lib several years ago, put their own wrapper
around it, and it's been languishing in our ESP8266 libraries ever since
as SD. It doesn't support long file names, has class names which
conflict with the ESP8266 internal names, and hasn't been updated in
ages.
The original author of the SD library has continued work in the
meantime, and produced a very feature rich implementation of SdFat. It
unfortunately also conflicts with the class names we use in ESP8266
Arduino and has a different API than the internal SPIFFS or proposed
LittleFS filesystem objects.
This PR puts a wrapper around the latest and greatest SdFat library,
by forking it and wrapping its classes in a private namespace "sdfat,"
and making as thin a wrapper as possible around it to conform to
the ESP8266 FS, File, and Dir classes.
This PR also removes the Arduino SD.h class library and rewrites it
using the new SDFS filesystem to make everything in the ESP8266
Arduino core compatible with each other.
By doing so it lets us use a single interface for anything needing a
file instead of multiple ones (see SDWebServer and how a different
object is needed vs. one serving from SPIFFS even though the logic is
all the same). Same for BearSSL's CertStores and probably a few others
I've missed, cleaning up our code base significantly.
Like LittleFS, silently create directories when a file is created with
a subdirectory specifier ("/path/to/file.txt") if they do not yet exist.
Adds a blacklist of sketches to skip in the CI process (because SdFat
has many examples which do not build properly on the ESP8266).
Now that LittleFS and SDFS have directory support, the FS needs to be
able to communicate whether a name is one or the other. Add a simple
bool FS::isDirectory() and bool FS::isFile() method. SPIFFS doesn't
have directories, so if it's valid it's a file and reported as such.
Add ::mkdir/::rmdir to the FS class to allow users to make and destroy
subdirectories. SPIFFS directory operations will, of course, fail
and return false.
Emulate a 16MB SD card and allow test runner to exercise it by using
a custom SdFat HOST_MOCK-enabled object.
Throw out the original Arduino SD.h class and rewrite from scratch using
only the ESP8266 native SDFS calls. This makes "SD" based applications
compatible with normal ESP8266 "File" and "FS" and "SPIFFS" operations.
The only major visible change for users is that long filenames now are
fully supported and work without any code changes. If there are static
arrays of 11 bytes for old 8.3 names in code, they will need to be
adjusted.
While it is recommended to use the more powerful SDFS class to access SD
cards, this SD.h wrapper allows for use of existing Arduino libraries
which are built to only with with that SD class.
Additional helper functions added to ESP8266 native Filesystem:: classes
to help support this portability.
The rewrite is good enough to run the original SDWebServer and SD
example code without any changes.
* Add a FSConfig and SDFSConfig param to FS.begin()
Allows for configuration values to be passed into a filesystem via the
begin method. By default, a FS will receive a nullptr and should so
whatever is appropriate.
The base FSConfig class has one parameter, _autoFormat, set by the
default constructor to true.
For SPIFFS, you can now disable auto formatting on mount failure by
passing in a FSConfig(false) object.
For SDFS a SDFSConfig parameter can be passed into config specifying the
chip select and SPI configuration. If nothing is passed in, the begin
will fail since there are no safe default values here.
* Add FS::setConfig to set FS-specific options
Add a new call, FS::setConfig(const {SDFS,SPIFFS}Config *cfg), which
takes a FS-specific configuration object and copies any special settings
on a per-FS basis. The call is only valid on unmounted filesystems, and
checks the type of object passed in matches the FS being configured.
Updates the docs and tests to utilize this new configuration method.
* Add ::truncate to File interface
Fixes #3846
* Use polledTimeout for formatting yields, cleanup
Use the new polledTimeout class to ensure a yield every 5ms while
formatting.
Add in default case handling and some debug messages when invalid inputs
specified.
* Make setConfig take const& ref, cleaner code
setConfig now can take a parameter defined directly in the call by using
a const &ref to it, leading to one less line of code to write and
cleaner reading of the code.
Also clean up SDFS implementation pointer definition.
Host Tests for Continuous Integration ------------------------------------- make FORCE32=0 OPTZ=-O0 CI (FORCE32=0: https://bugs.launchpad.net/ubuntu/+source/valgrind/+bug/948004) Sketch emulation on host ------------------------ This environment let compile esp8266/Arduino sketches into native environment. Network (tcp, udp, including ssl and multicast) is linked to local host interfaces. WiFi is trivialy emulated and reported as "just" already connected and usable. Currently network emulation is a complete rewrite of WiFiClient+WiFiServer/ClientContext and WifiUdp/UdpContext using socket posix API. Further work will optionally propose native lwIP library instead. Serial UART0 and UART1 are emulated via stdin/stdout/stderr. Therefor stdin is connected to UART0(RX) and stdout is connected to UART0(TX). UART1(TX) writes to stderr. Reading from stdin happens in non-blocking raw mode, that means each character is directly injected into the UART FIFO without any buffering in the console. The command line switch -c can be used to stop the emulation from intersepting CTRL-C (SIGINT). How to compile and run a sketch ------------------------------- All results are stored in ./bin/ . Show the core example list: make list Build one example make D=1 ../../libraries/esp8266/examples/Blink/Blink run it: ./bin/Blink/Blink -h Optional 'V=1' enables makefile verbosity Optional 'D=1' enables core debug (same as IDE's tools menu) Optional 'OPTZ=-O2' will update gcc -O option (default is -Os, D=1 implies -O0) Optional 'FORCE32=0' will use native/default gcc (default is FORCE32=1 unless gcc-multilib is not detected) Non exhaustive list of working examples: make D=1 ../../libraries/ESP8266WiFi/examples/udp/udp make D=1 ../../libraries/ESP8266WiFi/examples/WiFiClient/WiFiClient make D=1 ../../libraries/ESP8266WebServer/examples/HelloServer/HelloServer make D=1 ../../libraries/ESP8266WebServer/examples/AdvancedWebServer/AdvancedWebServer make D=1 ../../libraries/ESP8266mDNS/examples/mDNS_Web_Server/mDNS_Web_Server make D=1 ../../libraries/ESP8266WiFi/examples/BearSSL_Validation/BearSSL_Validation Compile other sketches: - library paths are specified using ULIBDIRS variable, separated by ':' - call 'make path-to-the-sketch-file' to build (without its '.ino' extension): - CAVEAT: functions must be declared *before* being called (arduino builder is not around) make D=1 ULIBDIRS=/path/to/your/arduino/libraries/lib1:/path/to/another/place/lib2 /path/to/your/sketchdir/sketch/sketch or: ULIBDIRS=/path/to/your/arduino/libraries/lib1:/path/to/another/place/lib2 make D=1 /path/to/your/sketchdir/sketch/sketch or (preferred): export ULIBDIRS=/path/to/your/arduino/libraries/lib1:/path/to/another/place/lib2 export D=1 export OPTZ=-O2 make clean make /path/to/your/sketchdir/sketch/sketch ./bin/sketch/sketch Executable location is always in bin/. Once a sketch is compiled, just run it: bin/sketch/sketch Options are available: -h -i eth0 bind servers to this interface (WIP) -l bind Multicast to the above interface (WIP) -c ignore CTRL-C (send it over serial device) -f no throttle (possibly 100%CPU) -S spiffs size in KBytes (default: 1024) (negative value will force mismatched size) TODO ---- A lot. Make fun, propose PRs. - replace some "fprintf(stderr" with redirectable log functions - spiffs in a file (done, need to initialize and check) - EEPROM in a file (partly done) - SDCARD on Host filesystem ? or in an image ? - nice curses interface to display/change gpios ? - display device emulation (like ssd1306) - optionaly use arduino-builder ? - store sketch objects and binaries outside from the source directories (done for sketches) - compile and use lwIP on host - easily debug HTTP classes - https://github.com/esp8266/Arduino/issues/1715 - gpio, currently: read as 0(digital) or 512(analog). output is printed on console.