-
Notifications
You must be signed in to change notification settings - Fork 7.7k
feat(serial_uart): adds Serial (UART) documentation #11993
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
base: master
Are you sure you want to change the base?
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 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: |
Copilot
AI
Nov 7, 2025
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.
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 :'.
| OnReceive Callback Example: | |
| OnReceive Callback Example : |
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