Support multiple firmware types in a single manifest

Author: thorrak

README.md

@@ -60,6 +60,25 @@ Version information can be either a single number or a semantic version string.
 }
 ```
 
+A single JSON file can provide information on multiple firmware types by combining them together into an array. When this is loaded, the firmware manifest with a type matching the one passed to the esp32FOTA constructor will be selected:
+
+```json
+[
+   {
+      "type":"esp32-fota-http",
+      "version":"0.0.2",
+      "url":"http://192.168.0.100/fota/esp32-fota-http-2.bin",
+      "check_signature":true
+   },
+   {
+      "type":"esp32-other-hardware",
+      "version":"0.0.3",
+      "url":"http://192.168.0.100/fota/esp32-other-hardware.bin"
+   }
+]
+```
+
+
 #### Firmware types
 
 Types are used to compare with the current loaded firmware, this is used to make sure that when loaded, the device will still do the intended job.

src/esp32fota.cpp

@@ -318,13 +318,13 @@ void esp32FOTA::execOTA()
 }
 
 bool esp32FOTA::checkJSONManifest(JsonVariant JSONDocument) {
-    log_i("Payload type: %s", JSONDocument["type"].as<const char *>() );
 
     if(strcmp(JSONDocument["type"].as<const char *>(), _firmwareType.c_str()) != 0) {
+        log_i("Payload type in manifest %s doesn't match current firmware %s", JSONDocument["type"].as<const char *>(), _firmwareType.c_str() );
         log_i("Doesn't match type: %s", _firmwareType.c_str() );
         return false;  // Move to the next entry in the manifest
     }
-    log_i("Matches type: %s", _firmwareType.c_str() );
+    log_i("Payload type in manifest %s matches current firmware %s", JSONDocument["type"].as<const char *>(), _firmwareType.c_str() );
 
     semver_free(&_payloadVersion);
     if(JSONDocument["version"].is<uint16_t>()) {
@@ -393,62 +393,71 @@ bool esp32FOTA::execHTTPcheck()
         return false;  // WiFi not connected
     }
 
-        HTTPClient http;
-        WiFiClientSecure client;
-
-        if( useURL.substring( 0, 5 ) == "https" ) {
-            if (!_allow_insecure_https) {
-                // If the checkURL is https load the root-CA and connect with that
-                log_i( "Loading root_ca.pem" );
-                File root_ca_file = SPIFFS.open( "/root_ca.pem" );
-                if( !root_ca_file ) {
-                    log_e( "Could not open root_ca.pem" );
-                    return false;
-                }
-                {
-                    std::string root_ca = "";
-                    while( root_ca_file.available() ){
-                        root_ca.push_back( root_ca_file.read() );
-                    }
-                    root_ca_file.close();
-                    http.begin( useURL, root_ca.c_str() );
+    HTTPClient http;
+    WiFiClientSecure client;
+
+    if( useURL.substring( 0, 5 ) == "https" ) {
+        if (!_allow_insecure_https) {
+            // If the checkURL is https load the root-CA and connect with that
+            log_i( "Loading root_ca.pem" );
+            File root_ca_file = SPIFFS.open( "/root_ca.pem" );
+            if( !root_ca_file ) {
+                log_e( "Could not open root_ca.pem" );
+                return false;
+            }
+            {
+                std::string root_ca = "";
+                while( root_ca_file.available() ){
+                    root_ca.push_back( root_ca_file.read() );
                 }
-            } else {
-                // We're downloading from a secure port, but we don't want to validate the root cert.
-                client.setInsecure();
-                http.begin(client, useURL);
+                root_ca_file.close();
+                http.begin( useURL, root_ca.c_str() );
             }
         } else {
-            http.begin(useURL);         //Specify the URL
+            // We're downloading from a secure port, but we don't want to validate the root cert.
+            client.setInsecure();
+            http.begin(client, useURL);
         }
-        int httpCode = http.GET();  //Make the request
+    } else {
+        http.begin(useURL);         //Specify the URL
+    }
+    int httpCode = http.GET();  //Make the request
 
-        if( httpCode == HTTP_CODE_OK || httpCode == HTTP_CODE_MOVED_PERMANENTLY ) {  //Check is a file was returned
+    if( httpCode == HTTP_CODE_OK || httpCode == HTTP_CODE_MOVED_PERMANENTLY ) {  //Check is a file was returned
 
-            String payload = http.getString();
+        String payload = http.getString();
 
-            int str_len = payload.length() + 1;
-            char JSONMessage[str_len];
-            payload.toCharArray(JSONMessage, str_len);
+        int str_len = payload.length() + 1;
+        char JSONMessage[str_len];
+        payload.toCharArray(JSONMessage, str_len);
 
-            StaticJsonDocument<300> JSONDocument;  //Memory pool
-            DeserializationError err = deserializeJson(JSONDocument, JSONMessage);
+        DynamicJsonDocument JSONResult(2048);
+        DeserializationError err = deserializeJson(JSONResult, JSONMessage);
 
-            http.end();  // We're done with HTTP - free the resources
+        http.end();  // We're done with HTTP - free the resources
 
-            if (err) {  //Check for errors in parsing
-                log_e("Parsing failed");
-                return false;
-            }
+        if (err) {  //Check for errors in parsing
+            log_e("Parsing failed");
+            return false;
+        }
 
-            if(checkJSONManifest(JSONDocument.as<JsonVariant>())) {
-                return true;
+        if (JSONResult.is<JsonArray>()) {
+            // We already received an array of multiple firmware types
+            JsonArray arr = JSONResult.as<JsonArray>();
+            for (JsonVariant JSONDocument : arr) {
+                if(checkJSONManifest(JSONDocument)) {
+                    return true;
+                }
             }
-
-            return false; // We didn't get a hit against the above, return false
-        } else {
-            log_e("Error on HTTP request");
+        } else if (JSONResult.is<JsonObject>()) {
+            if(checkJSONManifest(JSONResult.as<JsonVariant>()))
+                return true;
         }
+
+        return false; // We didn't get a hit against the above, return false
+    } else {
+        log_e("Error on HTTP request");
+        http.end();
         return false;
     }
 }