-
Notifications
You must be signed in to change notification settings - Fork 7.8k
feat(network): Adds Network Library documentation #11999
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 ...
|
|
You can add the new |
Added documentation for the isOnline() function to check network status.
|
@P-R-O-C-H-Y done |
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 API documentation for the Network library on ESP32 devices. The documentation provides a unified guide for managing multiple network interfaces including Wi-Fi (Station and Access Point), Ethernet, and PPP connections through a centralized NetworkManager.
Key Changes
- Introduces complete Network API documentation covering architecture, interfaces, events, and communication classes
- Documents the NetworkManager as central coordinator with unified interface management
- Provides extensive code examples for Wi-Fi, Ethernet, PPP, and multi-interface scenarios
💡 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>
Description of Change
Adds documentation for Network Library (Wi-Fi, Ethernet and PPP interfaces, manager and events).
Test Scenarios
CI Only
Related links
None