Add OTA support for ESP32 boards

Author: pennam

src/AIoTC_Config.h

@@ -108,7 +108,11 @@
   #define OTA_STORAGE_PORTENTA_QSPI   (0)
 #endif
 
-#if (OTA_STORAGE_SFU || OTA_STORAGE_SSU || OTA_STORAGE_SNU || OTA_STORAGE_PORTENTA_QSPI) && !defined(ARDUINO_AVR_UNO_WIFI_REV2)
+#if defined(ARDUINO_ARCH_ESP32)
+  #define OTA_STORAGE_ESP         (1)
+#endif
+
+#if (OTA_STORAGE_SFU || OTA_STORAGE_SSU || OTA_STORAGE_SNU || OTA_STORAGE_PORTENTA_QSPI || OTA_STORAGE_ESP) && !defined(ARDUINO_AVR_UNO_WIFI_REV2)
   #define OTA_ENABLED             (1)
 #else
   #define OTA_ENABLED             (0)

src/ArduinoIoTCloudTCP.cpp

@@ -44,14 +44,27 @@
 #  include <WiFi.h>
 #endif
 
-#include "utility/ota/OTA.h"
+#if defined (ARDUINO_ARCH_ESP32) && OTA_ENABLED
+#  include "tls/utility/SHA256.h"
+#include "esp_spi_flash.h"
+#include "esp_ota_ops.h"
+#include "esp_image_format.h"
+#endif
+
+#if defined (ARDUINO_NANO_RP2040_CONNECT) || \
+   (defined (ARDUINO_ARCH_SAMD) && OTA_ENABLED)
 #include "utility/ota/FlashSHA256.h"
+#endif
+
+#if OTA_ENABLED
+#include "utility/ota/OTA.h"
+#endif
+
 #include <algorithm>
 #include "cbor/CBOREncoder.h"
 
 #include "utility/watchdog/Watchdog.h"
 
-
 /******************************************************************************
  * EXTERN
  ******************************************************************************/
@@ -201,6 +214,9 @@ int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress,
    * 1024 bytes or 0x100'000 bytes).
    */
   String const sha256_str = FlashSHA256::calc(XIP_BASE, 0x100000);
+#elif defined(ARDUINO_ARCH_ESP32)
+# warning "Compute image SHA256"
+String const sha256_str;
 #else
 # error "No method for SHA256 checksum calculation over application image defined for this architecture."
 #endif
@@ -300,6 +316,11 @@ int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress,
   _ota_cap = true;
 #endif
 
+#if defined(ARDUINO_ARCH_ESP32) && OTA_ENABLED
+  /* NOTE: here is possible to check if current partition scheme is OTA compatible */
+  _ota_cap = true;
+#endif
+
 #ifdef BOARD_HAS_OFFLOADED_ECCX08
   if (String(WiFi.firmwareVersion()) < String("1.4.4")) {
     DEBUG_ERROR("ArduinoIoTCloudTCP::%s In order to connect to Arduino IoT Cloud, NINA firmware needs to be >= 1.4.4, current %s", __FUNCTION__, WiFi.firmwareVersion());
@@ -840,6 +861,10 @@ void ArduinoIoTCloudTCP::onOTARequest()
   bool const use_ethernet = _connection->getInterface() == NetworkAdapter::ETHERNET ? true : false;
   _ota_error = portenta_h7_onOTARequest(_ota_url.c_str(), use_ethernet);
 #endif
+
+#ifdef ARDUINO_ARCH_ESP32
+  _ota_error = esp32_onOTARequest(_ota_url.c_str());
+#endif
 }
 #endif
 

src/utility/ota/OTA-esp32.cpp

@@ -0,0 +1,67 @@
+/*
+   This file is part of ArduinoIoTCloud.
+
+   Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+
+   This software is released under the GNU General Public License version 3,
+   which covers the main part of arduino-cli.
+   The terms of this license can be found at:
+   https://www.gnu.org/licenses/gpl-3.0.en.html
+
+   You can be released from the requirements of the above licenses by purchasing
+   a commercial license. Buying such a license is mandatory if you want to modify or
+   otherwise use the software for commercial activities involving the Arduino
+   software without disclosing the source code of your own applications. To purchase
+   a commercial license, send an email to license@arduino.cc.
+*/
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include <AIoTC_Config.h>
+
+#if defined ARDUINO_ARCH_ESP32 && OTA_ENABLED
+#include "OTA.h"
+#include <Arduino_DebugUtils.h>
+#include <Arduino_ESP_OTA.h>
+
+/******************************************************************************
+ * FUNCTION DEFINITION
+ ******************************************************************************/
+
+int esp32_onOTARequest(char const * ota_url)
+{
+  Arduino_ESP32_OTA::Error ota_err = Arduino_ESP32_OTA::Error::None;
+  Arduino_ESP32_OTA ota;
+
+  /* Initialize the board for OTA handling. */
+  if ((ota_err = ota.begin()) != Arduino_ESP32_OTA::Error::None)
+  {
+    DEBUG_ERROR("Arduino_ESP32_OTA::begin() failed with %d", static_cast<int>(ota_err));
+    return static_cast<int>(ota_err);
+  }
+
+  /* Download the OTA file from the web storage location. */
+  int const ota_download = ota.download(ota_url);
+  if (ota_download <= 0)
+  {
+    DEBUG_ERROR("Arduino_ESP_OTA::download() failed with %d", ota_download);
+    return ota_download;
+  }
+  DEBUG_VERBOSE("Arduino_ESP_OTA::download() %d bytes downloaded", static_cast<int>(ota_download));
+
+  /* Verify update integrity and apply */
+  if ((ota_err = ota.update()) != Arduino_ESP32_OTA::Error::None)
+  {
+    DEBUG_ERROR("Arduino_ESP_OTA::update() failed with %d", static_cast<int>(ota_err));
+    return static_cast<int>(ota_err);
+  }
+
+  /* Perform the reset to reboot */
+  ota.reset();
+
+  return static_cast<int>(OTAError::None);
+}
+
+#endif /* ARDUINO_ARCH_ESP32 */

src/utility/ota/OTA.h

@@ -66,4 +66,8 @@ int rp2040_connect_onOTARequest(char const * ota_url);
 int portenta_h7_onOTARequest(char const * ota_url, const bool use_ethernet);
 #endif
 
+#ifdef ARDUINO_ARCH_ESP32
+int esp32_onOTARequest(char const * ota_url);
+#endif
+
 #endif /* ARDUINO_OTA_LOGIC_H_ */