Skip to content

feat(uart): sets correct ESP32/S2 clock source for the example #11286

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 2 commits into from
Apr 23, 2025

Conversation

SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Apr 23, 2025

Description of Change

Rx Timeout example was not working correctly using ESP32 and ESP32-S2 due to default selection of REF_TICK as UART Clock Source. REF_TICK limits RX Timeout to 1.

This PR adds the necessary call to HardwareSerial::setClockSource() in order to make it work properly.

Tests scenarios

Tested using the example code of this PR.
ESP32 | ESP32-S2 | ESP32-C3 | ESP32-C6 | ESP32-S3 | ESP32-H2

Expect output (see the time it takes to read 10 bytes):

ets Jul 29 2019 12:21:46

rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
configsip: 0, SPIWP:0xee
clk_drv:0x00,q_drv:0x00,d_drv:0x00,cs0_drv:0x00,hd_drv:0x00,wp_drv:0x00
mode:DIO, clock div:1
load:0x3fff0030,len:4888
load:0x40078000,len:16516
load:0x40080400,len:4
load:0x40080404,len:3476
entry 0x400805b4
[     8][I][esp32-hal-psram.c:102] psramAddToHeap(): PSRAM added to the heap.


================================
Test Case #1
================================
Testing the time for receiving 10 bytes at 9600 baud, using RX Timeout = 50:
It has sent 10 bytes from Serial1 TX to Serial1 RX
It took 62 milliseconds to read 10 bytes
Received data: [0123456789]
========================
Finished!


================================
Test Case #2
================================
Testing the time for receiving 10 bytes at 9600 baud, using RX Timeout = 20:
It has sent 10 bytes from Serial1 TX to Serial1 RX
It took 31 milliseconds to read 10 bytes
Received data: [0123456789]
========================
Finished!


================================
Test Case #3
================================
Testing the time for receiving 10 bytes at 9600 baud, using RX Timeout = 10:
It has sent 10 bytes from Serial1 TX to Serial1 RX
It took 21 milliseconds to read 10 bytes
Received data: [0123456789]
========================
Finished!


================================
Test Case #4
================================
Testing the time for receiving 10 bytes at 9600 baud, using RX Timeout = 5:
It has sent 10 bytes from Serial1 TX to Serial1 RX
It took 16 milliseconds to read 10 bytes
Received data: [0123456789]
========================
Finished!


================================
Test Case #5
================================
Testing the time for receiving 10 bytes at 9600 baud, using RX Timeout = 1:
It has sent 10 bytes from Serial1 TX to Serial1 RX
It took 11 milliseconds to read 10 bytes
Received data: [0123456789]
========================
Finished!

Related links

None

Copy link
Contributor

github-actions bot commented Apr 23, 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 4b975f9

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
ESP32P4000.000.00000.000.00
ESP32S3000.000.00000.000.00
ESP32S20⚠️ +640.00⚠️ +0.02000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP320⚠️ +760.00⚠️ +0.02000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/ESP32/examples/Serial/RxTimeout_Demo0000⚠️ +640000000⚠️ +760

@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Apr 23, 2025
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Apr 23, 2025
@lucasssvaz
Copy link
Collaborator

Do you think this could be adapted as a test case in our UART CI test ?

@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 23, 2025
@me-no-dev me-no-dev merged commit 571c2f7 into master Apr 23, 2025
21 checks passed
@me-no-dev me-no-dev deleted the uart_clk_src_rx_timeout_example branch April 23, 2025 17:20
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
Projects
Development

Successfully merging this pull request may close these issues.

3 participants