Cleaning up OTA logic necessary for parsing chunked download from MQTT broker

Author: aentinger

src/ArduinoIoTCloudTCP.cpp

@@ -28,25 +28,11 @@
   #include "tls/utility/CryptoUtil.h"
 #endif
 
+#include "utility/ota/OTA.h"
 #include "utility/ota/FlashSHA256.h"
-#include "utility/ota/OTAStorage_SNU.h"
-#include "utility/ota/OTAStorage_SFU.h"
-#include "utility/ota/OTAStorage_SSU.h"
 
 #include "cbor/CBOREncoder.h"
 
-/******************************************************************************
-   GLOBAL VARIABLES
- ******************************************************************************/
-
-#if   OTA_STORAGE_SSU
-  static OTAStorage_SSU ota_storage_ssu;
-#elif OTA_STORAGE_SFU
-  static OTAStorage_SFU ota_storage_sfu;
-#elif OTA_STORAGE_SNU
-  static OTAStorage_SNU ota_storage_snu;
-#endif
-
 /******************************************************************************
    GLOBAL CONSTANTS
  ******************************************************************************/
@@ -155,28 +141,18 @@ int ArduinoIoTCloudTCP::begin(String brokerAddress, uint16_t brokerPort)
   _dataTopicIn    = getTopic_datain();
   _ota_topic_in   = getTopic_ota_in();
 
-#if   OTA_STORAGE_SSU
-  setOTAStorage(ota_storage_ssu);
-#elif OTA_STORAGE_SFU
-  setOTAStorage(ota_storage_sfu);
-#elif OTA_STORAGE_SNU
-  setOTAStorage(ota_storage_snu);
-#endif
+#if OTA_ENABLED
+  addPropertyReal(_ota_error, "OTA_ERROR", Permission::Read);
+  addPropertyReal(_ota_img_sha256, "OTA_SHA256", Permission::Read);
+  addPropertyReal(_ota_url, "OTA_URL", Permission::ReadWrite).onSync(DEVICE_WINS);
+  addPropertyReal(_ota_req, "OTA_REQ", Permission::ReadWrite).onSync(DEVICE_WINS).onUpdate(ArduinoIoTCloudTCP::on_OTA_REQ_Update);
+#endif /* OTA_ENABLED */
 
   return 1;
 }
 
 void ArduinoIoTCloudTCP::update()
 {
-#if OTA_ENABLED
-    /* If a _ota_logic object has been instantiated then we are spinning its
-     * 'update' method here in order to process incoming data and generally
-     * to transition to the OTA logic update states.
-     */
-    //OTAError const err = _ota_logic.update();
-    //_ota_error = static_cast<int>(err);
-#endif /* OTA_ENABLED */
-
   /* Run through the state machine. */
   State next_state = _state;
   switch (_state)
@@ -208,17 +184,6 @@ void ArduinoIoTCloudTCP::printDebugInfo()
   DBG_INFO("MQTT Broker: %s:%d", _brokerAddress.c_str(), _brokerPort);
 }
 
-#if OTA_ENABLED
-void ArduinoIoTCloudTCP::setOTAStorage(OTAStorage & ota_storage)
-{
-  addPropertyReal(_ota_error, "OTA_ERROR", Permission::Read);
-  addPropertyReal(_ota_img_sha256, "OTA_SHA256", Permission::Read);
-  addPropertyReal(_ota_url, "OTA_URL", Permission::ReadWrite).onSync(DEVICE_WINS);
-  addPropertyReal(_ota_req, "OTA_REQ", Permission::ReadWrite).onSync(DEVICE_WINS).onUpdate(ArduinoIoTCloudTCP::on_OTA_REQ_Update);
-  _ota_logic.setOTAStorage(ota_storage);
-}
-#endif /* OTA_ENABLED */
-
 /******************************************************************************
  * PRIVATE MEMBER FUNCTIONS
  ******************************************************************************/
@@ -372,12 +337,6 @@ void ArduinoIoTCloudTCP::handleMessage(int length)
     execCloudEventCallback(ArduinoIoTCloudEvent::SYNC);
     _state = State::Connected;
   }
-
-#if OTA_ENABLED
-  if (_ota_topic_in == topic) {
-    _ota_logic.onOTADataReceived(bytes, length);
-  }
-#endif /* OTA_ENABLED */
 }
 
 void ArduinoIoTCloudTCP::sendPropertiesToCloud()

src/ArduinoIoTCloudTCP.h

@@ -35,11 +35,6 @@
 
 #include <ArduinoMqttClient.h>
 
-#if OTA_ENABLED
-  #include "utility/ota/OTALogic.h"
-  #include "utility/ota/OTAStorage.h"
-#endif /* OTA_ENABLED */
-
 /******************************************************************************
    CONSTANTS
  ******************************************************************************/
@@ -80,10 +75,6 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     inline String   getBrokerAddress() const { return _brokerAddress; }
     inline uint16_t getBrokerPort   () const { return _brokerPort; }
 
-#if OTA_ENABLED
-    void setOTAStorage(OTAStorage & ota_storage);
-#endif /* OTA_ENABLED */
-
 
   private:
     static const int MQTT_TRANSMIT_BUFFER_SIZE = 256;
@@ -127,7 +118,6 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     String _ota_topic_in;
 
 #if OTA_ENABLED
-    OTALogic _ota_logic;
     int _ota_error;
     String _ota_img_sha256;
     String _ota_url;

src/utility/ota/OTAStorage.h renamed to src/utility/ota/OTA.h

@@ -15,36 +15,26 @@
    a commercial license, send an email to license@arduino.cc.
 */
 
-#ifndef ARDUINO_OTA_STORAGE_H_
-#define ARDUINO_OTA_STORAGE_H_
+#ifndef ARDUINO_OTA_LOGIC_H_
+#define ARDUINO_OTA_LOGIC_H_
 
 /******************************************************************************
  * INCLUDE
  ******************************************************************************/
 
-#include <stdlib.h>
-#include <stdint.h>
-#include <stdbool.h>
+#include <AIoTC_Config.h>
+#if OTA_ENABLED
 
 /******************************************************************************
- * CLASS DECLARATION
+ * TYPEDEF
  ******************************************************************************/
 
-class OTAStorage
+enum class OTAError : int
 {
-public:
-
-  virtual ~OTAStorage() { }
-
-
-  virtual bool   init  () = 0;
-  virtual bool   open  () = 0;
-  virtual size_t write (uint8_t const * const buf, size_t const num_bytes) = 0;
-  virtual void   close () = 0;
-  virtual void   remove() = 0;
-  virtual bool   rename() = 0;
-  virtual void   deinit() = 0;
-
+  None           = 0,
+  DownloadFailed = 1,
 };
 
-#endif /* ARDUINO_OTA_STORAGE_H_ */
+#endif /* OTA_ENABLED */
+
+#endif /* ARDUINO_OTA_LOGIC_H_ */