Adding example on how to perform OTA with the QSPI as storage method.

Author: aentinger

examples/OTA_Qspi_Flash/OTA_Qspi_Flash.ino

@@ -1,32 +1,105 @@
 /*
- This example demonstrates how to use to update
- the firmware of the Arduino Portenta H7 using
- a firmware image stored on the QSPI.
+ * This example demonstrates how to use to update the firmware of the Arduino Portenta H7 using
+ * a firmware image stored on the QSPI.
+ *
+ * Steps:
+ *   1) Create a sketch for the Portenta H7 and verifiy
+ *      that it both compiles and works on a board.
+ *   2) In the IDE select: Sketch -> Export compiled Binary.
+ *   3) Create an OTA update file utilising the tools 'lzss.py' and 'bin2ota.py' stored in
+ *      https://github.com/arduino-libraries/ArduinoIoTCloud/tree/master/extras/tools .
+ *      A) ./lzss.py --encode SKETCH.bin SKETCH.lzss
+ *      B) ./bin2ota.py PORTENTA_H7_M7 SKETCH.lzss SKETCH.ota
+ *   4) Upload the OTA file to a network reachable location, e.g. OTA_Usage_Portenta.ino.PORTENTA_H7_M7.ota
+ *      has been uploaded to: http://www.107-systems.org/ota/OTA_Usage_Portenta.ino.PORTENTA_H7_M7.ota
+ *   5) Perform an OTA update via steps outlined below.
  */
-#include "Arduino_Portenta_OTA.h"
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include <Arduino_Portenta_OTA.h>
+
+#include <WiFi.h>
+
+#include "arduino_secrets.h" 
+
+/******************************************************************************
+ * CONSTANT
+ ******************************************************************************/
+
+/* Please enter your sensitive data in the Secret tab/arduino_secrets.h */
+static char const SSID[] = SECRET_SSID;  /* your network SSID (name) */
+static char const PASS[] = SECRET_PASS;  /* your network password (use for WPA, or use as key for WEP) */
+
+static char const OTA_FILE_LOCATION[] = "http://www.107-systems.org/ota/OTA_Usage_Portenta.ino.PORTENTA_H7_M7.ota";
+
+/******************************************************************************
+ * SETUP/LOOP
+ ******************************************************************************/
 
 void setup()
 {
   Serial.begin(115200);
   while (!Serial) {}
 
-  Serial.println("*****OTA from QSPI Flash*****");
+  if (WiFi.status() == WL_NO_SHIELD)
+  {
+    Serial.println("Communication with WiFi module failed!");
+    return;
+  }
+
+  int status = WL_IDLE_STATUS;
+  while (status != WL_CONNECTED)
+  {
+    Serial.print  ("Attempting to connect to '");
+    Serial.print  (SSID);
+    Serial.println("'");
+    status = WiFi.begin(SSID, PASS);
+    delay(10000);
+  }
+  Serial.print  ("You're connected to '");
+  Serial.print  (WiFi.SSID());
+  Serial.println("'");
 
   Arduino_Portenta_OTA_QSPI ota(QSPI_FLASH_FATFS_MBR, 2);
   Arduino_Portenta_OTA::Error ota_err = Arduino_Portenta_OTA::Error::None;
 
   Serial.println("Initializing OTA storage");
   if ((ota_err = ota.begin()) != Arduino_Portenta_OTA::Error::None)
   {
-    Serial.print  ("ota.begin() failed with error code ");
+    Serial.print  ("Arduino_Portenta_OTA::begin() failed with error code ");
     Serial.println((int)ota_err);
     return;
   }
 
-  /* This function sets the precise length of update binary, in this case of OTA_Usage_Portenta.ino.PORTENTA_H7_M7.bin */
-  ota.setUpdateLen(131728);
 
-  Serial.println("Storing parameters for firmware update in bootloader accessible non-volatile memory");
+  Serial.println("Starting download to QSPI ...");
+  int const ota_download = ota.download(OTA_FILE_LOCATION);
+  if (ota_download <= 0)
+  {
+    Serial.print  ("Arduino_Portenta_OTA_QSPI::download failed with error code ");
+    Serial.println(ota_download);
+    return;
+  }
+  Serial.print  (ota_download);
+  Serial.println(" bytes stored.");
+
+
+  Serial.println("Decompressing LZSS compressed file ...");
+  int const ota_decompress = ota.decompress();
+  if (ota_decompress < 0)
+  {
+    Serial.print("Arduino_Portenta_OTA_QSPI::decompress() failed with error code");
+    Serial.println(ota_decompress);
+    return;
+  }
+  Serial.print(ota_decompress);
+  Serial.println(" bytes decompressed.");
+
+
+  Serial.println("Storing parameters for firmware update in bootloader accessible non-volatile memory ...");
   if ((ota_err = ota.update()) != Arduino_Portenta_OTA::Error::None)
   {
     Serial.print  ("ota.update() failed with error code ");
@@ -35,6 +108,7 @@ void setup()
   }
 
   Serial.println("Performing a reset after which the bootloader will update the firmware.");
+  Serial.println("Hint: Portenta H7 LED will blink Red-Blue-Green.");
   ota.reset();
 }
 

examples/OTA_Qspi_Flash/arduino_secrets.h

@@ -0,0 +1,2 @@
+#define SECRET_SSID ""
+#define SECRET_PASS ""