Skip to content

Conversation

@SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Nov 7, 2025

Description of Change

Improves the RMT documentation for the Arduino API

Test Scenarios

CI Only

Related links

N/A

@SuGlider SuGlider added this to the 3.3.0 milestone Nov 7, 2025
@SuGlider SuGlider self-assigned this Nov 7, 2025
@SuGlider SuGlider added Type: Documentation Issue pertains to Documentation of Arduino ESP32 Area: Peripherals API Relates to peripheral's APIs. labels Nov 7, 2025
@SuGlider SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Nov 7, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 7, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "fix(rmt): rephasing":
    • summary looks too short

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 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.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- 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 941c207

@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Nov 7, 2025
@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Nov 7, 2025
@lucasssvaz lucasssvaz requested a review from Copilot November 7, 2025 11:50
Copy link
Contributor

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 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.

SuGlider and others added 4 commits November 10, 2025 08:35
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.
@SuGlider SuGlider requested a review from Copilot November 10, 2025 11:43
Copy link
Contributor

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

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.

@SuGlider
Copy link
Collaborator Author

@pedrominatel - last PR for your final review. Thanks!

@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Nov 10, 2025
@pedrominatel
Copy link
Member

@pedrominatel - last PR for your final review. Thanks!

Done.

@me-no-dev me-no-dev merged commit 333bfff into master Nov 10, 2025
8 checks passed
@me-no-dev me-no-dev deleted the docs/rmt_documentation branch November 10, 2025 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Peripherals API Relates to peripheral's APIs. Status: Pending Merge Pull Request is ready to be merged Type: Documentation Issue pertains to Documentation of Arduino ESP32

Projects

Development

Successfully merging this pull request may close these issues.

6 participants