add callback to HTTPUpdate (espressif#5408)

- add callback function to HTTPUpdate - update example to print httpupdate progress - fix ArduinoIDE syntax coloring Signed-off-by: Jayantajit Gogoi <jayanta.gogoi525@gmail.com>

Author: jayanta525

libraries/HTTPUpdate/examples/httpUpdate/httpUpdate.ino

@@ -36,6 +36,22 @@ void setup() {
 
 }
 
+void update_started() {
+ Serial.println("CALLBACK: HTTP update process started");
+}
+
+void update_finished() {
+ Serial.println("CALLBACK: HTTP update process finished");
+}
+
+void update_progress(int cur, int total) {
+ Serial.printf("CALLBACK: HTTP update process at %d of %d bytes...\n", cur, total);
+}
+
+void update_error(int err) {
+ Serial.printf("CALLBACK: HTTP update fatal error code %d\n", err);
+}
+
 void loop() {
  // wait for WiFi connection
  if ((WiFiMulti.run() == WL_CONNECTED)) {
@@ -50,6 +66,11 @@ void loop() {
  // value is used to put the LED on. If the LED is on with HIGH, that value should be passed
  // httpUpdate.setLedPin(LED_BUILTIN, LOW);
 
+ httpUpdate.onStart(update_started);
+ httpUpdate.onEnd(update_finished);
+ httpUpdate.onProgress(update_progress);
+ httpUpdate.onError(update_error);
+
  t_httpUpdate_return ret = httpUpdate.update(client, "http://server/file.bin");
  // Or:
  //t_httpUpdate_return ret = httpUpdate.update(client, "server", 80, "/file.bin");

libraries/HTTPUpdate/keywords.txt

@@ -1,19 +1,19 @@
 #######################################
-# Syntax Coloring Map For ESP8266httpUpdate
+# Syntax Coloring Map For HTTPUpdate
 #######################################
 
 #######################################
 # Library (KEYWORD3)
 #######################################
 
-ESP8266httpUpdateKEYWORD3	RESERVED_WORD
+ESP32httpUpdateKEYWORD3	RESERVED_WORD
 
 #######################################
 # Datatypes (KEYWORD1)
 #######################################
 
 HTTPUpdateResult	KEYWORD1	DATA_TYPE
-ESPhttpUpdateKEYWORD1	DATA_TYPE
+httpUpdateKEYWORD1	DATA_TYPE
 
 #######################################
 # Methods and Functions (KEYWORD2)

libraries/HTTPUpdate/src/HTTPUpdate.cpp

@@ -284,6 +284,10 @@ HTTPUpdateResult HTTPUpdate::handleUpdate(HTTPClient& http, const String& curren
  _lastError = HTTP_UE_TOO_LESS_SPACE;
  ret = HTTP_UPDATE_FAILED;
  } else {
+ // Warn main app we're starting up...
+ if (_cbStart) {
+ _cbStart();
+ }
 
  WiFiClient * tcp = http.getStreamPtr();
 
@@ -338,6 +342,10 @@ HTTPUpdateResult HTTPUpdate::handleUpdate(HTTPClient& http, const String& curren
  ret = HTTP_UPDATE_OK;
  log_d("Update ok\n");
  http.end();
+ // Warn main app we're all done
+ if (_cbEnd) {
+ _cbEnd();
+ }
 
  if(_rebootOnUpdate && !spiffs) {
  ESP.restart();
@@ -389,6 +397,10 @@ bool HTTPUpdate::runUpdate(Stream& in, uint32_t size, String md5, int command)
 
  StreamString error;
 
+ if (_cbProgress) {
+ Update.onProgress(_cbProgress);
+ }
+
  if(!Update.begin(size, command, _ledPin, _ledOn)) {
  _lastError = Update.getError();
  Update.printError(error);
@@ -397,6 +409,10 @@ bool HTTPUpdate::runUpdate(Stream& in, uint32_t size, String md5, int command)
  return false;
  }
 
+ if (_cbProgress) {
+ _cbProgress(0, size);
+ }
+
  if(md5.length()) {
  if(!Update.setMD5(md5.c_str())) {
  _lastError = HTTP_UE_SERVER_FAULTY_MD5;
@@ -415,6 +431,10 @@ bool HTTPUpdate::runUpdate(Stream& in, uint32_t size, String md5, int command)
  return false;
  }
 
+ if (_cbProgress) {
+ _cbProgress(size, size);
+ }
+
  if(!Update.end()) {
  _lastError = Update.getError();
  Update.printError(error);

libraries/HTTPUpdate/src/HTTPUpdate.h

@@ -52,6 +52,11 @@ enum HTTPUpdateResult {
 
 typedef HTTPUpdateResult t_httpUpdate_return; // backward compatibility
 
+using HTTPUpdateStartCB = std::function<void()>;
+using HTTPUpdateEndCB = std::function<void()>;
+using HTTPUpdateErrorCB = std::function<void(int)>;
+using HTTPUpdateProgressCB = std::function<void(int, int)>;
+
 class HTTPUpdate
 {
 public:
@@ -91,19 +96,38 @@ class HTTPUpdate
 
  t_httpUpdate_return updateSpiffs(HTTPClient &httpClient, const String &currentVersion = "");
 
+ // Notification callbacks
+ void onStart(HTTPUpdateStartCB cbOnStart) { _cbStart = cbOnStart; }
+ void onEnd(HTTPUpdateEndCB cbOnEnd) { _cbEnd = cbOnEnd; }
+ void onError(HTTPUpdateErrorCB cbOnError) { _cbError = cbOnError; }
+ void onProgress(HTTPUpdateProgressCB cbOnProgress) { _cbProgress = cbOnProgress; }
+
  int getLastError(void);
  String getLastErrorString(void);
 
 protected:
  t_httpUpdate_return handleUpdate(HTTPClient& http, const String& currentVersion, bool spiffs = false);
  bool runUpdate(Stream& in, uint32_t size, String md5, int command = U_FLASH);
 
+ // Set the error and potentially use a CB to notify the application
+ void _setLastError(int err) {
+ _lastError = err;
+ if (_cbError) {
+ _cbError(err);
+ }
+ }
  int _lastError;
  bool _rebootOnUpdate = true;
 private:
  int _httpClientTimeout;
  followRedirects_t _followRedirects;
 
+ // Callbacks
+ HTTPUpdateStartCB _cbStart;
+ HTTPUpdateEndCB _cbEnd;
+ HTTPUpdateErrorCB _cbError;
+ HTTPUpdateProgressCB _cbProgress;
+
  int _ledPin;
  uint8_t _ledOn;
 };