Skip to content

feat(uart): simplifies UART example based on MODBUS standard #11309

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 and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 29, 2025

Conversation

SuGlider
Copy link
Collaborator

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.

@SuGlider SuGlider added Type: Example Issue is related to specific example. Peripheral: UART labels Apr 28, 2025
@SuGlider SuGlider added this to the 3.2.1 milestone Apr 28, 2025
@SuGlider SuGlider self-assigned this Apr 28, 2025
Copy link
Contributor

github-actions bot commented Apr 28, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 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

@SuGlider SuGlider moved this from Todo to In Review in Arduino ESP32 Core Project Roadmap Apr 28, 2025
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Apr 28, 2025
@SuGlider SuGlider requested a review from Copilot April 28, 2025 02:43
Copy link
Contributor

@Copilot Copilot AI left a comment

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.
delay(1);

Copy link
Contributor

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.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32P4💚 -680💚 -0.020.00000.000.00
ESP32S3💚 -840💚 -0.030.00000.000.00
ESP32S2💚 -160💚 -0.010.00000.000.00
ESP32C3💚 -900💚 -0.030.00000.000.00
ESP32C6💚 -660💚 -0.030.00000.000.00
ESP32H2💚 -880💚 -0.030.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/ESP32/examples/Serial/onReceiveExample💚 -680💚 -840💚 -160💚 -900💚 -660💚 -88000

Copy link
Collaborator

@lucasssvaz lucasssvaz left a comment

Choose a reason for hiding this comment

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

LGTM

@SuGlider SuGlider requested a review from me-no-dev April 28, 2025 17:03
@me-no-dev me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Apr 28, 2025
@me-no-dev me-no-dev merged commit d63b876 into master Apr 29, 2025
21 checks passed
@me-no-dev me-no-dev deleted the uart_onreceive_example_improvement branch April 29, 2025 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Peripheral: UART Status: Pending Merge Pull Request is ready to be merged Type: Example Issue is related to specific example.
Projects
Development

Successfully merging this pull request may close these issues.

3 participants