Add hook for OTA confirmation

Author: facchinm

src/ArduinoIoTCloudTCP.cpp

@@ -511,14 +511,16 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_Connected()
 
     if (_ota_req)
     {
-      /* Clear the error flag. */
-      _ota_error = static_cast<int>(OTAError::None);
-      /* Transmit the cleared error flag to the cloud. */
-      sendPropertiesToCloud();
-      /* Clear the request flag. */
-      _ota_req = false;
-      /* Call member function to handle OTA request. */
-      onOTARequest();
+      if (_automatic_ota || (_get_ota_confirmation != nullptr && _get_ota_confirmation())) {
+        /* Clear the error flag. */
+        _ota_error = static_cast<int>(OTAError::None);
+        /* Transmit the cleared error flag to the cloud. */
+        sendPropertiesToCloud();
+        /* Clear the request flag. */
+        _ota_req = false;
+        /* Call member function to handle OTA request. */
+        onOTARequest();
+      }
     }
 #endif /* OTA_ENABLED */
 

src/ArduinoIoTCloudTCP.h

@@ -49,6 +49,8 @@ static uint16_t const DEFAULT_BROKER_PORT_SECURE_AUTH = 8883;
 static char const DEFAULT_BROKER_ADDRESS_USER_PASS_AUTH[] = "mqtts-up.iot.arduino.cc";
 static uint16_t const DEFAULT_BROKER_PORT_USER_PASS_AUTH = 8884;
 
+typedef bool (*otaConfirmationStatus)(void);
+
 /******************************************************************************
  * CLASS DECLARATION
  ******************************************************************************/
@@ -80,6 +82,15 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     inline String   getBrokerAddress() const { return _brokerAddress; }
     inline uint16_t getBrokerPort   () const { return _brokerPort; }
 
+#if OTA_ENABLED
+    /* The callback is triggered when the OTA is initiated and it gets executed until _ota_req flag is cleared.
+     * It should return true when the OTA can be applied or false otherwise.
+     */
+    void onOTARequestCb(otaConfirmationStatus cb) {
+      _get_ota_confirmation = cb;
+      _automatic_ota = false;
+    }
+#endif
 
   private:
     static const int MQTT_TRANSMIT_BUFFER_SIZE = 256;
@@ -130,6 +141,7 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     String _ota_img_sha256;
     String _ota_url;
     bool _ota_req;
+    bool _automatic_ota = true;
 #endif /* OTA_ENABLED */
 
     inline String getTopic_shadowout() { return ( getThingId().length() == 0) ? String("")                            : String("/a/t/" + getThingId() + "/shadow/o"); }
@@ -153,6 +165,8 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
 #if OTA_ENABLED
     void onOTARequest();
 #endif
+
+    otaConfirmationStatus _get_ota_confirmation = {nullptr};
 };
 
 /******************************************************************************