Add _disconnect to other Wifi

sellensr · sellensr · commit 6201370d6f95 · 2019-12-27T12:19:20.000-05:00
also some doxygen
diff --git a/src/AdafruitIO.h b/src/AdafruitIO.h
@@ -75,6 +75,7 @@ class AdafruitIO {
 
   protected:
     virtual void _connect() = 0;
+    virtual void _disconnect() = 0;
     aio_status_t _status = AIO_IDLE;
     uint32_t _last_ping = 0;
     uint32_t _last_mqtt_connect = 0;
diff --git a/src/AdafruitIO_Definitions.h b/src/AdafruitIO_Definitions.h
@@ -76,6 +76,8 @@ class AdafruitIOGroupCallback {
 #define AIO_MQTT_CONNECTION_TIMEOUT  60000
 // Time to wait for a successful reconnection after network disconnect
 #define AIO_NET_CONNECTION_TIMEOUT  60000
+// Time to wait for a net disconnect to take effect
+#define AIO_NET_DISCONNECT_WAIT  300
 
 #define AIO_ERROR_TOPIC "/errors"
 #define AIO_THROTTLE_TOPIC "/throttle"
diff --git a/src/wifi/AdafruitIO_AIRLIFT.h b/src/wifi/AdafruitIO_AIRLIFT.h
@@ -160,8 +160,7 @@ class AdafruitIO_AIRLIFT : public AdafruitIO {
     {
       if(strlen(_ssid) != 0)
       {
-        WiFi.disconnect();
-        delay(300);
+        _disconnect();
       // setup ESP32 pins
       if (_ssPin != -1) {
           WiFi.setPins(_ssPin, _ackPin, _rstPin, _gpio0Pin, _wifi);
@@ -181,6 +180,19 @@ class AdafruitIO_AIRLIFT : public AdafruitIO {
       _status = AIO_NET_DISCONNECTED;
       }
   }
+  
+    /**************************************************************************/
+    /*!
+        @brief    Disconnect the wifi network.
+        @return   none
+    */
+    /**************************************************************************/
+    void _disconnect()
+    {
+      WiFi.disconnect();
+      delay(AIO_NET_DISCONNECT_WAIT);
+    }
+
 };
 
 #endif // ADAFRUITIO_AIRLIFT_H
diff --git a/src/wifi/AdafruitIO_ESP32.cpp b/src/wifi/AdafruitIO_ESP32.cpp
@@ -36,9 +36,7 @@ void AdafruitIO_ESP32::_connect()
 {
   if(strlen(_ssid) != 0)
   {
-    WiFi.disconnect();
-    delay(300);
-
+    _disconnect();
   delay(100);
   WiFi.begin(_ssid, _pass);
   delay(100);
@@ -47,6 +45,18 @@ void AdafruitIO_ESP32::_connect()
 
 }
 
+/**************************************************************************/
+/*!
+    @brief    Disconnect the wifi network.
+    @return   none
+*/
+/**************************************************************************/
+void AdafruitIO_ESP32::_disconnect()
+{
+  WiFi.disconnect();
+  delay(AIO_NET_DISCONNECT_WAIT);
+}
+
 aio_status_t AdafruitIO_ESP32::networkStatus()
 {
 
diff --git a/src/wifi/AdafruitIO_ESP32.h b/src/wifi/AdafruitIO_ESP32.h
@@ -35,6 +35,7 @@ class AdafruitIO_ESP32 : public AdafruitIO {
 
   protected:
     void _connect();
+    void _disconnect();
 
     const char *_ssid;
     const char *_pass;
diff --git a/src/wifi/AdafruitIO_ESP8266.cpp b/src/wifi/AdafruitIO_ESP8266.cpp
@@ -38,9 +38,7 @@ void AdafruitIO_ESP8266::_connect()
 {
   if(strlen(_ssid) != 0)
   {
-    WiFi.disconnect();
-    delay(300);
-
+    _disconnect();
   delay(100);
   WiFi.begin(_ssid, _pass);
   delay(100);
@@ -49,6 +47,18 @@ void AdafruitIO_ESP8266::_connect()
 
 }
 
+/**************************************************************************/
+/*!
+    @brief    Disconnect the wifi network.
+    @return   none
+*/
+/**************************************************************************/
+void AdafruitIO_ESP8266::_disconnect()
+{
+  WiFi.disconnect();
+  delay(AIO_NET_DISCONNECT_WAIT);
+}
+
 aio_status_t AdafruitIO_ESP8266::networkStatus()
 {
 
diff --git a/src/wifi/AdafruitIO_ESP8266.h b/src/wifi/AdafruitIO_ESP8266.h
@@ -35,6 +35,7 @@ class AdafruitIO_ESP8266 : public AdafruitIO {
 
   protected:
     void _connect();
+    void _disconnect();
 
     const char *_ssid;
     const char *_pass;
diff --git a/src/wifi/AdafruitIO_MKR1000.cpp b/src/wifi/AdafruitIO_MKR1000.cpp
@@ -37,19 +37,30 @@ void AdafruitIO_MKR1000::_connect()
 {
   if(strlen(_ssid) != 0)
   {
-    WiFi.disconnect();
-    delay(300);
-
   // no shield? bail
   if(WiFi.status() == WL_NO_SHIELD)
     return;
 
+    _disconnect();
+
   WiFi.begin(_ssid, _pass);
   _status = AIO_NET_DISCONNECTED;
   }
 
 }
 
+/**************************************************************************/
+/*!
+    @brief    Disconnect the wifi network.
+    @return   none
+*/
+/**************************************************************************/
+void AdafruitIO_MKR1000::_disconnect()
+{
+  WiFi.disconnect();
+  delay(AIO_NET_DISCONNECT_WAIT);
+}
+
 aio_status_t AdafruitIO_MKR1000::networkStatus()
 {
 
diff --git a/src/wifi/AdafruitIO_MKR1000.h b/src/wifi/AdafruitIO_MKR1000.h
@@ -36,6 +36,7 @@ class AdafruitIO_MKR1000 : public AdafruitIO {
 
   protected:
     void _connect();
+    void _disconnect();
 
     const char *_ssid;
     const char *_pass;
diff --git a/src/wifi/AdafruitIO_WICED.cpp b/src/wifi/AdafruitIO_WICED.cpp
@@ -37,13 +37,23 @@ void AdafruitIO_WICED::_connect()
 {
   if(strlen(_ssid) != 0)
   {
-    Feather.disconnect();
-    delay(300);
-
+    _disconnect();
   Feather.connect(_ssid, _pass);
   _status = AIO_NET_DISCONNECTED;
   }
 }
+    
+/**************************************************************************/
+/*!
+    @brief    Disconnect the wifi network.
+    @return   none
+*/
+/**************************************************************************/
+void AdafruitIO_WICED::_disconnect()
+{
+  Feather.disconnect();
+  delay(AIO_NET_DISCONNECT_WAIT);
+}
 
 aio_status_t AdafruitIO_WICED::networkStatus()
 {
diff --git a/src/wifi/AdafruitIO_WICED.h b/src/wifi/AdafruitIO_WICED.h
@@ -35,6 +35,7 @@ class AdafruitIO_WICED : public AdafruitIO {
 
   protected:
     void _connect();
+    void _disconnect();
     const char *_ssid;
     const char *_pass;
     AdafruitIO_WICED_SSL *_client;
diff --git a/src/wifi/AdafruitIO_WINC1500.h b/src/wifi/AdafruitIO_WINC1500.h
@@ -24,9 +24,36 @@
 #include "Adafruit_MQTT.h"
 #include "Adafruit_MQTT_Client.h"
 
+/**************************************************************************/
+/*! 
+    @brief  Class for interacting with adafruit.io (AIO) using WINC1500
+*/
+/**************************************************************************/
 class AdafruitIO_WINC1500 : public AdafruitIO {
 
   public:
+/**************************************************************************/
+/*!
+    @brief    Instantiate the object.
+    @param    user
+              A pointer to the AIO user name.
+    @param    key
+              A pointer to the AIO key for the user.
+    @param    ssid
+              A pointer to the SSID for the wifi.
+    @param    pass
+              A pointer to the password for the wifi.
+    @param    winc_cs
+              The cs pin number.
+    @param    winc_irq
+              The irq pin number.
+    @param    winc_rst
+              The rst pin number.
+    @param    winc_en
+              The en pin number.
+    @return   none
+*/
+/**************************************************************************/
     AdafruitIO_WINC1500(const char *user, const char *key, const char *ssid, const char *pass, int winc_cs = 8, int winc_irq = 7, int winc_rst = 4, int winc_en = 2) : AdafruitIO(user, key)
     {
       _winc_cs = winc_cs;
@@ -41,6 +68,12 @@ class AdafruitIO_WINC1500 : public AdafruitIO {
       _http = new HttpClient(*_http_client, _host, _http_port);
     }
 
+/**************************************************************************/
+/*!
+    @brief    Destructor to end the object.
+    @return   none
+*/
+/**************************************************************************/
     ~AdafruitIO_WINC1500()
     {
       if (_mqtt_client)
@@ -53,6 +86,13 @@ class AdafruitIO_WINC1500 : public AdafruitIO {
         delete _http;
     }
 
+/**************************************************************************/
+/*!
+    @brief    Network status check.
+    @return   An AIO network status value. Lower values represent poorer connection 
+              status.
+*/
+/**************************************************************************/
     aio_status_t networkStatus()
     {
       switch (WiFi.status())
@@ -81,12 +121,17 @@ class AdafruitIO_WINC1500 : public AdafruitIO {
     WiFiSSLClient *_http_client;
     WiFiSSLClient *_mqtt_client;
 
+/**************************************************************************/
+/*!
+    @brief    Connect the wifi network.
+    @return   none
+*/
+/**************************************************************************/
     void _connect()
     {
       if(strlen(_ssid) != 0)
       {
-        WiFi.disconnect();
-        delay(300);
+        _disconnect();
       WiFi.setPins(_winc_cs, _winc_irq, _winc_rst, _winc_en);
 
       // no shield? bail
@@ -99,6 +144,18 @@ class AdafruitIO_WINC1500 : public AdafruitIO {
       _status = AIO_NET_DISCONNECTED;
       }
     }
+    
+/**************************************************************************/
+/*!
+    @brief    Disconnect the wifi network.
+    @return   none
+*/
+/**************************************************************************/
+    void _disconnect()
+    {
+      WiFi.disconnect();
+      delay(AIO_NET_DISCONNECT_WAIT);
+    }
 };
 
 #endif // ARDUINO_ARCH_SAMD

Original file line number	Diff line number	Diff line change
`@@ -37,13 +37,23 @@ void AdafruitIO_WICED::_connect()`
`37`	`37`	`{`
`38`	`38`	`if(strlen(_ssid) != 0)`
`39`	`39`	`{`
`40`		`- Feather.disconnect();`
`41`		`- delay(300);`
`42`		`-`
	`40`	`+ _disconnect();`
`43`	`41`	`Feather.connect(_ssid, _pass);`
`44`	`42`	`_status = AIO_NET_DISCONNECTED;`
`45`	`43`	`}`
`46`	`44`	`}`
	`45`	`+`
	`46`	`+/**************************************************************************/`
	`47`	`+/*!`
	`48`	`+ @brief Disconnect the wifi network.`
	`49`	`+ @return none`
	`50`	`+*/`
	`51`	`+/**************************************************************************/`
	`52`	`+void AdafruitIO_WICED::_disconnect()`
	`53`	`+{`
	`54`	`+ Feather.disconnect();`
	`55`	`+ delay(AIO_NET_DISCONNECT_WAIT);`
	`56`	`+}`
`47`	`57`
`48`	`58`	`aio_status_t AdafruitIO_WICED::networkStatus()`
`49`	`59`	`{`