iotappstory / ESP-Library

Software Distribution and Management Over the Air
GNU Lesser General Public License v2.1
124 stars 35 forks source link

Documentation Suggestion - IAS.onFirstBoot and WiFi.onEvent #105

Closed QuantusHoka closed 5 years ago

QuantusHoka commented 5 years ago

I see that there is an undocumented callback for IOTAppStory::onFirstBoot(THandlerFunction value). I am setting-up some EEPROM storage and find this callback very useful, and others may as well. I suggest adding it to the wiki.

Similarly, IOTAppStory uses the WiFi library, but does not appear to use WiFi.onEvent; please correct me if I am wrong. It might, perhaps, be useful to note that the callback is unused, and thus available for use in our applications.

Finally, I'm new to (and thus still learning) the github thing, so please let me know if there is a more appropriate way to make such suggestions.

Onno-Dirkzwager commented 5 years ago

Hi @QuantusHoka,

EDIT Just found the remaining explanation for onFirstBoot on the wiki callbacks. Title / function name is missing. "Called on the first boot of this app. Will only run once. After serial or ota upload."

Onno-Dirkzwager commented 5 years ago

@QuantusHoka I updated the Wiki: https://iotappstory.com/wiki/arduino-esp/library-api-20/api-methods/callbacks()

The onFirstBoot is on top and the Wifi.onEvent on the bottom. We will setup a dedicated Wifi page in a future update. But for now I think your suggestions have been addressed.

If you agree please close this issue!

QuantusHoka commented 5 years ago

Excellent. Thanks.