Skip to content

refactor(rmt): refactored RMT loopback example #11221

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 9, 2025

Conversation

SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Apr 6, 2025

Description of Change

The way RMT loopback example was done, it had a sync problem that caused the result to do not match.
Low level signal was sent first and then the high level, therefore, it would only detect the second signal (high) after a delay in nanoseconds. This delay would cause the received signal to be shifted by one RMT symbol.

Output of the original example:

Got 30 RMT symbols
000e8001=8001000e 000d8001=8002000d 000b8002=8003000c 000a8004=8004000b 
00098005=8005000a 00088006=80060009 00078007=80070008 00068008=80080007 

With this refactoring/fix, RMT symbols start with High Level and the output matches the received RMT symbols.
This PR makes the example easier for understanding as well as the RMT symbol will better match.

Got 32 RMT symbols
0001800e=0001800e 0002800d=0002800d 0003800c=0003800c 0004800b=0004800b 
0005800a=0005800a 00068009=00068009 00078008=00078008 00088007=00088007 

Tests scenarios

Tested with ESP32, ESP32-C3 and ESP32-S3 using the provided example.

Related links

Related to #11200

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

github-actions bot commented Apr 6, 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 940ecfb

@SuGlider SuGlider moved this from Todo to In Review in Arduino ESP32 Core Project Roadmap Apr 6, 2025
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Apr 6, 2025
@SuGlider SuGlider requested a review from Copilot April 6, 2025 22:42
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.

Copilot wasn't able to review any files in this pull request.

Files not reviewed (1)
  • libraries/ESP32/examples/RMT/RMTLoopback/RMTLoopback.ino: Language not supported

Copy link
Contributor

github-actions bot commented Apr 6, 2025

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
ESP32P40⚠️ +5580.00⚠️ +0.16000.000.00
ESP32S30⚠️ +4360.00⚠️ +0.13000.000.00
ESP32S20⚠️ +3600.00⚠️ +0.13000.000.00
ESP32C30⚠️ +5360.00⚠️ +0.18000.000.00
ESP32C60⚠️ +5560.00⚠️ +0.21000.000.00
ESP32H20⚠️ +5860.00⚠️ +0.19000.000.00
ESP320⚠️ +3800.00⚠️ +0.12000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/ESP32/examples/RMT/RMTLoopback⚠️ +5580⚠️ +4360⚠️ +3600⚠️ +5360⚠️ +5560⚠️ +5860⚠️ +3800

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

@lucasssvaz lucasssvaz changed the title feat(rmt): refactored RMT loopback example refactor(rmt): refactored RMT loopback example Apr 8, 2025
@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 9, 2025
@me-no-dev me-no-dev merged commit 2647cbb into master Apr 9, 2025
21 checks passed
@me-no-dev me-no-dev deleted the rmt_loopback_refactoring branch April 9, 2025 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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