feat(uart): simplifies UART example based on MODBUS standard by SuGlider · Pull Request #11309 · espressif/arduino-esp32 (original) (raw)

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation11 Commits6 Checks19 Files changed

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

Description of Change

Improves and simplifies the Serial OnReceive example.
The example uses Rx Timeout based on MODBUS standard.

This change will demonstrate how to receive any number of bytes and then execute a callback as soon as defined timeout happens.

Tests scenarios

Using this example with ESP32, ESP32-S2, ESP32-S3, ESP32-C3 and ESP32-C6.

Related links

None.

👋 Hello SuGlider, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against eccec05

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR simplifies the UART onReceive example by updating documentation and modifying how received data is handled in order to align with the MODBUS standard.

• Updated callback comments and behavior to reflect onlyOnTimeout usage
• Removed semaphore protection in favor of a simplified while loop for reading available data
• Adjusted setup configurations and reduced the main loop delay to better demonstrate rapid processing Comments suppressed due to low confidence (1)

libraries/ESP32/examples/Serial/onReceiveExample/onReceiveExample.ino:112

• [nitpick] The main loop delay has been reduced from 1000 ms to 1 ms, which may lead to excessive CPU usage and frequent serial prints. Verify that this rapid polling is intentional for the example's demonstration of RX Timeout behavior.

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

Click to expand the detailed deltas report [usage change in BYTES]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

me-no-dev deleted the uart_onreceive_example_improvement branch

April 29, 2025 05:58