Merge branch 'espressif:master' into main

Jason2866 · web-flow · commit 56181f01fa59 · 2024-08-24T11:05:15.000+02:00
diff --git a/.github/scripts/tests_run.sh b/.github/scripts/tests_run.sh
@@ -132,6 +132,10 @@ while [ ! -z "$1" ]; do
     -W )
         shift
         wokwi_timeout=$1
+        if [[ -z $WOKWI_CLI_TOKEN ]]; then
+            echo "Wokwi CLI token is not set"
+            exit 1
+        fi
         platform="wokwi"
         ;;
     -o )
diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml
@@ -4,7 +4,7 @@ on:
   push:
     branches:
     - master
-    - release/*
+    - release/v2.x
     paths:
     - 'docs/**'
     - '.github/workflows/docs_build.yml'
diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml
@@ -5,7 +5,7 @@ on:
     types: [published]
   push:
     branches:
-    - release/*
+    - release/v2.x
     - master
     paths:
     - 'docs/**'
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -5,7 +5,7 @@ on:
   push:
     branches:
     - master
-    - release/*
+    - release/v2.x
   pull_request:
     paths:
       - 'cores/**'
diff --git a/cores/esp32/esp32-hal-timer.c b/cores/esp32/esp32-hal-timer.c
@@ -242,7 +242,7 @@ uint64_t timerReadMicros(hw_timer_t *timer) {
   return timer_val * 1000000 / frequency;
 }
 
-uint64_t timerReadMilis(hw_timer_t *timer) {
+uint64_t timerReadMillis(hw_timer_t *timer) {
   if (timer == NULL) {
     log_e("Timer handle is NULL");
     return 0;
diff --git a/cores/esp32/esp32-hal-timer.h b/cores/esp32/esp32-hal-timer.h
@@ -42,7 +42,7 @@ void timerWrite(hw_timer_t *timer, uint64_t val);
 
 uint64_t timerRead(hw_timer_t *timer);
 uint64_t timerReadMicros(hw_timer_t *timer);
-uint64_t timerReadMilis(hw_timer_t *timer);
+uint64_t timerReadMillis(hw_timer_t *timer);
 double timerReadSeconds(hw_timer_t *timer);
 
 uint32_t timerGetFrequency(hw_timer_t *timer);
diff --git a/docs/en/api/timer.rst b/docs/en/api/timer.rst
@@ -119,14 +119,14 @@ This function is used to read counter value in microseconds of the timer.
 
 This function will return ``counter value`` of the timer in microseconds.
 
-timerReadMilis
-**************
+timerReadMillis
+***************
 
 This function is used to read counter value in milliseconds of the timer.
 
 .. code-block:: arduino
 
-    uint64_t timerReadMilis(hw_timer_t * timer);
+    uint64_t timerReadMillis(hw_timer_t * timer);
 
 * ``timer`` timer struct.
 
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
 esp-docs>=1.4.0
 sphinx-copybutton==0.5.0
 sphinx-tabs==3.2.0
+numpydoc==1.5.0
diff --git a/package/package_esp32_index.template.json b/package/package_esp32_index.template.json
@@ -42,7 +42,7 @@
             {
               "packager": "esp32",
               "name": "esp32-arduino-libs",
-              "version": "idf-release_v5.1-c608177cf9"
+              "version": "idf-release_v5.1-d38afc77"
             },
             {
               "packager": "esp32",
@@ -105,63 +105,63 @@
       "tools": [
         {
           "name": "esp32-arduino-libs",
-          "version": "idf-release_v5.1-c608177cf9",
+          "version": "idf-release_v5.1-d38afc77",
           "systems": [
             {
               "host": "i686-mingw32",
-              "url": "https://codeload.github.com/espressif/esp32-arduino-libs/zip/7b015a59844d511b72663a266e5793fb98eecaa1",
-              "archiveFileName": "esp32-arduino-libs-7b015a59844d511b72663a266e5793fb98eecaa1.zip",
-              "checksum": "SHA-256:392c411dc6b8253a3d067fda6c41a3f67ade2f99259a1a707630568e8f80f055",
-              "size": "310235817"
+              "url": "https://github.com/espressif/esp32-arduino-lib-builder/releases/download/idf-release_v5.1/esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "archiveFileName": "esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "checksum": "SHA-256:ab6659cf32833ab503de31d5b4ecd77979edf5e98c0104b456d70636c393b5c4",
+              "size": "308243283"
             },
             {
               "host": "x86_64-mingw32",
-              "url": "https://codeload.github.com/espressif/esp32-arduino-libs/zip/7b015a59844d511b72663a266e5793fb98eecaa1",
-              "archiveFileName": "esp32-arduino-libs-7b015a59844d511b72663a266e5793fb98eecaa1.zip",
-              "checksum": "SHA-256:392c411dc6b8253a3d067fda6c41a3f67ade2f99259a1a707630568e8f80f055",
-              "size": "310235817"
+              "url": "https://github.com/espressif/esp32-arduino-lib-builder/releases/download/idf-release_v5.1/esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "archiveFileName": "esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "checksum": "SHA-256:ab6659cf32833ab503de31d5b4ecd77979edf5e98c0104b456d70636c393b5c4",
+              "size": "308243283"
             },
             {
               "host": "arm64-apple-darwin",
-              "url": "https://codeload.github.com/espressif/esp32-arduino-libs/zip/7b015a59844d511b72663a266e5793fb98eecaa1",
-              "archiveFileName": "esp32-arduino-libs-7b015a59844d511b72663a266e5793fb98eecaa1.zip",
-              "checksum": "SHA-256:392c411dc6b8253a3d067fda6c41a3f67ade2f99259a1a707630568e8f80f055",
-              "size": "310235817"
+              "url": "https://github.com/espressif/esp32-arduino-lib-builder/releases/download/idf-release_v5.1/esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "archiveFileName": "esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "checksum": "SHA-256:ab6659cf32833ab503de31d5b4ecd77979edf5e98c0104b456d70636c393b5c4",
+              "size": "308243283"
             },
             {
               "host": "x86_64-apple-darwin",
-              "url": "https://codeload.github.com/espressif/esp32-arduino-libs/zip/7b015a59844d511b72663a266e5793fb98eecaa1",
-              "archiveFileName": "esp32-arduino-libs-7b015a59844d511b72663a266e5793fb98eecaa1.zip",
-              "checksum": "SHA-256:392c411dc6b8253a3d067fda6c41a3f67ade2f99259a1a707630568e8f80f055",
-              "size": "310235817"
+              "url": "https://github.com/espressif/esp32-arduino-lib-builder/releases/download/idf-release_v5.1/esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "archiveFileName": "esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "checksum": "SHA-256:ab6659cf32833ab503de31d5b4ecd77979edf5e98c0104b456d70636c393b5c4",
+              "size": "308243283"
             },
             {
               "host": "x86_64-pc-linux-gnu",
-              "url": "https://codeload.github.com/espressif/esp32-arduino-libs/zip/7b015a59844d511b72663a266e5793fb98eecaa1",
-              "archiveFileName": "esp32-arduino-libs-7b015a59844d511b72663a266e5793fb98eecaa1.zip",
-              "checksum": "SHA-256:392c411dc6b8253a3d067fda6c41a3f67ade2f99259a1a707630568e8f80f055",
-              "size": "310235817"
+              "url": "https://github.com/espressif/esp32-arduino-lib-builder/releases/download/idf-release_v5.1/esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "archiveFileName": "esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "checksum": "SHA-256:ab6659cf32833ab503de31d5b4ecd77979edf5e98c0104b456d70636c393b5c4",
+              "size": "308243283"
             },
             {
               "host": "i686-pc-linux-gnu",
-              "url": "https://codeload.github.com/espressif/esp32-arduino-libs/zip/7b015a59844d511b72663a266e5793fb98eecaa1",
-              "archiveFileName": "esp32-arduino-libs-7b015a59844d511b72663a266e5793fb98eecaa1.zip",
-              "checksum": "SHA-256:392c411dc6b8253a3d067fda6c41a3f67ade2f99259a1a707630568e8f80f055",
-              "size": "310235817"
+              "url": "https://github.com/espressif/esp32-arduino-lib-builder/releases/download/idf-release_v5.1/esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "archiveFileName": "esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "checksum": "SHA-256:ab6659cf32833ab503de31d5b4ecd77979edf5e98c0104b456d70636c393b5c4",
+              "size": "308243283"
             },
             {
               "host": "aarch64-linux-gnu",
-              "url": "https://codeload.github.com/espressif/esp32-arduino-libs/zip/7b015a59844d511b72663a266e5793fb98eecaa1",
-              "archiveFileName": "esp32-arduino-libs-7b015a59844d511b72663a266e5793fb98eecaa1.zip",
-              "checksum": "SHA-256:392c411dc6b8253a3d067fda6c41a3f67ade2f99259a1a707630568e8f80f055",
-              "size": "310235817"
+              "url": "https://github.com/espressif/esp32-arduino-lib-builder/releases/download/idf-release_v5.1/esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "archiveFileName": "esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "checksum": "SHA-256:ab6659cf32833ab503de31d5b4ecd77979edf5e98c0104b456d70636c393b5c4",
+              "size": "308243283"
             },
             {
               "host": "arm-linux-gnueabihf",
-              "url": "https://codeload.github.com/espressif/esp32-arduino-libs/zip/7b015a59844d511b72663a266e5793fb98eecaa1",
-              "archiveFileName": "esp32-arduino-libs-7b015a59844d511b72663a266e5793fb98eecaa1.zip",
-              "checksum": "SHA-256:392c411dc6b8253a3d067fda6c41a3f67ade2f99259a1a707630568e8f80f055",
-              "size": "310235817"
+              "url": "https://github.com/espressif/esp32-arduino-lib-builder/releases/download/idf-release_v5.1/esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "archiveFileName": "esp32-arduino-libs-idf-release_v5.1-d38afc77.zip",
+              "checksum": "SHA-256:ab6659cf32833ab503de31d5b4ecd77979edf5e98c0104b456d70636c393b5c4",
+              "size": "308243283"
             }
           ]
         },
diff --git a/platform.txt b/platform.txt
@@ -46,10 +46,14 @@ compiler.warning_flags.default=
 compiler.warning_flags.more=-Wall
 compiler.warning_flags.all=-Wall -Wextra
 
+# Additional flags specific to Arduino (not based on IDF flags).
+# Update tools/platformio-build.py when changing these flags.
+compiler.common_werror_flags=-Werror=return-type
+
 # Compile Flags
 compiler.cpreprocessor.flags="@{compiler.sdk.path}/flags/defines" "-I{build.source.path}" -iprefix "{compiler.sdk.path}/include/" "@{compiler.sdk.path}/flags/includes" "-I{compiler.sdk.path}/{build.memory_type}/include"
-compiler.c.flags="@{compiler.sdk.path}/flags/c_flags" {compiler.warning_flags} {compiler.optimization_flags}
-compiler.cpp.flags="@{compiler.sdk.path}/flags/cpp_flags" {compiler.warning_flags} {compiler.optimization_flags}
+compiler.c.flags="@{compiler.sdk.path}/flags/c_flags" {compiler.warning_flags} {compiler.optimization_flags} {compiler.common_werror_flags}
+compiler.cpp.flags="@{compiler.sdk.path}/flags/cpp_flags" {compiler.warning_flags} {compiler.optimization_flags} {compiler.common_werror_flags}
 compiler.S.flags="@{compiler.sdk.path}/flags/S_flags" {compiler.warning_flags} {compiler.optimization_flags}
 compiler.c.elf.flags="@{compiler.sdk.path}/flags/ld_flags" "@{compiler.sdk.path}/flags/ld_scripts"
 compiler.c.elf.libs="@{compiler.sdk.path}/flags/ld_libs"
diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -1,7 +1,7 @@
 cryptography==42.0.7
 --only-binary cryptography
 pytest-cov==5.0.0
-pytest-embedded-serial-esp==1.11.0
-pytest-embedded-arduino==1.11.0
-pytest-embedded-wokwi==1.11.0
-pytest-embedded-qemu==1.11.0
+pytest-embedded-serial-esp==1.11.5
+pytest-embedded-arduino==1.11.5
+pytest-embedded-wokwi==1.11.5
+pytest-embedded-qemu==1.11.5
diff --git a/tests/validation/democfg/test_democfg.py b/tests/validation/democfg/test_democfg.py
@@ -1,2 +1,2 @@
 def test_cfg(dut):
-    dut.expect("Hello cfg!")
+    dut.expect_exact("Hello cfg!")
diff --git a/tests/validation/hello_world/test_hello_world.py b/tests/validation/hello_world/test_hello_world.py
@@ -1,2 +1,2 @@
 def test_hello_world(dut):
-    dut.expect("Hello Arduino!")
+    dut.expect_exact("Hello Arduino!")
diff --git a/tests/validation/nvs/test_nvs.py b/tests/validation/nvs/test_nvs.py
@@ -1,4 +1,4 @@
 def test_nvs(dut):
-    dut.expect("Current counter value: 0")
-    dut.expect("Current counter value: 1")
-    dut.expect("Current counter value: 2")
+    dut.expect_exact("Current counter value: 0")
+    dut.expect_exact("Current counter value: 1")
+    dut.expect_exact("Current counter value: 2")
diff --git a/tools/get.exe b/tools/get.exe
diff --git a/tools/get.py b/tools/get.py
@@ -147,7 +147,36 @@ def verify_files(filename, destination, rename_to):
     return True
 
 
-def unpack(filename, destination, force_extract):  # noqa: C901
+def is_latest_version(destination, dirname, rename_to, cfile, checksum):
+    current_version = None
+    expected_version = None
+
+    try:
+        expected_version = checksum
+        with open(os.path.join(destination, rename_to, ".package_checksum"), "r") as f:
+            current_version = f.read()
+
+        if verbose:
+            print(f"\nTool: {rename_to}")
+            print(f"Current version: {current_version}")
+            print(f"Expected version: {expected_version}")
+
+        if current_version and current_version == expected_version:
+            if verbose:
+                print("Latest version already installed. Skipping extraction")
+            return True
+
+        if verbose:
+            print("New version detected")
+
+    except Exception as e:
+        if verbose:
+            print(f"Falied to verify version for {rename_to}: {e}")
+
+    return False
+
+
+def unpack(filename, destination, force_extract, checksum):  # noqa: C901
     dirname = ""
     cfile = None  # Compressed file
     file_is_corrupted = False
@@ -196,11 +225,11 @@ def unpack(filename, destination, force_extract):  # noqa: C901
         rename_to = "esp32-arduino-libs"
 
     if not force_extract:
-        if verify_files(filename, destination, rename_to):
-            print(" Files ok. Skipping Extraction")
-            return True
-        else:
-            print(" Extracting archive...")
+        if is_latest_version(destination, dirname, rename_to, cfile, checksum):
+            if verify_files(filename, destination, rename_to):
+                print(" Files ok. Skipping Extraction")
+                return True
+        print(" Extracting archive...")
     else:
         print(" Forcing extraction")
 
@@ -225,6 +254,9 @@ def unpack(filename, destination, force_extract):  # noqa: C901
             shutil.rmtree(rename_to)
         shutil.move(dirname, rename_to)
 
+    with open(os.path.join(destination, rename_to, ".package_checksum"), "w") as f:
+        f.write(checksum)
+
     if verify_files(filename, destination, rename_to):
         print(" Files extracted successfully.")
         return True
@@ -324,11 +356,11 @@ def get_tool(tool, force_download, force_extract):
         print("Tool {0} already downloaded".format(archive_name))
         sys.stdout.flush()
 
-    if "esp32-arduino-libs" not in archive_name and sha256sum(local_path) != checksum:
+    if sha256sum(local_path) != checksum:
         print("Checksum mismatch for {0}".format(archive_name))
         return False
 
-    return unpack(local_path, ".", force_extract)
+    return unpack(local_path, ".", force_extract, checksum)
 
 
 def load_tools_list(filename, platform):
@@ -379,21 +411,17 @@ def identify_platform():
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="Download and extract tools")
 
-    parser.add_argument("-v", "--verbose", type=bool, default=False, required=False, help="Print verbose output")
+    parser.add_argument("-v", "--verbose", action="store_true", required=False, help="Print verbose output")
 
-    parser.add_argument(
-        "-d", "--force_download", type=bool, default=False, required=False, help="Force download of tools"
-    )
+    parser.add_argument("-d", "--force_download", action="store_true", required=False, help="Force download of tools")
 
-    parser.add_argument(
-        "-e", "--force_extract", type=bool, default=False, required=False, help="Force extraction of tools"
-    )
+    parser.add_argument("-e", "--force_extract", action="store_true", required=False, help="Force extraction of tools")
 
     parser.add_argument(
-        "-f", "--force_all", type=bool, default=False, required=False, help="Force download and extraction of tools"
+        "-f", "--force_all", action="store_true", required=False, help="Force download and extraction of tools"
     )
 
-    parser.add_argument("-t", "--test", type=bool, default=False, required=False, help=argparse.SUPPRESS)
+    parser.add_argument("-t", "--test", action="store_true", required=False, help=argparse.SUPPRESS)
 
     args = parser.parse_args()
 
diff --git a/tools/platformio-build.py b/tools/platformio-build.py
@@ -164,6 +164,15 @@ def add_tinyuf2_extra_image():
     )
 )
 
+#
+# Additional flags specific to Arduino core (not based on IDF)
+#
+
+env.Append(
+    CFLAGS=["-Werror=return-type"],
+    CXXFLAGS=["-Werror=return-type"],
+)
+
 #
 # Target: Build Core Library
 #
diff --git a/tools/pre-commit/requirements.txt b/tools/pre-commit/requirements.txt
@@ -1,2 +1,2 @@
 pre-commit==3.7.1
-docutils==0.21.2
+docutils==0.16

Original file line number	Diff line number	Diff line change
`@@ -242,7 +242,7 @@ uint64_t timerReadMicros(hw_timer_t *timer) {`
`242`	`242`	`return timer_val * 1000000 / frequency;`
`243`	`243`	`}`
`244`	`244`
`245`		`-uint64_t timerReadMilis(hw_timer_t *timer) {`
	`245`	`+uint64_t timerReadMillis(hw_timer_t *timer) {`
`246`	`246`	`if (timer == NULL) {`
`247`	`247`	`log_e("Timer handle is NULL");`
`248`	`248`	`return 0;`