Merge branch 'master' into spi_pins_detach

Author: me-no-dev

.github/workflows/docs_build.yml

@@ -7,11 +7,11 @@ on:
     - release/*
     paths:
     - 'docs/**'
-    - '.github/workflows/docs.yml'
+    - '.github/workflows/docs_build.yml'
   pull_request:
     paths:
     - 'docs/**'
-    - '.github/workflows/docs.yml'
+    - '.github/workflows/docs_build.yml'
 
 jobs:
 
@@ -42,4 +42,3 @@ jobs:
       with:
         name: docs
         path: docs
-

.github/workflows/docs_deploy.yml

@@ -1,12 +1,15 @@
 name: Documentation Build and Production Deploy CI
 
 on:
+  release:
+    types: [published]
   push:
     branches:
     - release/*
+    - master
     paths:
     - 'docs/**'
-    - '.github/workflows/docs.yml'
+    - '.github/workflows/docs_deploy.yml'
 
 jobs:
 
@@ -27,12 +30,11 @@ jobs:
       env:
         # Deploy to production server
         # DOCS_BUILD_DIR: "./docs/_build/"
-        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }}
-        DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }}
+        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }}
+        DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
         DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
-        DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }}
-        DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }}
-        # Deploy to preview server
+        DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }}
+        DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
       run: |
         sudo apt update
         sudo apt install python3-pip python3-setuptools

.github/workflows/docs_preview.yml

@@ -36,6 +36,10 @@ You can use the [Arduino-ESP32 Online Documentation](https://docs.espressif.com/
 
 ---
 
+**APIs compatibility with ESP8266 and Arduino-CORE (Arduino.cc) is explained [here](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html#apis).**
+
+---
+
 * [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html)
 * [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html)
 * [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html)

README.md

@@ -73,16 +73,17 @@ After the setup you can save and exit:
 - Close confirmation window [Enter] or [Space] or [Esc]
 - Quit [Q]
 
-Option 1. Using Arduino setup() and loop()
-******************************************
+As the Arduino libraries use C++ features, you will need to swap some file extensions from ``.c`` to ``.cpp``:
 
 - In main folder rename file `main.c` to `main.cpp`.
+- In main folder open file `CMakeLists.txt` and change `main.c` to `main.cpp` as described below.
 
-- In main folder open file `CMakeList.txt` and change `main.c` to `main.cpp` as described below.
+Option 1. Using Arduino setup() and loop()
+******************************************
 
-- Your main.cpp should be formatted like any other sketch.
+Your main.cpp should be formatted like any other sketch. Don't forget to include ``Arduino.h``.
 
-.. code-block:: c
+.. code-block:: cpp
 
     //file: main.cpp
     #include "Arduino.h"
@@ -102,14 +103,14 @@ Option 1. Using Arduino setup() and loop()
 Option 2. Using ESP-IDF appmain()
 *********************************
 
-In main.c or main.cpp you need to implement ``app_main()`` and call ``initArduino();`` in it.
+In main.cpp you need to implement ``app_main()`` and call ``initArduino();`` in it.
 
 Keep in mind that setup() and loop() will not be called in this case.
 Furthermore the ``app_main()`` is single execution as a normal function so if you need an infinite loop as in Arduino place it there.
 
 .. code-block:: cpp
 
-    //file: main.c or main.cpp
+    //file: main.cpp
     #include "Arduino.h"
 
     extern "C" void app_main()
@@ -141,7 +142,7 @@ Build, flash and monitor
 
   - After a successful flash, you may need to press the RST button again
 
-  - To terminate the serial monitor press [Ctrl] + [ ] ]
+  - To terminate the serial monitor press ``Ctrl`` + ``]``
 
 Logging To Serial
 -----------------
@@ -179,7 +180,7 @@ Download the library:
 
 .. code-block:: bash
 
-    cd ~/esp/esp-idf/components/arduino-esp32/
+    cd ~/esp/esp-idf/components/arduino/
     git clone --recursive [email protected]:Author/new_library.git libraries/new_library
 
 

docs/en/esp-idf_component.rst

@@ -71,6 +71,11 @@ APIs
 
 The Arduino ESP32 offers some unique APIs, described in this section:
 
+.. note:: 
+    Please be advised that we cannot ensure continuous compatibility between the Arduino Core ESP32 APIs and ESP8266 APIs, as well as Arduino-Core APIs (Arduino.cc).
+    While our aim is to maintain harmony, the addition of new features may result in occasional divergence. We strive to achieve the best possible integration but acknowledge
+    that perfect compatibility might not always be feasible. Please refer to the documentation for any specific considerations.
+
 .. toctree::
     :maxdepth: 1
     :glob:

docs/en/libraries.rst

@@ -367,7 +367,7 @@ bool WiFiSTAClass::reconnect()
  * @param eraseap `true` to erase the AP configuration from the NVS memory.
  * @return `true` when successful.
  */
-bool WiFiSTAClass::disconnect(bool wifioff, bool eraseap)
+bool WiFiSTAClass::disconnectAsync(bool wifioff, bool eraseap)
 {
     wifi_config_t conf;
     wifi_sta_config(&conf);
@@ -391,6 +391,31 @@ bool WiFiSTAClass::disconnect(bool wifioff, bool eraseap)
     return false;
 }
 
+/**
+ * Disconnect from the network.
+ * @param wifioff `true` to turn the Wi-Fi radio off.
+ * @param eraseap `true` to erase the AP configuration from the NVS memory.
+ * @param timeoutLength timeout to wait for status change
+ * @return `true` when successful.
+ */
+bool WiFiSTAClass::disconnect(bool wifioff, bool eraseap, unsigned long timeoutLength)
+{
+    if (!disconnectAsync(wifioff, eraseap)) {
+        return false;
+    }
+    if (!timeoutLength) {
+        return true;
+    }
+    const unsigned long start = millis();
+    while ((WiFiGenericClass::getStatusBits() & STA_CONNECTED_BIT) != 0) {
+        if((millis() - start) >= timeoutLength){
+            return false;
+        }
+        delay(2);
+    }
+    return true;
+}
+
 /**
  * @brief  Reset WiFi settings in NVS to default values.
  * @return true if erase succeeded

libraries/WiFi/src/WiFiSTA.cpp

@@ -61,7 +61,8 @@ class WiFiSTAClass
     bool bandwidth(wifi_bandwidth_t bandwidth);
 
     bool reconnect();
-    bool disconnect(bool wifioff = false, bool eraseap = false);
+    bool disconnectAsync(bool wifioff = false, bool eraseap = false);
+    bool disconnect(bool wifioff = false, bool eraseap = false, unsigned long timeoutLength = 100);
     bool eraseAP(void);
 
     bool isConnected();