Skip to content

Conversation

@SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Nov 7, 2025

Description of Change

Adds Hardware Serial documentation, mainly for the additional API on top of the mainstream 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 the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Nov 7, 2025
@SuGlider SuGlider added the Peripheral: UART Related to the UART peripheral or its functionality. label 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

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 90ab93e

@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Nov 7, 2025
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label 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 Serial (UART) API in the ESP32 Arduino Core. The documentation covers all aspects of UART communication including initialization, data transmission/reception, configuration options, hardware flow control, RS485 support, and event callbacks.

Key changes:

  • Complete API reference for the HardwareSerial class with all methods documented
  • Detailed explanation of UART availability across different ESP32 SoCs (including HP and LP UARTs)
  • Configuration constants and examples for various use cases (baud rate detection, onReceive callbacks, RS485)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.. literalinclude:: ../../../libraries/ESP32/examples/Serial/BaudRateDetect_Demo/BaudRateDetect_Demo.ino
:language: arduino

OnReceive Callback Example:
Copy link

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

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

Section title is missing a space before the colon. For consistency with other section titles in this document (e.g., 'RS485 Communication Example:' on line 664), there should be a space before the colon. Change to 'OnReceive Callback Example :'.

Suggested change
OnReceive Callback Example:
OnReceive Callback Example :

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Peripheral: UART Related to the UART peripheral or its functionality. Status: Review needed Issue or PR is awaiting review Type: Documentation Issue pertains to Documentation of Arduino ESP32

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

4 participants