tobozo / ESP32-targz

🗜️ An Arduino library to unpack/uncompress tar, gz, and tar.gz files on ESP32 and ESP8266
Other
117 stars 15 forks source link

Readme document outdated #56

Closed ryanhz closed 2 years ago

ryanhz commented 2 years ago

In the readme document:

if( ! GZUnpacker->gzUpdater(tarGzFS, firmwareFile, /*don't restart after update*/false ) ) { Serial.printf("gzUpdater failed with return code #%d\n", GZUnpacker->tarGzGetError() ); }

Should be changed to

if( ! GZUnpacker->gzUpdater(tarGzFS, firmwareFile, U_FLASH, /*don't restart after update*/false ) ) { Serial.printf("gzUpdater failed with return code #%d\n", GZUnpacker->tarGzGetError() ); }

tobozo commented 2 years ago

hey thanks for pointing that out :+1:

I'm not sure ESP8266 and ESP32 use the same macros for flash/spiffs partitions though, will test that later and edit accordingly.

ryanhz commented 2 years ago

Thanks for your prompt reply. Actually it is not a micro, it is a function in GzUnpacker class: bool gzUpdater( fs::FS &sourceFS, const char* gz_filename, int partition = U_FLASH, bool restart_on_update = true );

Do you want me to make a pull request?

tobozo commented 2 years ago

Do you want me to make a pull request?

oh thanks to you I've already updated the readme, but feel free to add your own contribution and submit a PR, just make sure you use 1.1.5 as a base branch.

The spiffs partition makes the exception though, supporting both ESP32 and ESP8266 may require some aliasing

image

ryanhz commented 2 years ago

Thank you for your update and this amazing library. Closing this issue now.