Support check internet availability (#28)

Author: fabik111

.github/workflows/compile-examples.yml

@@ -29,16 +29,15 @@ jobs:
         # Install the NetworkConfigurator library from the repository
         - source-path: ./
         - name: Arduino_DebugUtils
-        - source-url: https://github.com/andreagilardoni/Arduino_ConnectionHandler.git
-          version: 0ca6d61eb538c5a21983e582ee1c8794442f8c75
+        - source-url: https://github.com/fabik111/Arduino_ConnectionHandler.git
+          version: 228ac355a957d60e1e06276ec12fe75598b09759
         - source-url: https://github.com/fabik111/ArduinoBLE.git
           version: 82e2a28f871e97b313846cee6d9efed8943dca53
         - source-url: https://github.com/andreagilardoni/ArduinoIoTCloud.git
           version: a4e171a058175f9615017bbf1e103663858a9610
         - name: Arduino_SecureElement
         - source-url: https://github.com/arduino-libraries/Arduino_CloudUtils.git
         - source-url: https://github.com/andreagilardoni/ArduinoStorage.git
-          version: 39f0bd138103967aaafcaa7f5c0e1e237b4ccb4d
         - name: ArduinoJson
         - source-url: https://github.com/arduino-libraries/Arduino_UniqueHWId.git
           version: 8977827eed86dbd25292f861ee8de2b19c16b3a0

src/ConfiguratorAgents/MessagesDefinitions.h

@@ -27,10 +27,10 @@ enum class StatusMessage {
   INVALID_PARAMS             = -5,
   OTHER_REQUEST_IN_EXECUTION = -6,
   INVALID_REQUEST            = -7,
+  INTERNET_NOT_AVAILABLE     = -8,
   SCAN_DISABLED_CONNECTING   = -100,
   HW_ERROR_CONN_MODULE       = -101,
-  WIFI_IDLE                  = -102,
-  WIFI_STOPPED               = -103,
+  HW_CONN_MODULE_STOPPED     = -102,
   ERROR_STORAGE_BEGIN        = -200,
   ERROR                      = -255
 };

src/NetworkConfigurator.cpp

@@ -168,10 +168,9 @@ NetworkConfiguratorClass::ConnectionResult NetworkConfiguratorClass::connectToNe
     WiFi.end();
 #endif
 #endif
-    int errorCode;
-    String errorMsg = decodeConnectionErrorMessage(connectionRes, &errorCode);
+    String errorMsg = decodeConnectionErrorMessage(connectionRes, err);
     DEBUG_INFO("Connection fail: %s", errorMsg.c_str());
-    *err = (StatusMessage)errorCode;
+
     _connectionRetryTimer.reload();
     res = ConnectionResult::FAILED;
   }
@@ -349,28 +348,30 @@ void NetworkConfiguratorClass::handleNewNetworkSettings() {
   _connectionLostStatus = false;  //reset for updating the failure reason
 }
 
-String NetworkConfiguratorClass::decodeConnectionErrorMessage(NetworkConnectionState err, int *errorCode) {
+String NetworkConfiguratorClass::decodeConnectionErrorMessage(NetworkConnectionState err, StatusMessage *errorCode) {
   switch (err) {
     case NetworkConnectionState::ERROR:
-      *errorCode = (int)StatusMessage::HW_ERROR_CONN_MODULE;
+      *errorCode = StatusMessage::HW_ERROR_CONN_MODULE;
       return "HW error";
     case NetworkConnectionState::INIT:
-      *errorCode = (int)StatusMessage::WIFI_IDLE;
-      return "Peripheral in idle";
+      //the connection handler doesn't have a state of "Fail to connect", in case of invalid credentials or
+      //missing network configuration the FSM stays on Init state so use this state to detect the fail to connect
+      *errorCode = StatusMessage::FAILED_TO_CONNECT;
+      return "Failed to connect";
     case NetworkConnectionState::CLOSED:
-      *errorCode = (int)StatusMessage::WIFI_STOPPED;
+      *errorCode = StatusMessage::HW_CONN_MODULE_STOPPED;
       return "Peripheral stopped";
     case NetworkConnectionState::DISCONNECTED:
-      *errorCode = (int)StatusMessage::DISCONNECTED;
+      *errorCode = StatusMessage::DISCONNECTED;
       return "Disconnected";
-      //the connection handler doesn't have a state of "Fail to connect", in case of invalid credentials or
-      //missing wifi network the FSM stays on Connecting state so use the connecting state to detect the fail to connect
     case NetworkConnectionState::CONNECTING:
-      *errorCode = (int)StatusMessage::FAILED_TO_CONNECT;
-      return "failed to connect";
+      //the connection handler doesn't have a state of "Internet not available", in case of it's impossible to reach internet
+      //the FSM stays on Connecting state so use this state to detect if internet is not available
+      *errorCode = StatusMessage::INTERNET_NOT_AVAILABLE;
+      return "Internet not available";
     default:
-      *errorCode = (int)StatusMessage::ERROR;
-      return "generic error";
+      *errorCode = StatusMessage::ERROR;
+      return "Generic error";
   }
 }
 

src/NetworkConfigurator.h

@@ -73,7 +73,7 @@ class NetworkConfiguratorClass {
   void handleNewNetworkSettings();
   void handleGetWiFiFWVersion();
 
-  String decodeConnectionErrorMessage(NetworkConnectionState err, int *errorCode);
+  String decodeConnectionErrorMessage(NetworkConnectionState err, StatusMessage *errorCode);
   ConnectionResult connectToNetwork(StatusMessage *err);
   ConnectionResult disconnectFromNetwork();
   bool sendStatus(StatusMessage msg);