Skip to content

Conversation

@SuGlider
Copy link
Collaborator

Description of Change

Adds documentation for Network Library (Wi-Fi, Ethernet and PPP interfaces, manager and events).

Test Scenarios

CI Only

Related links

None

@SuGliderSuGlider added this to the 3.3.0 milestone Nov 7, 2025
@SuGliderSuGlider self-assigned this Nov 7, 2025
@SuGliderSuGlider added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Nov 7, 2025
@github-actions
Copy link
Contributor

github-actionsbot commented Nov 7, 2025

Messages
📖This PR seems to be quite large (total lines of code: 1093), you might consider splitting it into smaller PRs

👋 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 322ab9b

@SuGliderSuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project RoadmapNov 7, 2025
@SuGliderSuGlider added the Status: Review needed Issue or PR is awaiting review label Nov 7, 2025
@SuGliderSuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project RoadmapNov 7, 2025
@P-R-O-C-H-Y
Copy link
Member

P-R-O-C-H-Y commented Nov 7, 2025

You can add the new Network.isOnline() as it will be added in the PR #12000

Added documentation for the isOnline() function to check network status.
@me-no-dev
Copy link
Member

@P-R-O-C-H-Y done

Copy link
Contributor

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

@me-no-devme-no-dev 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
@me-no-devme-no-dev merged commit 9cb8e22 into masterNov 10, 2025
8 checks passed
@me-no-devme-no-dev deleted the docs/network_lib_documentation branch November 10, 2025 12:08
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status: Pending MergePull Request is ready to be mergedType: DocumentationIssue pertains to Documentation of Arduino ESP32

Projects

Development

Successfully merging this pull request may close these issues.

5 participants

@SuGlider@P-R-O-C-H-Y@me-no-dev@pedrominatel@lucasssvaz