-
Notifications
You must be signed in to change notification settings - Fork 7.7k
feat(rmt): improves RMT documentation #11992
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
Conversation
👋 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 ...
Review and merge process you can expect ...
|
There was a problem hiding this 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 adds comprehensive documentation for the RMT (Remote Control Transceiver) peripheral API in the Arduino-ESP32 framework. The documentation replaces a placeholder "work in progress" message with complete reference material covering all RMT functionality.
Key changes:
- Added detailed explanations of RMT peripheral capabilities and use cases (IR protocols, WS2812 LEDs, custom protocols)
- Documented all RMT API functions including initialization, transmission (blocking/async/looping), reception, and configuration
- Included memory block allocation details for different ESP32 SoC variants
- Added code examples and helper macro documentation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Clarify behavior of rmtTransmitCompleted in looping mode.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
docs/en/api/rmt.rst:1
- Corrected spelling of 'deom' to 'from'.
####################
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@pedrominatel - last PR for your final review. Thanks! |
Done. |
Description of Change
Improves the RMT documentation for the Arduino API
Test Scenarios
CI Only
Related links
N/A