Skip to content

feat(netif): Allow setting interface's routing priority #11617

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

Merged
merged 3 commits into from
Jul 21, 2025

Conversation

me-no-dev
Copy link
Member

@me-no-dev me-no-dev commented Jul 20, 2025

This pull request introduces enhancements to the NetworkInterface class in the libraries/Network module, focusing on improving route priority management and aligning with ESP-IDF version updates. The key changes include renaming and documenting the route_prio method, adding a new method to set route priority, and updating the class interface accordingly.

Enhancements to route priority management:

  • Renamed and documented route_prio method: The route_prio method was renamed to getRoutePrio for clarity, and detailed documentation was added to explain its purpose and the default priority values for different network interfaces. (NetworkInterface.cpp [1] NetworkInterface.h [2]

  • Added setRoutePrio method: A new setRoutePrio method was introduced (conditionally compiled for ESP-IDF versions 5.5.0 and above) to allow setting the route priority of a network interface programmatically. (NetworkInterface.cpp [1] NetworkInterface.h [2]

Copy link
Contributor

github-actions bot commented Jul 20, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello me-no-dev, 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 306dc46

Copy link
Contributor

github-actions bot commented Jul 20, 2025

Test Results

 76 files   76 suites   13m 11s ⏱️
 38 tests  38 ✅ 0 💤 0 ❌
241 runs  241 ✅ 0 💤 0 ❌

Results for commit 306dc46.

♻️ This comment has been updated with latest results.

Copy link
Contributor

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32C5000.000.00000.000.00
ESP32P4000.000.00000.000.00
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C5ESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/Ethernet/examples/ETH_W5500_Arduino_SPI----------------
libraries/Ethernet/examples/ETH_W5500_IDF_SPI----------------
libraries/Ethernet/examples/ETH_WIFI_BRIDGE----------------
libraries/NetworkClientSecure/examples/WiFiClientInsecure----------------
libraries/NetworkClientSecure/examples/WiFiClientShowPeerCredentials----------------
libraries/NetworkClientSecure/examples/WiFiClientTrustOnFirstUse----------------
libraries/PPP/examples/PPP_Basic----------------
libraries/PPP/examples/PPP_WIFI_BRIDGE----------------
libraries/WiFi/examples/SimpleWiFiServer----------------
libraries/WiFi/examples/WPS----------------
libraries/WiFi/examples/WiFiAccessPoint----------------
libraries/WiFi/examples/WiFiBlueToothSwitch----------------
libraries/WiFi/examples/WiFiClient----------------
libraries/WiFi/examples/WiFiClientBasic----------------
libraries/WiFi/examples/WiFiClientConnect----------------
libraries/WiFi/examples/WiFiClientEnterprise----------------
libraries/WiFi/examples/WiFiClientEvents----------------
libraries/WiFi/examples/WiFiClientStaticIP----------------
libraries/WiFi/examples/WiFiExtender----------------
libraries/WiFi/examples/WiFiIPv6----------------
libraries/WiFi/examples/WiFiMulti----------------
libraries/WiFi/examples/WiFiMultiAdvanced----------------
libraries/WiFi/examples/WiFiScan----------------
libraries/WiFi/examples/WiFiScanAsync----------------
libraries/WiFi/examples/WiFiScanDualAntenna----------------
libraries/WiFi/examples/WiFiScanTime----------------
libraries/WiFi/examples/WiFiSmartConfig----------------
libraries/WiFi/examples/WiFiTelnetToSerial----------------
libraries/WiFi/examples/WiFiUDPClient----------------
libraries/Ethernet/examples/ETH_TLK110----------------
libraries/Ethernet/examples/ETH_LAN8720----------------
libraries/NetworkClientSecure/examples/WiFiClientSecureEnterprise----------------
libraries/NetworkClientSecure/examples/WiFiClientSecureProtocolUpgrade----------------
libraries/WiFi/examples/FTM/FTM_Initiator----------------
libraries/WiFi/examples/FTM/FTM_Responder----------------

@me-no-dev me-no-dev added the Status: Review needed Issue or PR is awaiting review label Jul 20, 2025
@lucasssvaz lucasssvaz requested a review from Copilot July 21, 2025 11:51
Copy link
Contributor

@Copilot 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 enhances the NetworkInterface class to provide better route priority management capabilities. The changes rename an existing method for clarity, add new functionality to set route priorities programmatically, and improve debugging output.

  • Renamed route_prio() to getRoutePrio() with comprehensive documentation explaining priority values
  • Added setRoutePrio() method for ESP-IDF 5.5.0+ to allow programmatic priority setting
  • Enhanced debug output to display route priority information

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
NetworkInterface.h Updates method declarations with renamed getter and new conditional setter
NetworkInterface.cpp Implements renamed method with documentation, adds new setter method, and enhances debug output


bytes += out.print(" PRIO: ");
bytes += out.print(getRoutePrio());
bytes += out.println("");
Copy link
Preview

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

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

[nitpick] Using out.println("") to print a newline is less clear than using out.println() without arguments, which serves the same purpose.

Suggested change
bytes += out.println("");
bytes += out.println();

Copilot uses AI. Check for mistakes.

@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 Jul 21, 2025
@me-no-dev me-no-dev merged commit 4a3c6d7 into release/v3.3.x Jul 21, 2025
92 checks passed
@me-no-dev me-no-dev deleted the feature/netif_set_prio branch July 21, 2025 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants