Add WiFi::beginNoBlock() (#2063)

Author: keever50

libraries/WiFi/src/WiFiClass.cpp

@@ -67,30 +67,11 @@ void WiFiClass::mode(WiFiMode_t m) {
     }
 }
 
-
-/*  Start WiFi connection for OPEN networks
-
-    param ssid: Pointer to the SSID string.
-*/
-int WiFiClass::begin(const char* ssid) {
-    return begin(ssid, nullptr);
-}
-
-int WiFiClass::beginBSSID(const char* ssid, const uint8_t *bssid) {
-    return begin(ssid, nullptr, bssid);
-}
-
-/*  Start WiFi connection with passphrase
-    the most secure supported mode will be automatically selected
-
-    param ssid: Pointer to the SSID string.
-    param passphrase: Passphrase. Valid characters in a passphrase
-          must be between ASCII 32-126 (decimal).
-*/
-int WiFiClass::begin(const char* ssid, const char *passphrase, const uint8_t *bssid) {
+bool WiFiClass::_beginInternal(const char* ssid, const char *passphrase, const uint8_t *bssid) {
     // Simple ESP8266 compatibility hack
     if (_modeESP == WIFI_AP) {
-        return beginAP(ssid, passphrase);
+        // When beginAP was a success, it returns WL_CONNECTED and we return true as success.
+        return beginAP(ssid, passphrase) == WL_CONNECTED;
     }
 
     end();
@@ -109,19 +90,69 @@ int WiFiClass::begin(const char* ssid, const char *passphrase, const uint8_t *bs
     _wifi.setTimeout(_timeout);
     _apMode = false;
     _wifiHWInitted = true;
-    uint32_t start = millis(); // The timeout starts from network init, not network link up
+
+    // Internal wifi.begin returns false when failed, therefore we return false as error
     if (!_wifi.begin()) {
-        return WL_IDLE_STATUS;
+        return false;
     }
     noLowPowerMode();
     // Enable CYW43 event debugging (make sure Debug Port is set)
     //cyw43_state.trace_flags = 0xffff;
+
+    return true;
+}
+
+
+/*  Start WiFi connection for OPEN networks
+
+    param ssid: Pointer to the SSID string.
+*/
+int WiFiClass::begin(const char* ssid) {
+    return begin(ssid, nullptr);
+}
+
+/*  Start WiFi connection for OPEN networks, but non blocking.
+
+    param ssid: Pointer to the SSID string.
+*/
+int WiFiClass::beginNoBlock(const char* ssid) {
+    return beginNoBlock(ssid, nullptr);
+}
+
+
+int WiFiClass::beginBSSID(const char* ssid, const uint8_t *bssid) {
+    return begin(ssid, nullptr, bssid);
+}
+
+/*  Start WiFi connection with passphrase
+    the most secure supported mode will be automatically selected
+
+    param ssid: Pointer to the SSID string.
+    param passphrase: Passphrase. Valid characters in a passphrase
+          must be between ASCII 32-126 (decimal).
+*/
+int WiFiClass::begin(const char* ssid, const char *passphrase, const uint8_t *bssid) {
+    uint32_t start = millis(); // The timeout starts from network init, not network link up
+
+    // Returns WL_IDLE_STATUS on error for compatibility.
+    if (!_beginInternal(ssid, passphrase, bssid)) {
+        return WL_IDLE_STATUS;
+    }
+
     while (!_calledESP && ((millis() - start < (uint32_t)2 * _timeout)) && !connected()) {
         delay(10);
     }
     return status();
 }
 
+int WiFiClass::beginNoBlock(const char* ssid, const char *passphrase, const uint8_t *bssid) {
+    // Returns WL_IDLE_STATUS on error for compatibility.
+    if (!_beginInternal(ssid, passphrase, bssid)) {
+        return WL_IDLE_STATUS;
+    }
+    return status();
+}
+
 uint8_t WiFiClass::beginAP(const char *ssid) {
     return beginAP(ssid, nullptr);
 }

libraries/WiFi/src/WiFiClass.h

@@ -70,6 +70,12 @@ class WiFiClass {
         param ssid: Pointer to the SSID string.
     */
     int begin(const char* ssid);
+    /*  Start WiFi connection for OPEN networks, without blocking
+
+        param ssid: Pointer to the SSID string.
+    */
+    int beginNoBlock(const char* ssid);
+
     int beginBSSID(const char* ssid, const uint8_t *bssid);
 
     /*  Start WiFi connection with WEP encryption.
@@ -92,6 +98,15 @@ class WiFiClass {
         param bssid: If non-null, the BSSID associated w/the SSID to connect to
     */
     int begin(const char* ssid, const char *passphrase, const uint8_t *bssid = nullptr);
+    /*  Start WiFi connection with passphrase, without blocking. Check for .connected() for a connection
+        the most secure supported mode will be automatically selected
+
+        param ssid: Pointer to the SSID string.
+        param passphrase: Passphrase. Valid characters in a passphrase
+              must be between ASCII 32-126 (decimal).
+        param bssid: If non-null, the BSSID associated w/the SSID to connect to
+    */
+    int beginNoBlock(const char* ssid, const char *passphrase, const uint8_t *bssid = nullptr);
 
     bool connected();
     bool isConnected() {
@@ -413,6 +428,9 @@ class WiFiClass {
     }
 
 private:
+    // Internal wifi begin. Returns true on success
+    bool _beginInternal(const char* ssid, const char *passphrase, const uint8_t *bssid = nullptr);
+
     int _timeout = 15000;
     String _ssid;
     uint8_t _bssid[6];