ESP32-targz

What's Changed

• Stream expander by @bakadave in https://github.com/tobozo/ESP32-targz/pull/74

bool GzUnpacker::gzStreamExpander( Stream* sourceStream, fs::FS destFS, const char* destFile );

New Contributors

• @bakadave made their first contribution in https://github.com/tobozo/ESP32-targz/pull/74

Full Changelog: https://github.com/tobozo/ESP32-targz/compare/v1.2.2...v1.2.3

What's Changed

• Fixed compilation error with platformio when lib_ldf_mode is chain+ or deep+

What's Changed

Bugfix for pointer returned from a mismatched allocation function

What's Changed

• RP2040/Pico support
• Added GzUnpacker->noDict() to force crc-based decompression
• fix for platformio whining about missing definition for size_t
• Memory optimization/fixes for ESP8266
• CI: added ESP32 qemu to tests

Full Changelog: https://github.com/tobozo/ESP32-targz/compare/v1.1.7...v1.1.9

What's Changed

• 1.1.7 (RP2040 support) by @tobozo in https://github.com/tobozo/ESP32-targz/pull/62

What's Changed

• Added stream timeout and destByteReader
• Removed SPIFFS as default filesystem
• Fixes and tweaks for esp8266

• Fixed compilation warnings
• Renamed src/ESP32-targz-lib.h -> src/ESP32-targz-lib.hpp
• Added GzUpdateClass for ESP32 to pair integration with @vortigont's flashZ in esp32FOTA pigz/gzip upcoming support

Added tarStreamExpander upon @mc-hamster's suggestion, see #52

Fixes:

• TAR archives containing ./ as the root path failed to expand when the output folder was not the root folder
• setGzProgressCallback was ignored when using streams
• stream example was failing since arduino-esp32-core 2.0.x

Improvements:

• tarGzStreamExpander accepts an extra argument with stream size, the value can be either picked from Content-Length HTTP response header, or from file.size() when the stream source is the filesystem.
• TAR paths are cleaned up on extraction

This release fixes a bug: if there was an empty file inside .tar archive and tar health checks were enabled, unpacking would stop and return error -34 without finishing the archive.

Thanks to @JamPaul97 for reporting this (see #48).

• esp32-sdk-2.0.x compliance:
  • fs::File->name() has a new behaviour since 2.x.x
  • LittleFS is now part of the core
• esp8266-sdk-3.x.x compliance:
  • strdupa / memrchr shims
  • MD5Builder code shared with ESP32 (removed conditional macros)
• PSRAMFS support
• updated examples

• Added Include and Exclude Filter to TAR
• Added Include and Exclude Filter to tarGzExpander test
• Added gzStreamExpander
• Temporarily added gzStreamExpander as second test
• Enabled progress with gzUpdater (see #37)
• Added setPsram for ESP32 (request from @sharandac, #37)
• Added support for ramdisk
• Added dual example for gzStreamUpdater and tarGzStreamUpdater

This is a fix release (see #33) addressing an issue where a tar file containing a file with extended attributes would fail to unpack and ignore subsequent files.

Thank you @frankcohen for finding that out!

This is a maintenance release, mostly adressing error handling with uzlib and network streams.

Added tarGzStreamUpdater( Stream* stream ) support for ESP32 only, the API is also exposed for ESP8266 but untested as it makes no sense to use externally what's already provided internally by the sdk core.

tarGzStreamUpdater() will find and extract binaries from a .tar.gz archive to OTA and/or SPIFFS/LITTLEFS partitions using the UpdateClass from the ESP32 Arduino core.

The .tar.gz file should contain at least one of the binaries for the compiled application and/or the spiffs/littlefs partition.

File naming requirements

• Archive must be .tar.gz
• Application binary file name must end with ino.bin
• Spiffs binary file name must end with spiffs.bin or mklittlefs.bin

This release mostly contains fixes and memory improvements for ESP8266.

All examples have been merged into one single sketch for simplicity and integrity.

What's new

• Moved to OO syntax (+Namespaced GZ and TAR)
• Updated documentation and examples
• Added complete test suite for both ESP32 and ESP8266 (see Test_tar_gz_tgz.ino)
• Implemented tarGzStreamExpander + gzStreamUpdater for ESP32
• Improved ESP8266 Support (bugfixes and performances)

• Fixes #16 for ESP8266
• Implements #18 gzStreamUpdater for ESP32 platform, see Update_from_gz_stream from the examples folder
• Output and progress log functions are temporarily inconsistent across platforms

    gzStreamUpdater( stream, streamsize );

New decompression modes:

tarGzExpander

It is no longer required to use an intermediate file with tarGzExpander.

// this will use an intermediate file (defaulting to /tmp/tmp.tar)
tarGzExpander(tarGzFS, "/blah.tat.gz", tarGzFS, "/tmp" );

// this will use an intermediate file too
tarGzExpander(tarGzFS, "/blah.tat.gz", tarGzFS, "/tmp", "/tmp/my_temporary_file.tar" ); 

// this will do a direct gz->tar->filesystem expanding, using no intermediate file
tarGzExpander(tarGzFS, fileJustBigEnoughForSPIFFS, tarGzFS, "/tmp", nullptr );

New features in this release:

• Silent mode using callbacks for progress and log
• Better error handling and reporting