Update README.md - Bug in Espressif Arduino 3.2.0 #163
Conversation
Espressif Arduino 3.2.0 has a terrible bug (asserts are ignored), so users might prefer to stick with version 3.1.3 for now.
WalkthroughThe README file was updated to include a warning about a critical bug in espressif Arduino version 3.2.0, where asserts are ignored. Users are advised to consider using version 3.1.3 instead. An example configuration snippet for platformio.ini was added to demonstrate how to specify version 3.1.3 directly. Additionally, a minor punctuation correction was made in the stable Arduino section. Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
23-23: Nit: Capitalization and clarity.The sentence
currently espressif Arduino 3.2.0 and IDF 5.4.1.starts with a lowercase letter and reads as a fragment. Consider rewriting to a full sentence, for example:
Currently using espressif Arduino 3.2.0 with IDF 5.4.1.
32-33: Enhance visibility of the bug warning.Instead of a plain paragraph, use a markdown blockquote or admonition to highlight the issue. For example:
> **⚠️ Warning:** espressif Arduino 3.2.0 has a [known bug](https://github.com/espressif/arduino-esp32/issues/11166) that causes `assert()` to be ignored. Consider using version 3.1.3:This will make it stand out more clearly in the docs.
| [env:stable] | ||
| platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.13+github/platform-espressif32.zip | ||
| board = ... | ||
| ... | ||
| ``` |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify the workaround URL and version string.
Please confirm that the platform URL and version tag actually correspond to the intended 3.1.3 release. You can run a simple HTTP check to ensure the ZIP is reachable:
This ensures users won’t hit a broken link when pinning to the older version.
🏁 Script executed:
#!/bin/bash
# Check that the fallback platform ZIP returns HTTP 200
URL="https://github.com/pioarduino/platform-espressif32/releases/download/53.03.13+github/platform-espressif32.zip"
STATUS=$(curl -o /dev/null -s -w "%{http_code}" "$URL")
if [ "$STATUS" -ne 200 ]; then
echo "Error: Expected HTTP 200, got $STATUS for $URL"
exit 1
fi
echo "URL is valid and reachable."Length of output: 616
Follow redirects when verifying the fallback platform ZIP
The GitHub “releases/download” endpoint will issue a 302 redirect to the actual asset host, so your check needs to follow redirects before asserting HTTP 200. For example:
#!/bin/bash
URL="https://github.com/pioarduino/platform-espressif32/releases/download/53.03.13+github/platform-espressif32.zip"
# Follow redirects and verify final status is 200
STATUS=$(curl -L -o /dev/null -s -w "%{http_code}" "$URL")
if [ "$STATUS" -ne 200 ]; then
echo "Error: Expected HTTP 200, got $STATUS for $URL"
exit 1
fi
echo "URL is valid and reachable."– This ensures you’re actually pulling down the ZIP asset for version 3.1.3 rather than only seeing the redirect.
|
All PRs please only against branch develop. Furthermore won't merge. Issues in core won't be mentioned in the general pioarduino Readme. This is a Arduino core issue and not related or caused by pioarduino |
|
Added info in release. Thx for heads up |
Espressif Arduino 3.2.0 has a terrible bug (asserts are ignored). I think it's worth warning users about that, and show them how to stick with version 3.1.3 if they want to.
Summary by CodeRabbit