Skip to content

Documentation update in "OTA Update" section #1040

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

Closed
krzychb opened this issue Nov 18, 2015 · 3 comments
Closed

Documentation update in "OTA Update" section #1040

krzychb opened this issue Nov 18, 2015 · 3 comments

Comments

@krzychb
Copy link
Contributor

krzychb commented Nov 18, 2015

Documentation link: https://github.com/esp8266/Arduino/blob/master/doc/ota_updates/ota_updates.md

I am currently preparing an update for ESP8266HTTPUpdateServer class aka “Updater class” (#1024 (comment)) and found a dead link in original table of contents to “Stream Interface”.

Should “Stream Interface" be deleted from TOC or you like to keep it?

If you like to keep it, could you provide any reference to a library or code to be mentioned or included in doc?

Krzysztof

@Links2004
Copy link
Collaborator

the Stream Interface reveres to:
https://github.com/esp8266/Arduino/blob/master/cores/esp8266/Esp.cpp#L371

this function is the base for all other update modes like OTA, http Server / client.

@me-no-dev
Copy link
Collaborator

ESP8266HTTPUpdateServer != Updater Class
Updater is in the Core and deals with writing the firmware to the flash, checking it's integrity and telling the bootloader to load the new firmware on the next boot.

@krzychb
Copy link
Contributor Author

krzychb commented Nov 18, 2015

@me-no-dev - please review my original question #1024 (comment) - I was let alone, assumed something and here we are 😄
I have another OTA doc entry almost ready. I should be able to submit it later today so you can check if it is any good.

Krzysztof

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

No branches or pull requests

3 participants