TCP: add begin method to configure clients without ConnectionHandler

Author: pennam

src/ArduinoIoTCloudLPWAN.cpp

@@ -70,7 +70,7 @@ int ArduinoIoTCloudLPWAN::begin(ConnectionHandler& connection, bool retry)
 {
   _connection = &connection;
   _retryEnable = retry;
-  _time_service.begin(nullptr);
+  _time_service.begin();
   return 1;
 }
 

src/ArduinoIoTCloudTCP.cpp

@@ -80,63 +80,29 @@ ArduinoIoTCloudTCP::ArduinoIoTCloudTCP()
  * PUBLIC MEMBER FUNCTIONS
  ******************************************************************************/
 
-int ArduinoIoTCloudTCP::begin(ConnectionHandler & connection, bool const enableWatchdog, String brokerAddress, uint16_t brokerPort, bool autoReconnect)
+int ArduinoIoTCloudTCP::begin(ConnectionHandler& connection, bool const enableWatchdog, String brokerAddress, uint16_t brokerPort, bool autoReconnect)
 {
   _connection = &connection;
-  _brokerAddress = brokerAddress;
-
-  _authMode = ArduinoIoTAuthenticationMode::CERTIFICATE;
-#if defined (BOARD_HAS_SECRET_KEY)
-  /* If board supports and sketch is configured for username and password login */
-  if(_password.length()) {
-    _authMode = ArduinoIoTAuthenticationMode::PASSWORD;
-  }
+#if OTA_ENABLED
+  return begin(_connection->getClient(), TLSClientOta::getNewClient(_connection->getInterface()), _connection->getUDP(), enableWatchdog, brokerAddress, brokerPort, autoReconnect);
+#else
+  return begin(_connection->getClient(), _connection->getUDP(), enableWatchdog, brokerAddress, brokerPort, autoReconnect);
 #endif
+}
 
-  /* If board is configured for certificate authentication and mTLS */
-  if(_authMode == ArduinoIoTAuthenticationMode::CERTIFICATE)
-  {
-#if defined(BOARD_HAS_SECURE_ELEMENT)
-    if (!_selement.begin())
-    {
-      DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not initialize secure element.", __FUNCTION__);
-  #if defined(ARDUINO_UNOWIFIR4)
-      if (String(WiFi.firmwareVersion()) < String("0.4.1")) {
-        DEBUG_ERROR("ArduinoIoTCloudTCP::%s In order to read device certificate, WiFi firmware needs to be >= 0.4.1, current %s", __FUNCTION__, WiFi.firmwareVersion());
-      }
-  #endif
-      return 0;
-    }
-    if (!SElementArduinoCloudDeviceId::read(_selement, getDeviceId(), SElementArduinoCloudSlot::DeviceId))
-    {
-      DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not read device id.", __FUNCTION__);
-      return 0;
-    }
-    if (!_writeCertOnConnect) {
-      /* No update pending read certificate stored in secure element */
-      if (!SElementArduinoCloudCertificate::read(_selement, _cert, SElementArduinoCloudSlot::CompressedCertificate))
-      {
-        DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not read device certificate.", __FUNCTION__);
-        return 0;
-      }
-    }
-  #if !defined(BOARD_HAS_OFFLOADED_ECCX08)
-    _brokerTLSClient.setEccSlot(static_cast<int>(SElementArduinoCloudSlot::Key), _cert.bytes(), _cert.length());
-    #if  OTA_ENABLED
-    _otaTLSClient.setEccSlot(static_cast<int>(SElementArduinoCloudSlot::Key), _cert.bytes(), _cert.length());
-    #endif
-  #endif
-    _brokerPort = (brokerPort == DEFAULT_BROKER_PORT_AUTO) ? DEFAULT_BROKER_PORT_SECURE_AUTH : brokerPort;
+int ArduinoIoTCloudTCP::begin(Client& brokerClient, Client& otaClient, UDP& ntpClient, bool const enableWatchdog, String brokerAddress, uint16_t brokerPort, bool autoReconnect)
+{
+#if OTA_ENABLED
+  _otaClient = &otaClient;
 #endif
-  }
-  else
-  {
-    _brokerPort = (brokerPort == DEFAULT_BROKER_PORT_AUTO) ? DEFAULT_BROKER_PORT_USER_PASS_AUTH : brokerPort;
-  }
+  return begin(brokerClient, ntpClient, enableWatchdog, brokerAddress, _brokerPort, autoReconnect);
+}
 
-  /* Setup retry timers */
-  _connection_attempt.begin(AIOT_CONFIG_RECONNECTION_RETRY_DELAY_ms, AIOT_CONFIG_MAX_RECONNECTION_RETRY_DELAY_ms);
-  return begin(enableWatchdog, _brokerAddress, _brokerPort, autoReconnect);
+int ArduinoIoTCloudTCP::begin(Client& brokerClient, UDP& ntpClient, bool const enableWatchdog, String brokerAddress, uint16_t brokerPort, bool autoReconnect)
+{
+  _brokerClient = &brokerClient;
+  _ntpClient = &ntpClient;
+  return begin(enableWatchdog, brokerAddress, brokerPort, autoReconnect);
 }
 
 void ArduinoIoTCloudTCP::update()
@@ -175,18 +141,21 @@ void ArduinoIoTCloudTCP::update()
   /* Poll the network configurator to check if it is updating the configuration.
    * The polling must be performed only if the the first configuration is completed.
    */
-  #if NETWORK_CONFIGURATOR_ENABLED
+#if NETWORK_CONFIGURATOR_ENABLED
   if(_configurator != nullptr && _state > State::Init && _configurator->update() == NetworkConfiguratorStates::UPDATING_CONFIG){
     _state = State::ConfigPhy;
   }
-  #endif
+#endif
 
 #if OTA_ENABLED
   /* OTA FSM needs to reach the Idle state before being able to run independently from
    * the mqttClient. The state can be reached only after the mqttClient is connected to
    * the broker.
+   *
+   * We also have to check that the OTA client is not null. It can happen if we don't
+   * use the ArduinoConnectionHandler library and the user doesn't provide it.
    */
-  if(_state <= State::ConnectPhy){
+  if ((_state <= State::ConnectPhy) || (_otaClient == nullptr)) {
     return;
   }
 
@@ -238,11 +207,61 @@ void ArduinoIoTCloudTCP::disconnect() {
 
 int ArduinoIoTCloudTCP::begin(bool const enableWatchdog, String brokerAddress, uint16_t brokerPort, bool autoReconnect)
 {
+  _authMode = ArduinoIoTAuthenticationMode::CERTIFICATE;
+#if defined (BOARD_HAS_SECRET_KEY)
+  /* If board supports and sketch is configured for username and password login */
+  if(_password.length()) {
+    _authMode = ArduinoIoTAuthenticationMode::PASSWORD;
+  }
+#endif
+
+  /* If board is configured for certificate authentication and mTLS */
+  if(_authMode == ArduinoIoTAuthenticationMode::CERTIFICATE)
+  {
+#if defined(BOARD_HAS_SECURE_ELEMENT)
+    if (!_selement.begin())
+    {
+      DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not initialize secure element.", __FUNCTION__);
+  #if defined(ARDUINO_UNOWIFIR4)
+      if (String(WiFi.firmwareVersion()) < String("0.4.1")) {
+        DEBUG_ERROR("ArduinoIoTCloudTCP::%s In order to read device certificate, WiFi firmware needs to be >= 0.4.1, current %s", __FUNCTION__, WiFi.firmwareVersion());
+      }
+  #endif
+      return 0;
+    }
+    if (!SElementArduinoCloudDeviceId::read(_selement, getDeviceId(), SElementArduinoCloudSlot::DeviceId))
+    {
+      DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not read device id.", __FUNCTION__);
+      return 0;
+    }
+    if (!_writeCertOnConnect) {
+      /* No update pending read certificate stored in secure element */
+      if (!SElementArduinoCloudCertificate::read(_selement, _cert, SElementArduinoCloudSlot::CompressedCertificate))
+      {
+        DEBUG_ERROR("ArduinoIoTCloudTCP::%s could not read device certificate.", __FUNCTION__);
+        return 0;
+      }
+    }
+  #if !defined(BOARD_HAS_OFFLOADED_ECCX08)
+    _brokerTLSClient.setEccSlot(static_cast<int>(SElementArduinoCloudSlot::Key), _cert.bytes(), _cert.length());
+    #if  OTA_ENABLED
+    _otaTLSClient.setEccSlot(static_cast<int>(SElementArduinoCloudSlot::Key), _cert.bytes(), _cert.length());
+    #endif
+  #endif
+    _brokerPort = (brokerPort == DEFAULT_BROKER_PORT_AUTO) ? DEFAULT_BROKER_PORT_SECURE_AUTH : brokerPort;
+#endif
+  }
+  else
+  {
+    _brokerPort = (brokerPort == DEFAULT_BROKER_PORT_AUTO) ? DEFAULT_BROKER_PORT_USER_PASS_AUTH : brokerPort;
+  }
+
+  /* Setup retry timers */
+  _connection_attempt.begin(AIOT_CONFIG_RECONNECTION_RETRY_DELAY_ms, AIOT_CONFIG_MAX_RECONNECTION_RETRY_DELAY_ms);
+
   _enableWatchdog = enableWatchdog;
   _brokerAddress = brokerAddress;
-  _brokerPort = brokerPort;
   _autoReconnect = autoReconnect;
-
   _state = State::ConfigPhy;
 
   _mqttClient.setClient(_brokerTLSClient);
@@ -283,6 +302,7 @@ int ArduinoIoTCloudTCP::begin(bool const enableWatchdog, String brokerAddress, u
 #if defined (ARDUINO_UNOWIFIR4)
   if (String(WiFi.firmwareVersion()) < String("0.2.0")) {
     DEBUG_ERROR("ArduinoIoTCloudTCP::%s In order to connect to Arduino IoT Cloud, WiFi firmware needs to be >= 0.2.0, current %s", __FUNCTION__, WiFi.firmwareVersion());
+    return 0;
   }
 #endif
 
@@ -302,10 +322,10 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_ConfigPhy()
     return State::Init;
   }
 
-  if(_configurator->update() == NetworkConfiguratorStates::CONFIGURED) {
-      _configurator->disconnectAgent();
-      return State::Init;
-    }
+  if (_configurator->update() == NetworkConfiguratorStates::CONFIGURED) {
+    _configurator->disconnectAgent();
+    return State::Init;
+  }
   return State::ConfigPhy;
 #else
   return State::Init;
@@ -315,12 +335,11 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_ConfigPhy()
 ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_Init()
 {
   /* Setup broker TLS client */
-  /* Setup broker TLS client */
-  _brokerTLSClient.begin(*_connection, _authMode);
+  _brokerTLSClient.begin(_brokerClient, _authMode);
 
 #if  OTA_ENABLED
   /* Setup OTA TLS client */
-  _otaTLSClient.begin(*_connection);
+  _otaTLSClient.begin(_otaClient);
 #endif
 
   /* Setup TimeService */

src/ArduinoIoTCloudTCP.h

@@ -74,7 +74,9 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     virtual void printDebugInfo() override;
     virtual void disconnect    () override;
 
-    int begin(ConnectionHandler & connection, bool const enableWatchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS, uint16_t brokerPort = DEFAULT_BROKER_PORT_AUTO, bool autoReconnect = true);
+    int begin(ConnectionHandler& connection, bool const enableWatchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS, uint16_t brokerPort = DEFAULT_BROKER_PORT_AUTO, bool autoReconnect = true);
+    int begin(Client& brokerClient, Client& otaClient, UDP& ntpClient, bool const enableWatchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS, uint16_t brokerPort = DEFAULT_BROKER_PORT_AUTO, bool autoReconnect = true);
+    int begin(Client& brokerClient, UDP& ntpClient, bool const enableWatchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS, uint16_t brokerPort = DEFAULT_BROKER_PORT_AUTO, bool autoReconnect = true);
 
 #if defined(BOARD_HAS_SECURE_ELEMENT)
     int updateCertificate(String authorityKeyIdentifier, String serialNumber, String notBefore, String notAfter, String signature);
@@ -159,15 +161,20 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
     bool _writeCertOnConnect;
 #endif
 
+    /* Base client from sketch or ConnectionHandler */
+    Client * _brokerClient;
     TLSClientBroker _brokerTLSClient;
     MqttClient _mqttClient;
+    UDP * _ntpClient;
 
     String _messageTopicOut;
     String _messageTopicIn;
     String _dataTopicOut;
     String _dataTopicIn;
 
 #if OTA_ENABLED
+    /* Base client from sketch or ConnectionHandler */
+    Client * _otaClient;
     TLSClientOta _otaTLSClient;
     ArduinoCloudOTA _ota;
     onOTARequestCallbackFunc _get_ota_confirmation;

src/tls/utility/TLSClientBroker.cpp

@@ -31,22 +31,28 @@
 #endif
 
 
-void TLSClientBroker::begin(ConnectionHandler & connection, ArduinoIoTAuthenticationMode authMode) {
+void TLSClientBroker::begin(Client* client, ArduinoIoTAuthenticationMode authMode) {
+
+/* Client* is coming from a reference in ArduinoIoTCloud::begin( .. )
+ * The Client must be instantiated in the user sketch, for example:
+ *   WiFiClientSecure client;
+ */
 
 #if defined(BOARD_HAS_OFFLOADED_ECCX08)
   /* Arduino Root CA is configured in nina-fw
    * https://github.com/arduino/nina-fw/blob/master/arduino/libraries/ArduinoBearSSL/src/BearSSLTrustAnchors.h
    */
   (void)authMode;
+  (void)client;
 #elif defined(BOARD_HAS_ECCX08)
   (void)authMode;
-  setClient(connection.getClient());
+  setClient(*client);
   setProfile(aiotc_client_profile_init);
   setTrustAnchors(ArduinoIoTCloudTrustAnchor, ArduinoIoTCloudTrustAnchor_NUM);
   ArduinoBearSSL.onGetTime(getTime);
 #elif defined(ARDUINO_PORTENTA_C33)
   (void)authMode;
-  setClient(connection.getClient());
+  setClient(*client);
   setCACert(AIoTSSCert);
 #elif defined(ARDUINO_NICLA_VISION)
   (void)authMode;
@@ -61,7 +67,7 @@ void TLSClientBroker::begin(ConnectionHandler & connection, ArduinoIoTAuthentica
    * also present in older firmware revisions
    * https://github.com/arduino/uno-r4-wifi-usb-bridge/blob/f09ca94fdcab845b8368d4435fdac9f6999d21d2/certificates/certificates.pem#L852
    */
-  (void)connection;
+  (void)client;
   /* Temporary force CACert to add new CA without rebuilding firmware */
   if (authMode == ArduinoIoTAuthenticationMode::CERTIFICATE) {
     setCACert(AIoTSSCert);

src/tls/utility/TLSClientBroker.h

@@ -73,6 +73,6 @@ enum class ArduinoIoTAuthenticationMode
 #endif
 
 public:
-  void begin(ConnectionHandler & connection, ArduinoIoTAuthenticationMode authMode = ArduinoIoTAuthenticationMode::CERTIFICATE);
+  void begin(Client* client, ArduinoIoTAuthenticationMode authMode = ArduinoIoTAuthenticationMode::CERTIFICATE);
 
 };

src/tls/utility/TLSClientOta.cpp

@@ -30,18 +30,25 @@
   }
 #endif
 
-void TLSClientOta::begin(ConnectionHandler &connection) {
+void TLSClientOta::begin(Client* client) {
+
+/* Client* is coming from a reference in ArduinoIoTCloud::begin( .. )
+ * The Client must be instantiated in the user sketch, for example:
+ *   WiFiClientSecure client;
+ */
+
 #if defined(BOARD_HAS_OFFLOADED_ECCX08)
   /* AWS Root CAs are configured in nina-fw
    * https://github.com/arduino/nina-fw/blob/master/data/roots.pem
    */
+  (void)client;
 #elif defined(BOARD_HAS_ECCX08)
-  setClient(*getNewClient(connection.getInterface()));
+  setClient(*client);
   setProfile(aiotc_client_profile_init);
   setTrustAnchors(ArduinoIoTCloudTrustAnchor, ArduinoIoTCloudTrustAnchor_NUM);
   ArduinoBearSSL.onGetTime(getTime);
 #elif defined(ARDUINO_PORTENTA_C33)
-  setClient(*getNewClient(connection.getInterface()));
+  setClient(*client);
   setCACert(AIoTSSCert);
 #elif defined(ARDUINO_NICLA_VISION)
   appendCustomCACert(AIoTSSCert);
@@ -51,7 +58,7 @@ void TLSClientOta::begin(ConnectionHandler &connection) {
   /* AWS Root CAs are configured in uno-r4-wifi-usb-bridge/libraries/Arduino_ESP32_OTA
    * https://github.com/arduino-libraries/Arduino_ESP32_OTA/blob/fc755e7d1d3946232107e2590662ee08d6ccdec4/src/tls/amazon_root_ca.h
    */
-  (void)connection;
+  (void)client;
 #elif defined(ARDUINO_RASPBERRY_PI_PICO_W)
     setCACert(AIoTUPCert);
 #elif defined(ARDUINO_ARCH_ESP32)

src/tls/utility/TLSClientOta.h

@@ -67,37 +67,34 @@
 #endif
 
 public:
-  void begin(ConnectionHandler & connection);
+  void begin(Client* client);
 
-private:
-  inline Client* getNewClient(NetworkAdapter net) {
+  static inline Client& getNewClient(NetworkAdapter net) {
     switch(net) {
 #ifdef BOARD_HAS_WIFI
     case NetworkAdapter::WIFI:
-      return new WiFiClient();
+      return * new WiFiClient();
 #endif // BOARD_HAS_WIFI
 #ifdef BOARD_HAS_ETHERNET
     case NetworkAdapter::ETHERNET:
-      return new EthernetClient();
+      return * new EthernetClient();
 #endif // BOARD_HAS_ETHERNET
 #ifdef BOARD_HAS_NB
     case NetworkAdapter::NB:
-      return new NBClient();
+      return * new NBClient();
 #endif // BOARD_HAS_NB
 #ifdef BOARD_HAS_GSM
     case NetworkAdapter::GSM:
-      return new GSMClient();
+      return * new GSMClient();
 #endif // BOARD_HAS_GSM
 #ifdef BOARD_HAS_CATM1_NBIOT
     case NetworkAdapter::CATM1:
-      return new GSMClient();
+      return * new GSMClient();
 #endif // BOARD_HAS_CATM1_NBIOT
 #ifdef BOARD_HAS_CELLULAR
     case NetworkAdapter::CELL:
-      return new TinyGsmClient(modem, 1);
+      return * new TinyGsmClient(modem, 1);
 #endif // BOARD_HAS_CELLULAR
-    default:
-      return nullptr;
     }
   }
 };

src/utility/time/TimeService.h

@@ -59,7 +59,6 @@ class TimeServiceClass
   static bool isTimeValid(unsigned long const time);
 
 private:
-
   ConnectionHandler * _con_hdl;
   bool _is_rtc_configured;
   bool _is_tz_configured;