adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Doc: Update deprecation of setAutoConnect, etc.. (#6908)

Browse source 
* Doc: Update deprecation of `setAutoConnect`...

... and `getAutoConnect`

* Doc: Add doc to `setAutoReconnect`..

.. and `getAutoReconnect`
This commit is contained in:
Rotzbua 2022-06-27 13:01:00 +02:00 committed by GitHub
parent 43e5e02224
commit 95a45ce259
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/source/api/wifi.rst
View file

@ -446,26 +446,12 @@ Return the connection state.
setAutoConnect setAutoConnect
************** **************
Function used to set the automatic connection. Function is deprecated.
.. code-block:: arduino
bool setAutoConnect(bool autoConnect);
Where:
* ``bool autoConnect`` is set to ``true`` to enable this option.
getAutoConnect getAutoConnect
************** **************
Function used to get the automatic connection setting value. Function is deprecated.
.. code-block:: arduino
bool getAutoConnect();
The function will return ``true`` if the setting is enabled.
setAutoReconnect setAutoReconnect
**************** ****************
@ -484,11 +470,12 @@ getAutoReconnect
**************** ****************
Function used to get the automatic reconnection if the connection is lost. Function used to get the automatic reconnection if the connection is lost.
.. code-block:: arduino .. code-block:: arduino
bool getAutoReconnect(); bool getAutoReconnect();
The function will return ``true`` if this setting is enabled. The function will return ``true`` if this setting is enabled.
WiFiMulti WiFiMulti
--------- ---------

16
libraries/WiFi/src/WiFiSTA.cpp
View file

@ -430,8 +430,9 @@ void WiFiSTAClass::setSortMethod(wifi_sort_method_t sortMethod)
} }
/** /**
* Setting the ESP32 station to connect to the AP (which is recorded) * Deprecated. Setting the ESP32 station to connect to the AP (which is recorded)
* automatically or not when powered on. Enable auto-connect by default. * automatically or not when powered on. Enable auto-connect by default.
* @deprecated use `setAutoReconnect`
* @param autoConnect bool * @param autoConnect bool
* @return if saved * @return if saved
*/ */
@ -441,8 +442,9 @@ bool WiFiSTAClass::setAutoConnect(bool autoConnect)
} }
/** /**
* Checks if ESP32 station mode will connect to AP * Deprecated. Checks if ESP32 station mode will connect to AP
* automatically or not when it is powered on. * automatically or not when it is powered on.
* @deprecated use `getAutoReconnect`
* @return auto connect * @return auto connect
*/ */
bool WiFiSTAClass::getAutoConnect() bool WiFiSTAClass::getAutoConnect()
@ -450,12 +452,20 @@ bool WiFiSTAClass::getAutoConnect()
return false;//now deprecated return false;//now deprecated
} }
/**
* Function used to set the automatic reconnection if the connection is lost.
* @param autoReconnect `true` to enable this option.
* @return true
*/
bool WiFiSTAClass::setAutoReconnect(bool autoReconnect) bool WiFiSTAClass::setAutoReconnect(bool autoReconnect)
{ {
_autoReconnect = autoReconnect; _autoReconnect = autoReconnect;
return true; return true;
} }
/**
* Function used to get the automatic reconnection if the connection is lost.
* @return The function will return `true` if this setting is enabled.
*/
bool WiFiSTAClass::getAutoReconnect() bool WiFiSTAClass::getAutoReconnect()
{ {
return _autoReconnect; return _autoReconnect;