Skip to content

feat(ap): Add support for DHCP Captive Portal (opt 114) #11412

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 4 commits into from
Jun 4, 2025

Conversation

me-no-dev
Copy link
Member

@me-no-dev me-no-dev commented May 30, 2025

This pull request introduces functionality to enable a DHCP-based captive portal for WiFi access points, along with updates to simplify the setup process in the Captive Portal example. The most significant changes include adding the new enableDhcpCaptivePortal method to the APClass, modifying the example code to utilize this new feature, and updating the WiFiAP.h header file to declare the new method.

Enhancements to WiFi Access Point functionality:

  • Added enableDhcpCaptivePortal method to APClass: This method enables a DHCP-based captive portal by configuring the DHCP server to redirect clients to a specific captive portal URI. It includes error handling for stopping and starting the DHCP server and checks if the access point is started before enabling the feature.
  • Declared enableDhcpCaptivePortal in WiFiAP.h: The new method is added to the APClass interface, making it accessible for users of the library.

Updates to the Captive Portal example:

  • Simplified WiFi setup in CaptivePortal.ino: Replaced the manual configuration of the access point with the new WiFi.AP.create and WiFi.AP.enableDhcpCaptivePortal methods, streamlining the setup process for users.

Closes #11399

Copy link
Contributor

github-actions bot commented May 30, 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 711ca88

Copy link
Contributor

github-actions bot commented May 30, 2025

Test Results

 76 files   76 suites   12m 45s ⏱️
 38 tests  38 ✅ 0 💤 0 ❌
241 runs  241 ✅ 0 💤 0 ❌

Results for commit 711ca88.

♻️ This comment has been updated with latest results.

@me-no-dev me-no-dev added the Status: Review needed Issue or PR is awaiting review label May 30, 2025
@me-no-dev me-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 Jun 4, 2025
@pre-commit-ci-lite pre-commit-ci-lite bot requested a review from a team as a code owner June 4, 2025 13:28
@me-no-dev me-no-dev merged commit a2880a4 into master Jun 4, 2025
56 checks passed
@me-no-dev me-no-dev deleted the feature/dhcp_captive_portal branch June 4, 2025 14:39
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.

DHCP option 114 for captive portal
2 participants