Skip to content

feat(wifi): Flesh out AP + STA and add menus for control/config #462

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
Jun 23, 2025

Conversation

finger563
Copy link
Contributor

Description

  • Add configuration / query methods to both AP and STA
  • Add wifi_ap_menu and wifi_sta_menu for easy configuration / control of WiFi AP/STA using CLI
  • Fix bug in event registration in both AP and STA
  • Update example to use menus (if compiled with CXX exceptions)
  • Update docs accordingly

Motivation and Context

Fleshes out AP and STA to be more useful, supporting easier configuration and better support for stored security usage.

How has this been tested?

Build and run wifi/example on QtPy ESP32s3

Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update
  • Hardware (schematic, board, system design) change
  • Software change

Checklist:

  • My change requires a change to the documentation.
  • I have added / updated the documentation related to this change via either README or WIKI

Software

  • I have added tests to cover my changes.
  • I have updated the .github/workflows/build.yml file to add my new test to the automated cloud build github action.
  • All new and existing tests passed.
  • My code follows the code style of this project.

@finger563 finger563 requested a review from Copilot June 22, 2025 21:51
@finger563 finger563 self-assigned this Jun 22, 2025
@finger563 finger563 added bug Something isn't working enhancement New feature or request wifi labels Jun 22, 2025
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 fleshes out the WiFi Station (STA) and Access Point (AP) functionality by introducing CLI menus for easier configuration and control, fixing an event registration bug, and updating documentation and examples accordingly. Key changes include:

  • Adding new header and documentation files for WiFi STA/AP menus.
  • Enhancing configuration loading in WifiSta and WifiAp modules.
  • Updating the CLI examples to incorporate the new menu interfaces.

Reviewed Changes

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

Show a summary per file
File Description
doc/en/wifi/wifi_sta.rst Added menu include for STA documentation
doc/en/wifi/wifi_ap.rst Added menu include for AP documentation
doc/Doxyfile Updated INPUT paths to include wifi_sta_menu and wifi_ap_menu.hpp
components/wifi/include/wifi_sta_menu.hpp New CLI menu interface for WiFi STA
components/wifi/include/wifi_ap_menu.hpp New CLI menu interface for WiFi AP
components/wifi/include/wifi_sta.hpp Updated event registration, configuration loading, and atomic usage
components/wifi/include/wifi_ap.hpp Added AP station list logic and new helper functions
components/wifi/example/main/wifi_example.cpp Updated examples to use menus and improved logging
components/wifi/CMakeLists.txt Updated dependency from esp_wifi to cli alongside base_component
components/wifi/idf_component.yml Added cli dependency entry
Comments suppressed due to low confidence (1)

components/wifi/include/wifi_ap.hpp:370

  • Before copying the SSID and password into the configuration structure, add a check to ensure that the provided strings do not exceed the buffer size available in wifi_config.ap.ssid and wifi_config.ap.password to avoid potential buffer overruns.
    wifi_config_t wifi_config;

Copy link

github-actions bot commented Jun 22, 2025

✅Static analysis result - no issues found! ✅

@finger563 finger563 merged commit 5f05cf7 into main Jun 23, 2025
84 checks passed
@finger563 finger563 deleted the feat/wifi-update branch June 23, 2025 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request wifi
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant