SWUpdate library to be used with RPC.
Fork of SWUpdate by
Diff: SWUpdate.h
- Revision:
- 13:cf76c2bd3dfc
- Parent:
- 12:f1fdf8cabbc4
- Child:
- 14:0e012d53c6df
diff -r f1fdf8cabbc4 -r cf76c2bd3dfc SWUpdate.h --- a/SWUpdate.h Sat Jun 21 19:34:31 2014 +0000 +++ b/SWUpdate.h Sat Jun 21 19:39:27 2014 +0000 @@ -62,6 +62,8 @@ /// This example also assumes that you have a need to maintain two separate /// applications, one for each hardware version. /// +/// Creating the Version and Integrity Check data: +/// /// You can create the server "myprog.txt" file with this perl script (not /// every detail is shown, but it should be easy to figure out). /// @code @@ -147,7 +149,9 @@ /// @param url is a pointer to a text string of the url from which to download. /// @param name is the base filename of the binary file. /// @param action determines whether to automatically reboot to activate the new bin. -/// @return true if the update succeeded (and the reboot was set to DEFER_REBOOT). +/// @return SWUpdate_T code indicating if the update succeeded, otherwise it returns a bitmask +/// of failure flags. Also, note that if it succeeded, and it was set for AUTO_REBOOT +/// that it will not return from this function. /// SWUpdate_T SoftwareUpdate(const char *url, const char * name, Reboot_T action = AUTO_REBOOT);