Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for Updater/etc. explaining how to use gzip uploads #6923

Closed
earlephilhower opened this issue Dec 18, 2019 · 6 comments · Fixed by #6924
Closed

Update docs for Updater/etc. explaining how to use gzip uploads #6923

earlephilhower opened this issue Dec 18, 2019 · 6 comments · Fixed by #6924
Milestone

Comments

@earlephilhower
Copy link
Collaborator

#6820 was merged w/o docs to allow @ChocolateFrogsNuts to do his magic on combining the XMC flash patch into eboot without delay, but lacked specific documentation updates.

Documentation the capabilities and process eboot now uses.

@earlephilhower earlephilhower added this to the 2.7.0 milestone Dec 18, 2019
@TD-er
Copy link
Contributor

TD-er commented Dec 18, 2019

The active sketch should have support for gzipped files right?
Or is the newly flashed sketch executed?

@earlephilhower
Copy link
Collaborator Author

Yes. If you try to upload a GZ sketch to the old updater.cpp, it will disallow it as an invalid app and the eboot present in flash won't understand it, either. You need one uncompressed upload compiled with the new updater.cpp and then you can just send .GZs up. Or, if using direct serial upload (esptool.py), then a simple compile and upload will get the new eboot compressed support.

@TD-er
Copy link
Contributor

TD-er commented Dec 18, 2019

Good to know, so I will make a new version of our 2-step OTA image including this.
One GZip'ed and one raw .bin.

@earlephilhower
Copy link
Collaborator Author

Per @pfalcon:

If you give credit to me, please give credit to the original authors too, from uzlib's README:

uzlib is based on:
tinf library by Joergen Ibsen (Deflate decompression)
Deflate Static Huffman tree routines by Simon Tatham
LZ77 compressor by Paul Sokolovsky

Library integrated and maintained by Paul Sokolovsky.

I guess the same wording as above for LittleFS would work, i.e. "uzlib library written by Joergen Ibsen, Simon Tatham, Paul Sokolovsky, licensed under the ZLib license". (That may be not entirely formally correct, but if Joergen or Simon will ever object claim that they wrote that lib, could be rewritten with "based on code by".)

@earlephilhower
Copy link
Collaborator Author

@AdrianEddy found a bug in the format string setup.

"0' is not '\0', is this intentional?

earlephilhower added a commit to earlephilhower/Arduino that referenced this issue Dec 19, 2019
Fixes esp8266#6923

Documents the user steps needed to do a compressed upload, and notes the
2-step process needed for deploying compressed uploads to the field for
the first time.

Fixes a bug in serial output formatting discovered by @AdrianEddy.

Adds additional contributors for uzlib, per @pfalcon.
earlephilhower added a commit that referenced this issue Dec 20, 2019
* Add documentation for compressed OTA, fix bug

Fixes #6923

Documents the user steps needed to do a compressed upload, and notes the
2-step process needed for deploying compressed uploads to the field for
the first time.

Fixes a bug in serial output formatting discovered by @AdrianEddy.

Adds additional contributors for uzlib, per @pfalcon.

* Update README for esptool.py, too
@HenkV74
Copy link

HenkV74 commented Dec 21, 2019

Is it correct that this does not work for the spiffs partition? Would be great as 2mb becomes 60kb after zip.

edit:

on a second thought I could simply upload the files as the 2mb spiff upload is really not done in difficult wifi-areas.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants